UID2 Integration Guides: Summary
The following guides provide integration instructions based on the needs and requirements of your organization and its primary role as a publisher, DSP, or data provider/advertiser. As a UID2 participant, you can also integrate via Enterprise Partners that enable engaging with an Open Operator service and hosting of a Private Operator service.
Integrations fall into these categories:
- Publisher Integrations
- Advertiser/Data Provider Integrations
- DSP Integrations
- Private Operator Service Integrations
Publisher Integrations
Publisher integrations fall into the following main categories:
- Web Integrations
- Mobile Integrations
- CTV Integrations
- Prebid Integrations
- Google Ad Manager Integrations
Web Integrations
The following documentation resources are available for publisher web integrations.
tip
For a detailed summary of web integration options, see Publisher Web Integration Overview.
| Integration Guide | Content Description |
|---|---|
| UID2 Integration Overview for Prebid | An overview of options for publishers who want to integrate with UID2 and generate UID2 tokens (advertising tokens) to be passed by Prebid.js and the Prebid Mobile SDK in the RTB bidstream. |
| UID2 Client-Side Integration Guide for Prebid.js | An integration guide for publishers who want to integrate with UID2 and want Prebid.js to manage token generation and automatic token refresh as well as passing the tokens into the RTB bidstream. This guide is for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach. |
| UID2 Client-Server Integration Guide for Prebid.js | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid.js in the RTB bidstream. This guide is for publishers who are using a Private Operator or who want to generate tokens server-side. |
| UID2 Integration Overview for JavaScript | An overview of options for publishers who want to integrate with UID2 using the JavaScript SDK. |
| Client-Side Integration Guide for JavaScript | A guide for publishers who want to integrate with UID2 using only client-side JavaScript changes, which is the easiest implementation approach. The SDK for JavaScript manages token generation and token refresh automatically. |
| Client-Server Integration Guide for JavaScript | This integration guide for publishers covers standard web integration scenarios that use the SDK for JavaScript and requires the token to be generated on the server side and passed to the publishers' web pages. |
| Publisher Integration Guide, Server-Side | This integration guide is for publishers that do not use the SDK for JavaScript. |
| Google Ad Manager Secure Signals Integration Guide | This integration guide covers the additional steps needed for publishers using UID2 with the Google Ad Manager Secure Signals feature (previously known as Encrypted Signals for Publishers, ESP). |
Mobile Integrations
The following documentation resources are available for publishers integrating with Android or iOS devices.
| Integration Guide | Content Description |
|---|---|
| Mobile Integration Overview for Android and iOS | An overview of options for mobile app publishers who want to integrate with UID2 using the SDK for Android or the SDK for iOS. |
| Client-Side Integration Guide for Mobile | An integration guide for mobile app publishers who want to integrate with UID2 with changes only within the mobile app (no server-side changes). |
| Client-Server Integration Guide for Mobile | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:
|
| Server-Side Integration Guide for Mobile | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. |
CTV Integrations
The following documentation resources are available for publisher integrations supporting CTV.
| Integration Guide | Content Description |
|---|---|
| CTV Integration Guide | A summary of CTV integration options, with links to additional information and instructions. |
Prebid Integrations
The following resources are available for publishers integrating with Prebid.
| Integration Guide | Content Description |
|---|---|
| UID2 Integration Overview for Prebid | An overview of options for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js or the Prebid Mobile SDK in the RTB bidstream. |
| UID2 Client-Side Integration Guide for Prebid.js | An integration guide for publishers who want to integrate with UID2 and want Prebid.js to manage token generation and automatic token refresh as well as passing the tokens into the RTB bidstream. This guide is for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach. |
| UID2 Client-Server Integration Guide for Prebid.js | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid.js in the RTB bidstream. This guide is for publishers who are using a Private Operator or who want to generate tokens server-side. |
| UID2 Mobile Integration for Prebid.js | A summary of information resources for UID2 integration with Prebid.js on mobile devices. |
Google Ad Manager Integrations
The following resources are available for publishers integrating with Google Ad Manager.
| Integration Guide | Content Description |
|---|---|
| Google Ad Manager Secure Signals Integration Guide | This integration guide covers the additional steps needed for publishers using UID2 with the Google Ad Manager Secure Signals feature (previously known as Encrypted Signals for Publishers, ESP). |
| UID2 GMA Plugin for Android Integration Guide | The UID2 Google Mobile Ads (GMA) Plugin for Android enables publishers that use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from Android apps. |
| UID2 GMA Plugin for iOS Integration Guide | The UID2 Google Mobile Ads (GMA) Plugin for iOS enables publishers that use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from iOS apps. |
| UID2 IMA Plugin for Android Integration Guide | The UID2 Interactive Media Ads (IMA) Plugin for Android enables publishers that use the Google IMA SDK for Android to send UID2 tokens as secure signals in ad requests from Android apps. |
| UID2 IMA Plugin for iOS Integration Guide | The UID2 Interactive Media Ads (IMA) Plugin for iOS enables publishers that use the Google IMA SDK for iOS to send UID2 tokens as secure signals in ad requests from iOS apps. |
Advertiser/Data Provider Integrations
The following documentation resources are available for advertisers and data providers integrating with UID2.
| Integration Guide | Content Description |
|---|---|
| Advertiser/Data Provider Overview | This guide provides an overview of integration options for organizations that collect user data and push it to other UID2 participants. |
| Snowflake Integration Guide | Instructions for generating UID2s from emails within Snowflake. |
| AWS Entity Resolution Integration Guide | Instructions for integrating with the UID2 framework using AWS Entity Resolution. |
| Advertiser/Data Provider Integration to HTTP Endpoints | This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution. |
| Client-Side Integration Guide for JavaScript | A guide for advertisers and data providers who want to use this SDK for adding a UID2 token to their tracking pixels. |
DSP Integrations
The following documentation resources are available for DSPs integrating with UID2.
| Integration Guide | Content Description |
|---|---|
| DSP Integration Guide | This integration guide for DSPs covers handling UID2s for bidding and honoring user opt-outs. |
| DSP Direct Integration Instructions | Instructions for DSPs who prefer to integrate without using one of the UID2 SDKs. |
Private Operator Service Integrations
The following resources are available for Private Operator integrations.
| Integration Guide | Content Description |
|---|---|
| UID2 Private Operator for AWS | Instructions for setting up a Private Operator service for AWS Marketplace. |
| UID2 Private Operator for GCP | Information for setting up the UID2 Operator Service in Confidential Space, a confidential computing option from Google Cloud Platform. |
| UID2 Private Operator for Azure | Instructions for setting up the UID2 Operator Service in an instance of Confidential Containers, a confidential computing option from Microsoft Azure. |