Skip to main content

Documentation Updates

Check out the latest updates to our UID2 documentation resources.

New: Prebid Mobile SDK Integration (Android)

We've added a new section to the two mobile integration guides with instructions for mobile integration using Prebid, currently for Android only:

New: CTV Integration Guide

21 June 2024

We've just added a new guide for CTV publishers who want to integrate with UID2.

For details, see CTV Integration Guide.

New: Opt-Out API

24 May 2024

We added documentation for a new API call that checks the opt-out status of raw UID2s.

Given a list of raw UID2s, this endpoint returns the raw UID2s that have opted out, as well as the time that the opt-out took place.

For details, see POST /optout/status.

New: Client-Side and Server-Side Guides for Mobile

17 May 2024

We've added the following integration guides to support publishers who want to implement UID2 for their Android or iOS mobile apps:

New: UID2 Portal Client-Side Integration Page

6 May 2024

The UID2 Portal documentation now includes a new page, Client-Side Integration.

The Client-Side Integration page in the UID2 Portal allows you to set up and manage the values that are needed if you are generating UID2 tokens on the client side, such as specifying your domains.

New: UID2 Portal API Keys Page

25 April 2024

The UID2 Portal documentation now includes a new page, API Keys.

The API Keys page in the UID2 Portal allows you to perform all activities relating to managing API keys, and their associated secret values and permission settings, for your UID2 account.

Documentation for Sharing Including Raw UID2 Sharing

22 April 2024

We've completely reworked and significantly expanded the sharing documentation to include instructions for all sharing scenarios.

The documentation now supports additional sharing scenarios, including the ability to share raw UID2s when senders and receivers follow the applicable legal, security, and technical requirements.

For details, see UID2 Sharing: Overview.

New: UID2 Hashing Tool

4 March 2024

We've added a new UID2 hashing tool so that you can check that you're normalizing and encoding correctly.

For details, see UID2 Hashing Tool in the Normalization and Encoding documentation.

New: Java SDK Support for Advertiser/Data Provider

28 February 2024

The Java SDK now supports Advertisers and Data Providers wanting to use the POST /identity/map endpoint.

For details, see the updated documentation in the UID2 SDK for Java Reference Guide: Usage for Advertisers and Data Providers.

New: Audience-Specific Documentation Sidebars

9 February 2024

We've improved the website so that specific users clicking through on the links at the top of the UID2 home page (Publishers, Advertisers, DSPs, Data Providers) now have a custom left sidebar, with the specific documentation that's applicable to that audience.

Anyone wanting to see the full set of docs for all audiences can just click through on the Documentation link on the UID2 home page.

Note that many docs are applicable to multiple audiences, and there are many interlinks between docs, so the sidebar view might change on your journey through the site. You can always get back to your specific view by clicking the link at the top: these links appear on all pages.

To view the custom sidebars, go to https://unifiedid.com and click on one of the audience links at the top: Publishers. Advertisers, DSPs, or Data Providers.

New: UID2 Integration Overview for JavaScript

26 January 2024

We've added a new overview guide summarizing the options for publishers using the UID2 SDK for JavaScript for client-side or client-server integration. In addition, the existing guides have been renamed for consistency, with minor updates.

For details, see:

New: UID2 SDK for Java, Usage for Publishers Sections

22 January 2024

We've added new sections in the UID2 SDK for Java documentation to help publishers implementing the SDK.

For details, see Usage for Publishers in the UID2 SDK for Java Reference Guide.

New: Normalization and Encoding Documentation, Examples Section

19 January 2024

We've expanded and clarified the existing Normalization and Encoding doc, and added a new examples section to help you make sure that you're following the process correctly.

For details, see Normalization and Encoding.

New: Web Integration Overview for Publishers

16 January 2024

We've added a new page summarizing the web integration options available to publishers integrating with UID2.

For details, see Web Integration Overview.

New: UID2 Operator Page

3 January 2024

We've added a reference article explaining what the UID2 Operator does and the differences between a Public Operator and a Private Operator.

For details, see The UID2 Operator.

New: UID2 Integration Overview for Prebid.js

20 December 2023

A new overview guide summarizes the publisher options for integrating Prebid with UID2.

In addition, the existing guides have been restructured and simplified.

For details, see:

New: Encryption/Decryption Examples in Java and C#

14 December 2023

We've added instructions and code examples for encrypting UID2 requests and decrypting responses in additional programming languages. To the existing Python example, we've added Java and C#.

For details, see Encryption and Decryption Code Examples.

New: UID2 Private Operator for Azure Integration Guide

30 November 2023

A UID2 participant who wants to be a Private Operator can now set up the UID2 Operator Service in a Confidential Container, a confidential computing option from Microsoft Azure.

For details, see UID2 Private Operator for Azure Integration Guide.

New: API Permissions

22 November 2023

A new article in the Getting Started section of the UID2 website provides information about the key UID2 permissions, the types of participants that commonly use them, and the key associated activities.

For details, see API Permissions.

New: UID2 Credentials Page

21 November 2023

We've replaced the previous API Keys page with a new page that includes information about the credentials for those following a server-side implementation strategy.

For details, see UID2 Credentials.

New: Client-Side Integration Guide for JavaScript

21 November 2023

The Client-Side Integration Guide for JavaScript is a completely new document at the existing URL, covering a new, simpler way of using the UID2 SDK for JavaScript for a client-side publisher implementation.

For details, see Client-Side Integration Guide for JavaScript.

The content that was in the previous UID2 SDK for JavaScript Integration Guide is now in a supplementary document for publishers who want to implement the JavaScript SDK on the server side.

note

This document was updated in January 2024 to Client-Side Integration Guide for JavaScript, and the JavaScript Standard Integration Guide is now the Client-Server Integration Guide for JavaScript.

New: UID2 Client-Side Integration Guide for Prebid.js

2 November 2023

The UID2 Client-Side Integration Guide for Prebid.js is a completely new document at the existing URL, covering a new, simpler way of integrating UID2 with Prebid that does not require any server-side work.

The content that was in the previous version of the Prebid document is now in a supplementary document, Prebid.js Advanced Integration Guide, for publishers who are using a private operator or who prefer to implement token generate on the server side.

note

New: Opt-Out

31 October 2023

This new "getting started" topic provides an overview of user opt-out.

For details, see User Opt-Out.

New: AWS Entity Resolution Integration Guide

19 October 2023

This new guide provides information for using AWS Entity Resolution, an identity resolution product from Amazon Web Services that allows AWS customers to integrate with the UID2 framework.

This service allows you to map DII (email addresses or phone numbers) to raw UID2s swiftly and securely.

For details, see AWS Entity Resolution Integration Guide.

New: UID2 SDK for JavaScript Version 3

10 October 2023

Significant documentation updates reflect the enhanced functionality of Version 3 of the UID2 SDK for JavaScript. The new documentation includes a migration guide for those upgrading from an earlier version of the SDK.

For details, see:

New: Private Operator Guide for Google Confidential Space

30 September 2023

This new guide provides information for setting up the UID2 Operator Service in Confidential Space, a confidential computing option from the Google Cloud Platform.

For details, see UID2 Private Operator for GCP Integration Guide.

Update: Normalization and Encoding Rules

7 September 2023

We clarified the instructions for normalizing and encoding directly identifying information (DII) to create a raw UID2 or UID2 token.

For details, see:

New: IMA Mobile Plugin for Android

8 August 2023

A new guide for publishers that provides information about the UID2 Interactive Media Ads (IMA) Plugin for Android. This plugin enables publishers who use the Google IMA SDK for Android to send UID2 tokens as secure signals in ad requests from Android apps.

For details, see UID2 IMA Plugin for Android Integration Guide.

New: IMA Mobile Plugin for iOS

8 August 2023

A new guide for publishers that provides information about the UID2 Interactive Media Ads (IMA) Plugin for iOS. This plugin enables publishers who use the Google IMA SDK for iOS to send UID2 tokens as secure signals in ad requests from iOS apps.

For details, see UID2 IMA Plugin for iOS Integration Guide.

New: GMA Mobile Plugin for Android

4 August 2023

A new guide for publishers that provides information about the UID2 Google Mobile Ads (GMA) Plugin for Android. This plugin enables publishers who use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from Android apps.

For details, see UID2 GMA Plugin for Android Integration Guide.

New: GMA Mobile Plugin for iOS

4 August 2023

A new guide for publishers that provides information about the UID2 Google Mobile Ads (GMA) Plugin for iOS. This plugin enables publishers who use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from iOS apps.

For details, see UID2 GMA Plugin for iOS Integration Guide.

New: UID2 Website in Japanese

3 August 2023

The entire UID2 website is now available in Japanese as well as English.

For details, use the language drop-down at the top of any site page, or go straight to the Unified ID 2.0 page in Japanese.

New: UID2 Portal Documentation

3 August 2023

We published several new documentation pages to help users navigating the new UID2 Portal user interface, where you can manage your UID2 account.

For details, see UID2 Portal: Overview.

New: Documentation for UID2 Sharing

3 August 2023

We published the following new and updated documents to support use of the new UID2 sharing feature:

New: Android SDK Guide

3 August 2023

A new guide for publishers that provides information about the UID2 SDK for Android, an SDK that facilitates the process of establishing client identity using UID2 and retrieving UID2 tokens for publishers who need to support Android apps.

For details, see UID2 SDK for Android Reference Guide.

New: iOS SDK Guide

3 August 2023

A new guide for publishers that provides information about the UID2 SDK for iOS, an SDK that facilitates the process of establishing client identity using UID2 and retrieving UID2 tokens for publishers who need to support iOS apps.

For details, see UID2 SDK for iOS Reference Guide.