Skip to content

Commit d33b2ec

Browse files
authored
Merge pull request #761 from IABTechLab/gwh-APIDOCS-2688-07-minor-edits-guides
UID2 minor edits from parity check on Guides docs
2 parents 17d34e5 + 5391222 commit d33b2ec

17 files changed

+30
-279
lines changed

docs/guides/advertiser-dataprovider-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ DII refers to a user's normalized email address or phone number, or the normaliz
5656
<!-- diagram source: resource/advertiser-flow-mermaid.md.bak -->
5757

5858
Refer to the following sections for details about the different parts of the diagram:
59-
1. [Retrieve a raw UID2 for DII using the identity map endpoints](#1-retrieve-a-raw-uid2-for-dii-using-the-identity-map-endpoint)
59+
1. [Retrieve a raw UID2 for DII using the identity map endpoint](#1-retrieve-a-raw-uid2-for-dii-using-the-identity-map-endpoint)
6060
2. [Send stored raw UID2s to DSPs to create audiences or conversions](#2-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)
6161
3. [Monitor for salt bucket rotations related to your stored raw UID2s](#3-monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s)
6262

docs/guides/integration-javascript-client-side.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This approach is used by the following participant types:
2828

2929
This guide does not apply to publishers who want to use a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>, or who want to generate tokens server-side. Those publishers should follow the [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md).
3030

31-
UID2 provides a SDK for JavaScript (see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md)) with the following features:
31+
UID2 provides an SDK for JavaScript (see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md)) with the following features:
3232

3333
- UID2 token generation
3434
- Automatic refreshing of UID2 tokens
@@ -37,7 +37,7 @@ UID2 provides a SDK for JavaScript (see [SDK for JavaScript Reference Guide](../
3737
To implement, you'll need to complete the following steps:
3838

3939
1. [Complete UID2 account setup](#complete-uid2-account-setup)
40-
2. [Add SDK For JavaScript to your site](#add-sdk-for-javascript-to-your-site)
40+
2. [Add SDK for JavaScript to your site](#add-sdk-for-javascript-to-your-site)
4141
3. [Configure the SDK for JavaScript](#configure-the-sdk-for-javascript)
4242
4. [Check that the token was successfully generated](#check-that-the-token-was-successfully-generated)
4343

@@ -74,7 +74,7 @@ When account setup is complete, you'll receive a client keypair consisting of tw
7474
Only root-level domains are required for account setup. For example, if you're going to use SDK for JavaScript on example.com, shop.example.com, and example.org, you only need to provide the domain names example.com and example.org.
7575
:::
7676

77-
## Add SDK For JavaScript to Your Site
77+
## Add SDK for JavaScript to Your Site
7878

7979
The following code snippet provides an overview of the code you will need to add to your website. It also illustrates the different events that the SDK can trigger.
8080

@@ -149,7 +149,7 @@ UID2 provides the publisher with the following values required to use the client
149149
* A Subscription ID
150150
* A public key
151151

152-
You'll have one set of these values for your publisher Integration environment, and a separate set for your production environment.
152+
You'll have one set of these values for your publisher integration environment, and a separate set for your production environment.
153153

154154
To configure the SDK, call one of the following methods, with an object containing the **public key** and **Subscription ID** that you received during account setup, as well as the user's hashed or unhashed <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (email address or phone number):
155155

@@ -269,14 +269,14 @@ In this scenario:
269269
After calling one of the methods listed in [Configure the SDK for JavaScript](#configure-the-sdk-for-javascript) successfully, an <Link href="../ref-info/glossary-uid#gl-identity">identity</Link> is generated and stored in local storage, under the key `UID2-sdk-identity`. The SDK refreshes the UID2 token periodically.
270270

271271
:::warning
272-
The format of the object stored in local storage could change without notice. We recommend that you do **not** read or update the object in local storage directly.
272+
The format of the object stored in local storage could change without notice. We recommend that you do **not** read or update the object in local storage directly.
273273
:::
274274

275275
## Example Integration Code and When to Pass DII to the UID2 SDK
276276

277277
If you're a publisher and this is the first page load with no <Link href="../ref-info/glossary-uid#gl-identity">identity</Link>, to start the token generation call you'll need to call one of the `setIdentity` methods with DII. Once an identity is generated, the advertising token (<Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link>) that you would send to the bidstream will be available by waiting for the `IdentityUpdated` event from the SDK. For an example, see how the value for `advertising_token_to_use` is set in the following code snippet.
278278

279-
In some cases, the user's DII is not available on page load, and getting the DII has some associated cost. For example, an API call might be required to fetch the DII, or the user has to be prompted to provide the DII information.
279+
In some cases, the user's DII is not available on page load, and getting the DII has some associated cost. For example, an API call might be required to fetch the DII, or the user has to be prompted to provide it.
280280

281281
You can potentially avoid that cost by checking for an existing token that you can use or refresh. To do this, call
282282
[__uid2.isLoginRequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) which returns a Boolean value. If it returns `true`, this means that the UID2 SDK cannot create a new advertising token with the existing resource and DII is required to generate a brand new UID2 token.

docs/guides/integration-mobile-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Podspec is the name of the file in CocoaPods that defines the libraries to be in
145145

146146
Here's some additional information to help you troubleshoot your UID2 mobile integrations:
147147

148-
- [Android SDK cannot connect in Production environment](#android-sdk-cannot-connect-in-production-environment)
148+
- [Android SDK Cannot Connect in Production Environment](#android-sdk-cannot-connect-in-production-environment)
149149

150150
#### Android SDK Cannot Connect in Production Environment
151151

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The basic workflow for a Private Operator is as follows:
7070

7171
Each supported Private Operator implementation must meet rigorous security standards. Some security points include:
7272

73-
- The Private Operator runs in a hardware-based trusted execution environment (TEE) hosted by one of the supported cloud providers listed in [Hosting Options for Private Operators](#hosting-options-for-private-operators).
73+
- The Private Operator runs in a hardware-based trusted execution environment (TEE) hosted by a supported cloud provider listed in [Hosting Options for Private Operators](#hosting-options-for-private-operators).
7474
- The Private Operator must complete an attestation process before accessing the information needed to process UID2s.
7575
- The information on S3 is encrypted at rest and also encrypted in transit through TLS. In addition, access is limited to only correctly authorized and attested Private Operators.
7676
- The information retrieved at startup is not stored locally at any point. It is only ever held in memory, and the Private Operator is running in a protected environment that makes it difficult for anyone running the Operator (such as an Administrator), as well as any external players, to see the data that's in memory.

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

Lines changed: 1 addition & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,6 @@ As a publisher, there are many ways that you can integrate with UID2 to generate
1414

1515
On this page, you'll find a high-level overview of integration steps and integration options, with links to additional information for each option.
1616

17-
<!-- The integration option that's right for you depends on many factors. For example, if the <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> is available on the client side, and you can use the latest version of Prebid.js, you can use the UID2 Prebid.js module, which manages the token generate request, token refresh request, and passing the token into the bidstream.
18-
19-
Some questions you might ask:
20-
- Do you want to generate the UID2 token request on the client side or the server side?
21-
- Do you use Prebid.js? If yes:
22-
- Are you constrained to a specific Prebid.js version?
23-
- Do you want the UID2 Prebid.js module to do everything&#8212;generate the token, refresh the token, and pass the token into the bidstream?
24-
- Do you prefer to use the SDK for JavaScript to generate and refresh the token, and use Prebid.js to pass the token into the bidstream? -->
25-
2617
## Key Integration Steps
2718

2819
At a high level, to integrate with UID2, you'll implement these three key activities:
@@ -44,7 +35,7 @@ To accomplish all steps, you can combine solutions. For example, you could use t
4435
| [Prebid.js client-side (8.21.0 or later)](integration-prebid-client-side.md) | &#9989; | &#9989; | &#9989; |
4536
| [Prebid.js client-server (7.53.0 or later)](integration-prebid-client-server.md) | &#8212; | &#9989; | &#9989; |
4637
| [SDK for JavaScript, client-side](integration-javascript-client-side.md) | &#9989; | &#9989; | &#8212; |
47-
| [SDK for JavaScript, server-side](integration-javascript-client-server.md) | &#9989; | &#9989; | &#8212; |
38+
| [SDK for JavaScript, client-server](integration-javascript-client-server.md) | &#9989; | &#9989; | &#8212; |
4839
| [SDK for Java](../sdks/sdk-ref-java.md) | &#9989; | &#9989; | &#8212; |
4940
| [SDK for Python](../sdks/sdk-ref-python.md) | &#9989; | &#9989; | &#8212; |
5041
| [Direct integration (API endpoints)](integration-publisher-server-side.md) | &#9989; | &#9989; | &#8212; |
@@ -100,8 +91,6 @@ Generating the UID2 token on the server side has the following advantages:
10091

10192
The following table summarizes the options for publishers who want to generate the UID2 token on the server side.
10293

103-
<!-- (**GWH_SW His query: "why is Prebid.js server integration not listed here?" I thought the server-side option didn't support token/generate + per KK's diagram. Let's discuss. Affects summary table also.**) -->
104-
10594
| Option | Documentation |
10695
| :--- | :--- |
10796
| SDK for JavaScript, client-server implementation | [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) |
@@ -142,119 +131,3 @@ The following table shows integration options that support passing UID2 token in
142131
:::note
143132
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.
144133
:::
145-
146-
<!-- ## Integration Using Prebid.js
147-
148-
(**GWH_KK not sure if we want this section. Would appreciate your input.**)
149-
150-
If you want to integrate using Prebid.js, here are some additional questions you'll need to answer to determine the best integration approach, and some steps to take:
151-
152-
- What Prebid.js version are you using?
153-
- If you're using Prebid.js 8.21.0 or later, you can use the client-side Prebid.js integration option, which is the simplest and easiest implementation approach.
154-
- If you're using a version prior to 8.21.0 (7.53.0 or later), and can't easily upgrade, you'll choose a server-side option.
155-
- Domain names:
156-
- As part of account setup, if you're using the Prebid.js client-side option, you'll need to provide a list of your root-level domains.
157-
- Are you already using the UID2 JavaScript SDK to generate and refresh the token? If so, you can continue to use the Prebid.js client-server implementation. For details, see [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md). -->
158-
159-
<!--
160-
## Advantages: Summary
161-
162-
The following table summarizes the advantages of each integration option.
163-
(**GWH_KK don't like having two tables but I can't fit it all into one. Also the docs are different. Need input re the best docs to link to... SDK ref or integration guide?**)
164-
165-
| Option | Client/Server | Advantages | Documentation |
166-
| :--- | :--- | :--- | :--- |
167-
| Prebid.js 8.21.0 or later | Client | <ul><li>No server-side coding needed.</li><li>Fast and easy implementation.</li></ul> | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) |
168-
| UID2 JavaScript SDK + Prebid.js 7.53.0 or later | Client | <ul><li>No need to upgrade to the latest Prebid.js version.</li><li>Easier to manage latency with a server-side implementation.</li><li>The JavaScript SDK takes care of generating and refreshing the token, and Prebid.js takes care of sending the token to the bidstream.</li></ul> | <ul><li>[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md)</li><li>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md)</li></ul> |
169-
| SDK for JavaScript | Server | <ul><li>The SDK takes care of generating and refreshing the token.</li><li>Coded in JavaScript.</li></ul> If you use JavaScript, and client-side implementation is not suitable for you, this is your best choice. | [SDK for JavaScript Reference Guide (2.x and earlier versions)](../sdks/sdk-ref-javascript-v2.md) |
170-
| SDK for Java | Server | <ul><li>The SDK takes care of generating and refreshing the token.</li><li>Coded in Java.</li></ul> If your server-side coding is Java, and client-side implementation is not suitable for you, this is your best choice. | [SDK for Java (Server-Side) Reference Guide](../sdks/sdk-ref-java.md) |
171-
| SDK for Python] | Server | <ul><li>The SDK takes care of generating and refreshing the token.</li><li>Coded in Python.</li></ul> If your server-side coding is Python, and client-side implementation is not suitable for you, this is your best choice. | [SDK for Python (Server-Side) Reference Guide](../sdks/sdk-ref-python.md) |
172-
| Direct integration (API endpoints) | Server | You're free to implement the APIs in whatever way you choose. | <ul><li>[POST /token/generate](../endpoints/post-token-generate.md)</li><li>[POST /token/refresh](../endpoints/post-token-refresh.md)</li></ul> |
173-
-->
174-
175-
<!-- ## BELOW = TO DELETE
176-
-----------------------------BELOW = TO DELETE
177-
178-
## Integration Details
179-
180-
The following sections provide additional information on each of the integration options, with links to documentation resources:
181-
182-
* [Prebid.js 8.21.0 or Later](#prebidjs-8210-or-later)
183-
* [UID2 JavaScript SDK + Prebid.js 7.53.0 or later](#uid2-sdk-for-javascript--prebidjs-7530-or-later)
184-
* [SDK for JavaScript](#uid2-sdk-for-javascript)
185-
* [SDK for Java](#uid2-sdk-for-java)
186-
* [SDK for Python](#uid2-sdk-for-python)
187-
* [Direct integration (API endpoints)](#direct-integration-api-endpoints)
188-
189-
### Prebid.js 8.21.0 or Later
190-
191-
The advantages of this implementation approach are as follows:
192-
193-
- No server-side coding needed.
194-
- Fast and easy implementation.
195-
196-
For details, see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md).
197-
198-
### SDK for JavaScript + Prebid.js 7.53.0 or later
199-
200-
The advantages of this implementation approach are as follows:
201-
202-
- No need to upgrade to the latest Prebid.js version.
203-
- Easier to manage latency with a server-side implementation.
204-
- The JavaScript SDK takes care of generating and refreshing the token, and Prebid.js takes care of sending the token to the bidstream.
205-
206-
For details, see:
207-
- [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md)
208-
- [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md)
209-
210-
### SDK for JavaScript
211-
212-
The advantages of this implementation approach are as follows:
213-
214-
- The SDK takes care of generating and refreshing the token.
215-
- Coded in JavaScript. If you use JavaScript, and client-side implementation is not suitable for you, this is your best choice.
216-
217-
For details, see [SDK for JavaScript Reference Guide (2.x and earlier versions)](../sdks/sdk-ref-javascript-v2.md).
218-
219-
### SDK for Java
220-
221-
The advantages of this implementation approach are as follows:
222-
223-
- The SDK takes care of generating and refreshing the token.
224-
- Coded in Java. If your server-side coding is Java, and client-side implementation is not suitable for you, this is your best choice.
225-
226-
For details, see [SDK for Java (Server-Side) Reference Guide](../sdks/sdk-ref-java.md).
227-
228-
### SDK for Python
229-
230-
The advantages of this implementation approach are as follows:
231-
232-
- The SDK takes care of generating and refreshing the token.
233-
- Coded in Python. If your server-side coding is Python, and client-side implementation is not suitable for you, this is your best choice.
234-
235-
For details, see [SDK for Python (Server-Side) Reference Guide](../sdks/sdk-ref-python.md).
236-
237-
### Direct integration (API endpoints)
238-
239-
The advantages of this implementation approach are as follows:
240-
241-
- You're free to implement the APIs in whatever way you choose.
242-
243-
For details, see:
244-
- [POST /token/generate](../endpoints/post-token-generate.md)
245-
- [POST /token/refresh](../endpoints/post-token-refresh.md) -->
246-
247-
248-
<!--
249-
## TABLE STASH
250-
251-
| Option | Token Generation managed by | Token Refresh managed by |Passing Token to the Bidstream |
252-
| :--- | :--- | :--- | :--- |
253-
| Prebid.js 8.21.0 or later<br/>[UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | Prebid.js 8.21.0 or later | Prebid.js 8.21.0 or later | Prebid.js 8.21.0 or later |
254-
| UID2 JavaScript SDK + <br/>Prebid.js 7.53.0 or later | UID2 JS SDK<br/>[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | UID2 JS SDK or Prebid.js 7.53.0 or later | Prebid.js 7.53.0 or later<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
255-
| SDK for JavaScript<ul><li>[Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md)</li><li>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)</li></ul> | JavaScript SDK | JavaScript SDK | Publisher's choice. For example, Prebid.js.<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
256-
| SDK for Java<br/>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | [SDK for Java](../sdks/sdk-ref-java.md) | [SDK for Java](../sdks/sdk-ref-java.md)| Publisher's choice.<br/>Can be integrated with Prebid.js. |
257-
| SDK for Python<br/> [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)| [SDK for Python](../sdks/sdk-ref-python.md) | [SDK for Python](../sdks/sdk-ref-python.md) | Publisher's choice.<br/>Can be integrated with Prebid.js. |
258-
| GAM Secure Signals<br/> [xxx](integration-publisher-server-side.md)| [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) |
259-
| Direct integration<br/>(API endpoints)<br/>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | [POST /token/generate](../endpoints/post-token-generate.md) | [POST /token/refresh](../endpoints/post-token-refresh.md) | Publisher's choice.<br/>Can be integrated with Prebid.js. |
260-
-->

docs/guides/integration-prebid-client-server.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,13 @@ To integrate with UID2 using Prebid.js, you'll need to:
2323
- Make server-side changes for token generation (and, optionally, <a href="../ref-info/glossary-uid#gl-token-refresh">token refresh</a>).
2424

2525
## Prebid.js Version
26+
2627
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).
2728

29+
<!-- Diff in Prebid.js supported version for UID2/EUID is fine: verif SS 11/19/24 -->
30+
2831
## UID2 Prebid Module Page
29-
<!-- GWH TODO later: move to overview or to client side doc maybe when client-side implementation is added to the Prebid module pages. Now, they are only server side. -->
32+
3033
Information about how to integrate Prebid with UID2 is also in the following locations:
3134
- On the Prebid site, on the [Unified ID 2.0](https://docs.prebid.org/dev-docs/modules/userid-submodules/unified2.html) page for the Prebid User ID submodule.
3235
- In the Prebid GitHub repository, on the [UID2 User ID Submodule](https://github.com/prebid/Prebid.js/blob/master/modules/uid2IdSystem.md) page.

0 commit comments

Comments
 (0)