Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sunnywu wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fa719f
UID2-7375 Reference UID Verify from publisher web integration guides
sunnywu Jun 26, 2026
87a6e36
UID2-7375 Template the UID Verify tip into a shared snippet
sunnywu Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/guides/integration-google-ss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ displayed_sidebar: docs
import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptUidVerifyDebugTip from '../snippets/_snpt-uid-verify-debug-tip.mdx';

# Google Ad Manager Secure Signals integration guide

Expand All @@ -20,6 +21,8 @@ This guide covers integration steps for publishers using UID2 with the Google Ad
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 />

@genwhittTTD genwhittTTD Jun 29, 2026

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.

@sunnywu sunnywu Jun 29, 2026

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.


## Overview

Google secure signals is a way for publishers to pass "encrypted" user IDs to bidders that are approved by Google, via [Google Ad Manager](https://admanager.google.com/home/) and the [Google Ad Manager Ad Exchange (AdX)](https://support.google.com/admanager/answer/6321605?hl=en). The framework is an optional part of the <a href="https://developers.google.com/publisher-tag/guides/get-started">Google Publisher Tag (GPT)</a> library commonly used by publishers.
Expand Down
3 changes: 3 additions & 0 deletions docs/guides/integration-javascript-client-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptExampleClientServerSendUid2ToSdk from '../snippets/_snpt-example-client-server-send-uid2-to-sdk.mdx';
import SnptUidVerifyDebugTip from '../snippets/_snpt-uid-verify-debug-tip.mdx';

# Client-server integration guide for JavaScript

Expand Down Expand Up @@ -43,6 +44,8 @@ For integration scenarios for publishers that do not use the SDK for JavaScript,
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 />

@genwhittTTD genwhittTTD Jun 29, 2026

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.


## Integrating with single sign-on (SSO)

<SnptIntegratingWithSSO />
Expand Down
3 changes: 3 additions & 0 deletions docs/guides/integration-javascript-client-side.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptUidVerifyDebugTip from '../snippets/_snpt-uid-verify-debug-tip.mdx';

# Client-side integration guide for JavaScript

Expand All @@ -37,6 +38,8 @@ UID2 provides an SDK for JavaScript (see [SDK for JavaScript reference guide](..
- Automatic refreshing of UID2 tokens
- Automatic storage of UID2 tokens in the browser

<SnptUidVerifyDebugTip />

@genwhittTTD genwhittTTD Jun 29, 2026

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.


To implement, you'll need to complete the following steps:

1. [Complete UID2 account setup and configure account](#complete-uid2-account-setup-and-configure-account)
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-options-publisher-web.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ displayed_sidebar: sidebarPublishers

import Link from '@docusaurus/Link';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptUidVerifyDebugTip from '../snippets/_snpt-uid-verify-debug-tip.mdx';

# Publisher web integration overview

Expand Down Expand Up @@ -138,3 +139,7 @@ The following table shows integration options that support passing UID2 token in
:::note
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

@genwhittTTD genwhittTTD Jun 29, 2026

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.

@sunnywu sunnywu Jun 29, 2026

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.


<SnptUidVerifyDebugTip />
3 changes: 3 additions & 0 deletions docs/guides/integration-prebid-client-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx';
import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx';
import SnptUidVerifyDebugTip from '../snippets/_snpt-uid-verify-debug-tip.mdx';

# Client-server integration guide for Prebid.js

Expand All @@ -25,6 +26,8 @@ To integrate with UID2 using Prebid.js, you'll need to:
- Make changes to the HTML and JavaScript on your site.
- Make server-side changes for token generation (and, optionally, <a href="../ref-info/glossary-uid#gl-token-refresh">token refresh</a>).

<SnptUidVerifyDebugTip />

## Prebid.js version

This implementation requires Prebid.js version 7.53.0 or later. For version information, see [https://github.com/prebid/Prebid.js/releases](https://github.com/prebid/Prebid.js/releases).
Expand Down
3 changes: 3 additions & 0 deletions docs/guides/integration-prebid-client-side.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,16 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx';
import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx';
import SnptUidVerifyDebugTip from '../snippets/_snpt-uid-verify-debug-tip.mdx';

# Client-side integration guide for Prebid.js

This guide is for publishers who have access to <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (email address or phone number) on the client side and want to integrate with UID2 and generate <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> (advertising tokens) to be passed by Prebid.js in the RTB <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link>.

To integrate with UID2 using Prebid.js, you'll need to make changes to the HTML and JavaScript on your site. No server-side work is required if you follow this guide.

<SnptUidVerifyDebugTip />

## Prebid.js version

This implementation requires Prebid.js version 8.21.0 or later. For version information, see [https://github.com/prebid/Prebid.js/releases](https://github.com/prebid/Prebid.js/releases).
Expand Down
3 changes: 3 additions & 0 deletions docs/snippets/_snpt-publisher-implementation-resources.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import Link from '@docusaurus/Link';
import SnptUidVerifyDebugTip from './_snpt-uid-verify-debug-tip.mdx';

The following resources are available for publishers to implement UID2:

Expand Down Expand Up @@ -27,6 +28,8 @@ For a detailed summary of web integration options, see [Publisher web integratio
| 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 />

@genwhittTTD genwhittTTD Jun 29, 2026

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).

@sunnywu sunnywu Jun 29, 2026

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


### Mobile integrations

The following resources are available for publisher integrations supporting Android or iOS devices.
Expand Down
3 changes: 3 additions & 0 deletions docs/snippets/_snpt-uid-verify-debug-tip.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:::tip
You can use the [UID Verify Chrome extension](../ref-info/ref-uid-verify.md) to inspect and debug your UID2 web integration directly in Chrome. UID Verify supports the SDK for JavaScript, Prebid.js, and Google Secure Signals.
:::