Skip to content

UID2-7375 Reference UID Verify from publisher web integration guides#1037

Open
sunnywu wants to merge 2 commits into
mainfrom
syw-UID2-7375-uid-verify-publisher-guides
Open

UID2-7375 Reference UID Verify from publisher web integration guides#1037
sunnywu wants to merge 2 commits into
mainfrom
syw-UID2-7375-uid-verify-publisher-guides

Conversation

@sunnywu

@sunnywu sunnywu commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

UID Verify (the Chrome debugging extension) was previously documented only on its standalone reference page (ref-info/ref-uid-verify). It was not referenced from the publisher integration guides.

This PR adds a shared snippet (docs/snippets/_snpt-uid-verify-debug-tip.mdx) with a :::tip pointing to the UID Verify reference page, framed as a debugging/inspection aid (not a token-generation integration option), and imports it into:

Hub pages:

  • docs/snippets/_snpt-publisher-implementation-resources.mdx — renders on Publisher integration resources and the Publishers overview
  • docs/guides/integration-options-publisher-web.md — new "Debug your integration" section

Individual web guides (the three integration types UID Verify supports):

  • integration-javascript-client-side.md
  • integration-javascript-client-server.md
  • integration-prebid-client-side.md
  • integration-prebid-client-server.md
  • integration-google-ss.md

The tip text lives in a single snippet so it stays consistent across all pages. Additions only; no existing content changed. Pure server-side guide is excluded (nothing client-side for UID Verify to inspect). Japanese i18n mirror left for the docs team to translate separately.

Jira

UID2-7375

Related

EUID-docs companion PR: European-Unified-ID/EUID-docs#425

🤖 Generated with Claude Code

sunnywu and others added 2 commits June 26, 2026 11:01
Add tips pointing to the UID Verify Chrome extension reference page from
the publisher web integration resources and the individual supported web
guides, so it's discoverable beyond its standalone ref page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Extract the repeated tip into _snpt-uid-verify-debug-tip.mdx and import it
into all seven consuming pages instead of duplicating the callout text.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@genwhittTTD genwhittTTD left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments. The tip copy itself is great but I'm suggesting different placement -- a separate section, below the "Integrating with single sign-on (SSO)" section which is in many docs -- no Tip tag, don't include it in the main intro and overview pages. Those are my suggestions.

To use the UID2 Google Ad Manager secure signals integration, if you are using an SDK you must have your UID2 integration already set up. This does not apply if you are using server-side integration. For a summary of all the integration options available, see [Integration guides: Summary](summary-guides.md).
:::

<SnptUidVerifyDebugTip />

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

visual issue here -- a Note immediately followed by a Tip, better not to do.

Suggest have the content here without the Tip tag?

Another possibility is to add it as an item in the Troubleshooting article (https://unifiedid.com/docs/guides/integration-google-ss#troubleshooting).

Or we could change the preceding Note into a prerequisites section.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change note to prerequisites is better - Adding a Troubleshooting section at the bottom may be overlooked.

- Automatic refreshing of UID2 tokens
- Automatic storage of UID2 tokens in the browser

<SnptUidVerifyDebugTip />

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't love the placement here -- between the SDK features and the summary of steps to implement, which I think flow well one to the other. Perhaps it could go after the summary of steps? But keep it here if you prefer.

If you are using Google Ad Manager and want to use the secure signals feature, first follow the steps in this guide and then follow the additional steps in the [Google Ad Manager Secure Signals integration guide](integration-google-ss.md).
:::

<SnptUidVerifyDebugTip />

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, here, it's added in right below another admonition. We avoid consecutive admonitions if possible. And in this case there is even another one before that, with only one line of copy between. So we have Tip, one line, Note, then this new Tip.

I had an idea. What about having a separate section directly after the "Integrating with single sign-on (SSO)" section in applicable guides, and calling it "Using UID Verify Chrome Extension"? That would mean consistent placement in all applicable docs.

As long as you generate the token and keep it refreshed, you can also use other options for passing the UID2 token into the bidstream.
:::

## Debug your integration

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here it's a separate section, which I think is good.

How about we call it "Using UID Verify Chrome Extension"? Or, "Inspecting with UID Verify"? Or some other name you're comfortable with for the instances in the other guides so that in all instances it could be a separate section. Yours is better, actually, because it says what it does. But right at the top of the other docs is too soon to introduce debugging info.

Whatever you settle on for the title, remove the "tip" tag. We should not have a whole section with only a tip in it and no other copy.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeh i think "Inspecting with UID Verify Chrome Extension" is good.

| Server-side integration | [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md) | A guide for publishers who do not use the [SDK for JavaScript](../sdks/sdk-ref-javascript.md). |
| Publisher/SSP integration with GAM | [Google Ad Manager Secure Signals integration guide](../guides/integration-google-ss.md) | A guide covering the additional steps needed for publishers using UID2 with the Google Ad Manager Secure Signals feature (previously known as Encrypted Signals for Publishers, ESP). |

<SnptUidVerifyDebugTip />

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_snpt-publisher-implementation-resources is used in a couple of overview-type docs including the main Publishers overview/intro page. I think that it's better not on those pages. It's debug info. Better to just have it as a heading on the pages for the specific docs is my though, with the separate heading as suggested in earlier comments (and no Tip tag).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants