Skip to content

Commit 8df4f81

Browse files
committed
Merge branch 'main' into gwh-APIDOCS-2943-uid2-snowflake-improvements
2 parents 00f29f7 + 74e9aa6 commit 8df4f81

12 files changed

+215
-148
lines changed

docs/guides/integration-ctv-guide.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ sidebar_position: 04
99

1010
import Link from '@docusaurus/Link';
1111
import IntegratingWithSSO from '../snippets/_integrating-with-sso.mdx';
12+
import PrivateOperatorOption from '../snippets/_private-operator-option.mdx';
1213

1314
# CTV Integration Guide
1415

@@ -27,6 +28,10 @@ To determine how you'll implement these steps, choose from the [CTV Integration
2728

2829
<IntegratingWithSSO />
2930

31+
## Private Operator Option
32+
33+
<PrivateOperatorOption/>
34+
3035
## Complete UID2 Account Setup and Configure Account
3136

3237
To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
@@ -49,11 +54,13 @@ The specific values you set up will depend on which of the [CTV integration opti
4954

5055
## CTV Integration Options
5156

52-
You can decide on the integration option that's best for you based on where you want to generate and refresh the UID2 token. There are three options, as follows:
57+
You can decide on the integration option that's best for you based on where you want to generate and refresh the UID2 token. There are three options, as shown in the following table.
5358

54-
- [Client-Side Integration](#client-side-integration-for-ctv-apps) (the token is generated and refreshed on the client side)
55-
- [Server-Side Integration](#server-side-integration-for-ctv-apps) (the token is generated and refreshed on the server side)
56-
- [Client-Server Integration](#client-server-integration-for-ctv-apps) (the token is generated on the server side and refreshed on the client side)
59+
| Option | Details |
60+
| :--- | :--- |
61+
| [Client-Side Integration](#client-side-integration-for-ctv-apps) | The token is generated and refreshed on the client side. |
62+
| [Server-Side Integration](#server-side-integration-for-ctv-apps) | The token is generated and refreshed on the server side. |
63+
| [Client-Server Integration](#client-server-integration-for-ctv-apps) | The token is generated on the server side and refreshed on the client side. |
5764

5865
### Client-Side Integration for CTV Apps
5966

docs/guides/integration-options-private-operator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Link from '@docusaurus/Link';
88

99
# UID2 Private Operator Integration Overview
1010

11-
UID2 participants that host their own <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link> send their own first-party <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> to their own, local UID2 <Link href="../ref-info/glossary-uid#gl-operator">Operator</Link> service, running in a private environment.
11+
UID2 participants that host their own <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link> send their own first-party <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> to their own local UID2 <Link href="../ref-info/glossary-uid#gl-operator">Operator</Link> service, running in a private environment.
1212

1313
A Private Operator runs in an <Link href="../ref-info/glossary-uid#gl-enclave">enclave</Link>&#8212;a virtual machine with additional security features to prevent unauthorized access, so that unauthorized individuals cannot download any configuration information or data from the virtual machine.
1414

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Publisher Integration Resources
3+
description: Overview of the resources available for publishers integrating with UID2.
4+
hide_table_of_contents: false
5+
sidebar_position: 02
6+
displayed_sidebar: sidebarPublishers
7+
---
8+
9+
import Link from '@docusaurus/Link';
10+
import PublisherImplementationResources from '../snippets/_publisher-implementation-resources.mdx';
11+
12+
# Publisher Integration Resources
13+
14+
<PublisherImplementationResources/>

docs/guides/integration-options-publisher-web.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ To accomplish all steps, you can combine solutions. For example, you could use t
4343

4444
<!-- &#9989; = Supported | &#8212; = Not Supported -->
4545

46+
## Publisher Web Options Workflow
47+
4648
To choose your implementation and get started, follow these steps:
4749

4850
1. Review the summary of options to generate a UID2 token:

docs/overviews/overview-publishers.md

Lines changed: 7 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ displayed_sidebar: sidebarPublishers
1616

1717
import Link from '@docusaurus/Link';
1818
import IntegratingWithSSO from '../snippets/_integrating-with-sso.mdx';
19+
import PrivateOperatorOption from '../snippets/_private-operator-option.mdx';
20+
import PublisherImplementationResources from '../snippets/_publisher-implementation-resources.mdx';
1921

2022
As a publisher, you can benefit from the cross-device presence of Unified ID 2.0 (UID2) and take advantage of a consistent identity fabric on all your inventory.
2123

@@ -70,6 +72,10 @@ The following steps provide a high-level outline of the workflow intended for or
7072

7173
<IntegratingWithSSO />
7274

75+
## Private Operator Option
76+
77+
<PrivateOperatorOption/>
78+
7379
## Getting Started
7480

7581
To get started, follow these steps:
@@ -96,76 +102,7 @@ To get started, follow these steps:
96102

97103
## Implementation Resources
98104

99-
The following resources are available for publishers to implement UID2:
100-
101-
- [Web Integrations](#web-integrations)
102-
- [Mobile Integrations](#mobile-integrations)
103-
- [CTV Integrations](#ctv-integrations)
104-
- [Prebid Integrations](#prebid-integrations)
105-
- [Google Ad Manager Integrations](#google-ad-manager-integrations)
106-
107-
### Web Integrations
108-
109-
The following resources are available for publisher web integrations.
110-
111-
:::tip
112-
For a detailed summary of web integration options, see [Publisher Web Integration Overview](../guides/integration-options-publisher-web.md).
113-
:::
114-
115-
| Integration Type| Documentation | Content Description |
116-
| :--- | :--- | :--- |
117-
| Prebid (Overview) | [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) | An overview of options for publishers who 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 or the Prebid Mobile SDK in the RTB bidstream. |
118-
| Prebid.js Client-Side Integration | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | A guide for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach, and choose to have Prebid.js manage the following: <ul><li>Token generation and <a href="../ref-info/glossary-uid#gl-token-refresh">token refresh</a>.</li><li>Passing the tokens into the RTB bidstream.</li></ul> |
119-
| Prebid.js Client-Server Integration | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | A guide for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js in the RTB bidstream, but want to generate tokens server-side: for example, publishers who are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. |
120-
| JavaScript (Overview) | [UID2 Integration Overview for JavaScript](../guides/integration-javascript.md) | An overview of options for publishers who want to integrate with UID2 using the JavaScript SDK. |
121-
| JavaScript Client-Side Integration | [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) | A guide for publishers who want to integrate with UID2 using only client-side JavaScript changes, which is the easiest implementation approach.<br/>The SDK for JavaScript manages token generation and token refresh automatically. |
122-
| JavaScript Client-Server Integration | [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) | A publisher guide covering standard web integration scenarios that use the SDK for JavaScript and require tokens to be generated on the server side and passed to the publisher web pages. |
123-
| 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). |
124-
| 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). |
125-
126-
### Mobile Integrations
127-
128-
The following resources are available for publisher integrations supporting Android or iOS devices.
129-
130-
| Integration Type| Documentation | Content Description |
131-
| :--- | :--- | :--- |
132-
| Android/iOS (Overview) | [Mobile Integration Overview for Android and iOS](../guides/integration-mobile-overview.md) | An overview of options for mobile app publishers who want to integrate with UID2 using the SDK for Android or the SDK for iOS. |
133-
| Android/iOS, Client-Side Integration | [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) | An integration guide for mobile app publishers who want to integrate with UID2 with changes only within the mobile app (no server-side changes). |
134-
| Android/iOS, Client-Server Integration | [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:<ol><li>Generating UID2 tokens server-side via either a Public or Private Operator.</li><li>Passing the resulting <Link href="../ref-info/glossary-uid#gl-identity">identities</Link> to a mobile app for passing into the bidstream.</li></ol> |
135-
| Android/iOS, Server-Side Integration | [Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. |
136-
| Android | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) |An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support Android apps. |
137-
| iOS | [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) | An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support iOS apps. |
138-
139-
### CTV Integrations
140-
141-
The following resources are available for publisher integrations supporting CTV.
142-
143-
| Integration Type| Documentation | Content Description |
144-
| :--- | :--- | :--- |
145-
| CTV | [CTV Integration Guide](../guides/integration-ctv-guide.md) | A summary of CTV integration options, with links to additional information and instructions. |
146-
147-
### Prebid Integrations
148-
149-
The following resources are available for publishers integrating with Prebid.
150-
151-
| Integration Type| Documentation | Content Description |
152-
| :--- | :--- | :--- |
153-
| Prebid (Overview) | [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) | An overview of options for publishers who 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 or the Prebid Mobile SDK in the RTB bidstream. |
154-
| Prebid.js Client-Side Integration | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | A guide for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach, and choose to have Prebid.js manage the following: <ul><li>Token generation and token refresh.</li><li>Passing the tokens into the RTB bidstream.</li></ul> |
155-
| Prebid.js Client-Server Integration | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | A guide for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js in the RTB bidstream, but want to generate tokens server-side: for example, publishers who are using a Private Operator. |
156-
| Prebid.js on Mobile | [UID2 Mobile Integration for Prebid.js](../guides/integration-prebid-mobile-summary.md) | A summary of information resources for UID2 integration with Prebid.js on mobile devices. |
157-
158-
### Google Ad Manager Integrations
159-
160-
The following resources are available for publishers integrating with Google Ad Manager.
161-
162-
| Integration Type| Documentation | Content Description |
163-
| :--- | :--- | :--- |
164-
| 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). |
165-
| GMA for Android | [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android.md) | A guide that enables publishers using the Google Mobile Ads (GMA) SDK to include UID2 tokens in ad requests from their Android apps. |
166-
| GMA for iOS | [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md) | A guide that enables publishers using the Google Mobile Ads (GMA) SDK to include UID2 tokens in ad requests from their iOS apps. |
167-
| IMA for Android | [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android.md) | A guide that enables publishers using the Google Interactive Media Ads (IMA) SDK to include UID2 tokens in ad requests from their Android apps. |
168-
| IMA for iOS | [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md) | A guide that enables publishers using the Google Interactive Media Ads (IMA) SDK to include UID2 tokens in ad requests from their iOS apps. |
105+
<PublisherImplementationResources/>
169106

170107
## FAQs for Publishers
171108

docs/ref-info/glossary-uid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -416,10 +416,10 @@ import Link from '@docusaurus/Link';
416416

417417
<dt><MdxJumpAnchor id="gl-salt-bucket"><a href="#gl-salt-bucket">Salt bucket</a></MdxJumpAnchor></dt>
418418
<dd>A salt bucket is used to manage secret <a href="#gl-salt">salt</a> values, used to generate raw UID2s or UID2 tokens, over time. Each bucket contains a single current salt value, which remains active for approximately one year before being rotated to a new value. Buckets can be updated independently of one another.</dd>
419-
<dd>There are just over one million salt buckets, and each email address or phone number is assigned to a specific bucket in a deterministic manner. However, this assignment is not permanent; it might change when the bucket's current secret salt is rotated to a new value.</dd>
419+
<dd>There are just over one million salt buckets, and each email address or phone number is assigned to a specific bucket in a deterministic manner. However, this assignment is not permanent; it might change when the bucket's current salt is rotated to a new value.</dd>
420420

421421
<dt><MdxJumpAnchor id="gl-salt-bucket-id"><a href="#gl-salt-bucket-id">Salt bucket ID</a></MdxJumpAnchor></dt>
422-
<dd>A salt bucket ID is a unique string of characters that identifies a specific <a href="#gl-salt-bucket">salt bucket</a>. The salt bucket ID can be used to check which salt buckets have recently had their secret salt values updated, indicating which emails or phone numbers need their raw UID2 values regenerated.</dd>
422+
<dd>A salt bucket ID is a unique string of characters that identifies a specific <a href="#gl-salt-bucket">salt bucket</a>. The salt bucket ID can be used to check which salt buckets have recently had their salt values updated, indicating which emails or phone numbers need their raw UID2 values regenerated.</dd>
423423
<dd>For an example of a salt bucket ID, see the response to the `POST /identity/buckets` endpoint: <a href="../endpoints/post-identity-buckets#decrypted-json-response-format">Decrypted JSON Response Format</a>.</dd>
424424

425425
<dt><MdxJumpAnchor id="gl-salted-hash"><a href="#gl-salted-hash">Salted hash</a></MdxJumpAnchor></dt>
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import Link from '@docusaurus/Link';
2+
3+
If you're a publisher and want to keep your first-party data within your corporate network, you might choose to deploy a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. In this scenario, you choose to host a private instance exclusively for your own use.
4+
5+
For additional information, review these resources:
6+
7+
- [The UID2 Operator](../ref-info/ref-operators-public-private.md)
8+
- [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator.md)
9+
10+
:::note
11+
The UID2 Private Operator solutions do not support client-side generation of the UID2 token. If you want a client-side implementation, you must use a Public Operator solution.
12+
:::

0 commit comments

Comments
 (0)