|
| 1 | +--- |
| 2 | +title: UID Verify Chrome Extension |
| 3 | +description: How to use the UID Verify Chrome extension to debug and inspect UID2 integrations on any web page. |
| 4 | +hide_table_of_contents: false |
| 5 | +sidebar_position: 03 |
| 6 | +displayed_sidebar: docs |
| 7 | +--- |
| 8 | + |
| 9 | +import Link from '@docusaurus/Link'; |
| 10 | + |
| 11 | +# UID Verify Chrome Extension |
| 12 | + |
| 13 | +UID Verify is a browser extension for debugging UID2 integrations. It inspects the UID2 implementation on the current page in real time, surfacing UID2 SDK configuration, identity storage, event history, and errors. |
| 14 | + |
| 15 | +The extension supports integrations using the <Link href="../sdks/sdk-ref-javascript">SDK for JavaScript</Link>, <Link href="../guides/integration-prebid">Prebid.js</Link>, and <Link href="../guides/integration-google-ss">Google Secure Signals</Link>. |
| 16 | + |
| 17 | +## Overview |
| 18 | + |
| 19 | +When integrating UID2, it can be difficult to tell whether the UID2 SDK is initializing correctly, whether tokens are valid, or where in the lifecycle an error is occurring. UID Verify helps debug this by reading the UID2 SDK configuration, identity data, and event stream directly from the page and presenting it in a structured, searchable interface. |
| 20 | + |
| 21 | +The extension detects whether a page uses the UID2 SDK directly, Prebid.js, or Google Secure Signals (or a combination), and displays the relevant information for each integration type. |
| 22 | + |
| 23 | +## Prerequisites |
| 24 | + |
| 25 | +UID Verify requires: |
| 26 | + |
| 27 | +- **Google Chrome** browser |
| 28 | +- A web page that has a UID2 integration — one of the following must be present on the page: |
| 29 | + - The <Link href="../sdks/sdk-ref-javascript">SDK for JavaScript</Link> is loaded on the page (accessible via `window.__uid2`) |
| 30 | + - <Link href="../guides/integration-prebid">Prebid.js</Link> with a UID2 user ID module configured |
| 31 | + - <Link href="https://developers.google.com/publisher-tag/guides/secure-signals">Google Publisher Tags (GPT)</Link> with a UID2 Secure Signals provider registered |
| 32 | + |
| 33 | +If more than one integration type is detected, you can switch between them using the integration type tabs at the top of the popup. |
| 34 | + |
| 35 | +:::note |
| 36 | +Server-side integrations are not currently supported. UID Verify works by reading client-side signals such as browser storage and UID2 SDK globals, which are not present in a server-side integration. |
| 37 | +::: |
| 38 | + |
| 39 | +## Installing the Extension |
| 40 | + |
| 41 | +To install UID Verify from the Chrome Web Store, follow these steps: |
| 42 | + |
| 43 | +1. Go to the [UID Verify listing](https://chromewebstore.google.com/detail/uid-verify/cfpjjmdagnkmmolcddnoagffeoekkmle) in the Chrome Web Store. |
| 44 | +2. Click **Add to Chrome**. |
| 45 | +3. When prompted, click **Add extension**. |
| 46 | +4. Pin the extension to your toolbar for easy access: click the Extensions icon in your browser, then click the pin icon next to UID Verify. |
| 47 | + |
| 48 | +## Using UID Verify |
| 49 | + |
| 50 | +Once installed, follow these steps to inspect a UID2 integration: |
| 51 | + |
| 52 | +1. Navigate to a web page that has a UID2 integration. |
| 53 | +2. Click the **UID Verify** icon in your browser toolbar to open the extension popup. |
| 54 | +3. The extension detects the integration type on the page and displays the appropriate tabs. |
| 55 | + |
| 56 | +:::note |
| 57 | +UID Verify supports both UID2 and EUID. A page should use either UID2 (for North America and parts of Asia) or EUID (for Europe and other GDPR-applicable regions), not both. If both are detected on the same page, the extension displays an error. |
| 58 | +::: |
| 59 | + |
| 60 | +## Interpreting Results |
| 61 | + |
| 62 | +The following sections describe the information available in each tab of the UID Verify popup. The content of each tab varies depending on the integration type detected. |
| 63 | + |
| 64 | +### Config Tab |
| 65 | + |
| 66 | +The **Config** tab provides a snapshot of the integration's current state, including status banners for successful token generation, errors, opt-out identities, and other configuration states. The information displayed depends on the integration type, as shown in the following sections. |
| 67 | + |
| 68 | +**UID2 SDK integrations:** |
| 69 | + |
| 70 | +- UID2 SDK version |
| 71 | +- UID2 SDK initialization options |
| 72 | +- The current identity object, including: |
| 73 | + - Advertising token |
| 74 | + - Refresh token |
| 75 | + - Token and refresh expiration timestamps |
| 76 | +- The result of `getAdvertisingToken()` |
| 77 | +- The result of `isLoginRequired()` |
| 78 | + |
| 79 | +**Prebid.js integrations:** |
| 80 | + |
| 81 | +- The current UID2 token from `window.pbjs.getUserIds().uid2` |
| 82 | +- The Prebid.js configuration parameters from `window.pbjs.getConfig().userSync.userIds` (for example, `uid2ApiBase`, `subscriptionId`, `serverPublicKey`) |
| 83 | + |
| 84 | +**Google Secure Signals integrations:** |
| 85 | + |
| 86 | +- Whether Google Publisher Tags is detected |
| 87 | +- Whether the UID2 provider ID is registered |
| 88 | +- Whether `getAdvertisingTokenAsync` is available |
| 89 | +- Whether a collector function is registered (the function that passes the UID2 token as an encrypted signal to Google Ad Manager) |
| 90 | + |
| 91 | +### Storage Tab |
| 92 | + |
| 93 | +The **Storage** tab shows the raw identity data stored in the browser for the current integration. |
| 94 | + |
| 95 | +**UID2 SDK and Prebid.js integrations** |
| 96 | + |
| 97 | +SDK and Prebid.js integrations include the fields shown in the following table. |
| 98 | + |
| 99 | +| Field | Description | |
| 100 | +|---|---| |
| 101 | +| Storage Type | Indicates whether the identity is stored in a cookie or `localStorage`. | |
| 102 | +| Storage Key | The name of the cookie or `localStorage` key. For UID2 SDK integrations: `__uid_2` or `UID2-sdk-identity`. For Prebid.js integrations: `__uid2_advertising_token`. | |
| 103 | +| Stored Value | The raw identity JSON, including `advertising_token`, `refresh_token`, `identity_expires`, `refresh_expires`, `refresh_from`, and `refresh_response_key`. | |
| 104 | +| Valid Identity | Indicates whether the stored identity is currently valid — that is, the advertising token has not expired and the user has not opted out. | |
| 105 | +| Optout Identity | Indicates whether the identity reflects an opted-out user. | |
| 106 | + |
| 107 | +For Google Secure Signals integrations, the tab shows the status of the secure signal and the current UID2 advertising token. If no signal has been generated yet, it indicates that neither a cached signal nor a UID2 SDK advertising token is available. When the collector function has run successfully, the extension displays a "Secure signal is cached" status message and shows the cached value stored under `_GESPSK-uidapi.com`. The cached signal is in the format `[providerId, advertisingToken, expiryTimestamp]`. The current UID2 advertising token is also displayed separately. |
| 108 | + |
| 109 | +### Callbacks Tab |
| 110 | + |
| 111 | +The **Callbacks** tab is available for UID2 SDK integrations only. It displays the source code of all callback functions registered with the UID2 SDK, with syntax highlighting. This is useful for confirming that the correct callbacks are registered and identifying where events are being handled in the page code. |
| 112 | + |
| 113 | +### Event History Tab |
| 114 | + |
| 115 | +The **Event History** tab shows a searchable, real-time log of UID2 SDK events as they occur on the page. It includes the columns shown in the following table. |
| 116 | + |
| 117 | +| Column | Description | |
| 118 | +|---|---| |
| 119 | +| Date | The date the event was recorded. | |
| 120 | +| Time | The time the event was recorded. | |
| 121 | +| Event | The event type (for example, `SdkLoaded`, `InitCompleted`, `TokenUpdated`). | |
| 122 | +| Advertising Token | The advertising token associated with the event, if present. | |
| 123 | + |
| 124 | +Use the search bar to filter by event type or token value. |
| 125 | + |
| 126 | +This tab also includes an **Error Log** when errors are detected. The extension captures errors from several sources, including: |
| 127 | + |
| 128 | +- Failed network requests to the UID2 operator |
| 129 | +- Failed resource loads (such as the UID2 SDK script) |
| 130 | +- `console.error` calls from UID2 SDK code |
| 131 | +- Errors thrown by UID2 SDK methods |
| 132 | + |
| 133 | +For known error patterns, the extension displays contextual troubleshooting guidance alongside the error. |
0 commit comments