Skip to content

Commit c1a7814

Browse files
committed
review mods
1 parent d574b47 commit c1a7814

7 files changed

Lines changed: 20 additions & 20 deletions

File tree

docs/portal/client-side-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In the UID2 Portal, if you want to use an implementation option that generates U
1919
| :--- | :--- | :---| :---|
2020
| Key pair | All (web or mobile) | At least one. In your implementation, you'll share the public key. | [Subscription ID and public key](../getting-started/gs-credentials.md#subscription-id-and-public-key) |
2121
| Domain | Web | At least one. Provide a complete list of your root-level domains. | [Client-side web integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) |
22-
| Mobile app ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-side mobile integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) |
22+
| Mobile App ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-side mobile integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) |
2323

2424
:::important
2525
It's important to provide a complete list of root-level domain names for your sites, and mobile app IDs for your apps. This is a security measure, for client-side implementation only. If a domain or app is not defined in the UID2 Portal, UID2 token requests from that domain or app will fail.
@@ -42,7 +42,7 @@ Client-side implementation options are shown in the following table. The options
4242
| :--- | :--- | :---|
4343
| UID2 JavaScript SDK | Publishers, Advertisers | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) |
4444
| Prebid.js client-side integration | Publishers only |[Client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) |
45-
| UID2 mobile SDK | Publishers only |[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) |
45+
| UID2 Mobile SDK | Publishers only |[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) |
4646

4747
## Adding and managing key pairs
4848

docs/portal/portal-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ The UID2 Portal is your one-stop shop for setting up and configuring your UID2 a
1515
| :--- | :--- |
1616
| Request an account, configure basic account information such as name and location, log in for the first time, and reset your password. | [Getting started with the UID2 Portal](portal-getting-started.md) |
1717
| Review your profile. | [Participant information](participant-info.md) |
18-
| Server-side or client-server integrations: manage API keys for your account, including adding, modifying, or deleting keys. | [API keys](api-keys.md) |
19-
| Client-side integrations only: set up and manage the values needed for generating UID2 tokens on the client side. | [Client-side integration](client-side-integration.md) |
20-
| Configure permissions for individual <Link href="../ref-info/glossary-uid#gl-sharing-participant">sharing participants</Link> or groups of sharing participants.<br/>note: use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [client-side integration](client-side-integration.md)). configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) |
18+
| Server-side or client-server integrations: Manage API keys for your account, including adding, modifying, or deleting keys. | [API keys](api-keys.md) |
19+
| Client-side integrations only: Set up and manage the values needed for generating UID2 tokens on the client side. | [Client-side integration](client-side-integration.md) |
20+
| Configure permissions for individual <Link href="../ref-info/glossary-uid#gl-sharing-participant">sharing participants</Link> or groups of sharing participants.<br/>NOTE: use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [Client-side integration](client-side-integration.md)). Configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) |
2121
| Add team members who will have permission to manage your account. | [Team members](team-members.md) |
2222
| Set up designated email contacts who will be notified of news or updates. | [Email contacts](email-contacts.md) |
2323
| View a detailed log of all past actions performed by, or on behalf of, the current participant. | [Audit trail](audit-trail.md) |
24-
| Change password when required by the portal. | [Password change requirement](portal-getting-started.md#password-change-requirement) |
24+
| Change password when required by the Portal. | [Password change requirement](portal-getting-started.md#password-change-requirement) |
2525

2626
## Access the UID2 Portal
2727

docs/ref-info/ref-uid-verify.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,11 @@ SDK and Prebid.js integrations include the fields shown in the following table.
9797

9898
| Field | Description |
9999
|---|---|
100-
| Storage type | Indicates whether the identity is stored in a cookie or `localStorage`. |
101-
| 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`. |
102-
| Stored value | The raw identity JSON, including `advertising_token`, `refresh_token`, `identity_expires`, `refresh_expires`, `refresh_from`, and `refresh_response_key`. |
103-
| 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. |
104-
| Optout identity | Indicates whether the identity reflects an opted-out user. |
100+
| Storage Type | Indicates whether the identity is stored in a cookie or `localStorage`. |
101+
| 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`. |
102+
| Stored Value | The raw identity JSON, including `advertising_token`, `refresh_token`, `identity_expires`, `refresh_expires`, `refresh_from`, and `refresh_response_key`. |
103+
| 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. |
104+
| Optout Identity | Indicates whether the identity reflects an opted-out user. |
105105

106106
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.
107107

docs/ref-info/uid-components.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The UID2 framework consists of the following components, all of which are curren
1414

1515
| Component | Description |
1616
| :--- | :--- |
17-
| **Core service** | A centralized service that manages access to <a href="../ref-info/glossary-uid#gl-salt">salts</a>, <a href="../ref-info/glossary-uid#gl-encryption-key">encryption keys</a>, and other relevant data in the UID2 ecosystem. |
18-
| **Operator service** | A service that enables the management and storage of encryption keys and salts from the UID2 Core Service, hashing of users' personal data, encryption of raw UID2s, and decryption of UID2 tokens. There can be multiple instances of the service (public or private) operated by multiple [participants](../overviews/participants-overview.md#uid2-component-services), known as operators.<br/><Link href="../ref-info/glossary-uid#gl-public-operator">Public Operators</Link> run publicly available instances of the <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> and make them available to all relevant UID2 participants. There might also be <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operators</Link> that run private instances of the Operator Service exclusively for their own use. All instances are designed with protections to keep critical UID2 data secure and interoperable, regardless of who operates the service. |
19-
| **Opt-out service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. |
20-
| **Transparency and control portal** | A user-facing website, [https://www.transparentadvertising.com/](https://www.transparentadvertising.com/), that allows consumers to opt out of UID2 at any time. |
17+
| **Core Service** | A centralized service that manages access to <a href="../ref-info/glossary-uid#gl-salt">salts</a>, <a href="../ref-info/glossary-uid#gl-encryption-key">encryption keys</a>, and other relevant data in the UID2 ecosystem. |
18+
| **Operator Service** | A service that enables the management and storage of encryption keys and salts from the UID2 Core Service, hashing of users' personal data, encryption of raw UID2s, and decryption of UID2 tokens. There can be multiple instances of the service (public or private) operated by multiple [participants](../overviews/participants-overview.md#uid2-component-services), known as operators.<br/><Link href="../ref-info/glossary-uid#gl-public-operator">Public Operators</Link> run publicly available instances of the <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> and make them available to all relevant UID2 participants. There might also be <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operators</Link> that run private instances of the Operator Service exclusively for their own use. All instances are designed with protections to keep critical UID2 data secure and interoperable, regardless of who operates the service. |
19+
| **Opt-Out Service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. |
20+
| **Transparency and Control Portal** | A user-facing website, [https://www.transparentadvertising.com/](https://www.transparentadvertising.com/), that allows consumers to opt out of UID2 at any time. |

docs/sdks/sdk-ref-android.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The following Android-related plugins, and associated documentation, are also av
1515

1616
| Purpose | Product/documentation |
1717
| :--- | :--- |
18-
| To use the Google mobile ads (GMA) SDK to send <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) |
18+
| To use the Google Mobile Ads (GMA) SDK to send <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) |
1919
| To use the Google Interactive Media Ads (IMA) SDK for Android to send <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) |
2020

2121
For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations).

docs/sdks/sdk-ref-ios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The following iOS-related plugins, and associated documentation, are also availa
1515

1616
| Purpose | Product/documentation |
1717
| :--- | :--- |
18-
| To use the Google mobile ads (GMA) SDK to send <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) |
18+
| To use the Google Mobile Ads (GMA) SDK to send <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) |
1919
| To use the Google Interactive Media Ads SDK for iOS to send <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) |
2020

2121
## tvOS support

docs/sdks/sdk-ref-javascript-v2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ The following table outlines the four main states that the SDK can be in, based
8383
| Workflow state | Advertising token | Login required | Description| Identity status value |
8484
| :--- | :--- | :---| :---| :---|
8585
| Initialization | `undefined`| `undefined`| Initial state until the callback is invoked. | N/A |
86-
| Identity is available | available |`false` | A valid identity has been successfully established or refreshed. You can use the advertising token in targeted advertising. |`ESTABLISHED` or `REFRESHED` |
87-
| Identity is temporarily unavailable |`undefined` | `false`| The advertising token has expired, therefore automatic refresh failed. [Background auto-refresh](#background-token-auto-refresh) attempts will continue until the refresh token expires or the user opts out.<br/>You can do either of the following:<br/>- Redirect the user, asking for the email or phone number.<br/>- Use untargeted advertising.<br/>NOTE: Identity might be successfully refreshed at a later time&#8212;for example, if the UID2 service is temporarily unavailable.| `EXPIRED` |
88-
| Identity is not available | `undefined`| `false`| The identity is not available and cannot be refreshed. The SDK clears the first-party cookie.<br/>To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. | `INVALID`, `NO_IDENTITY`, `REFRESH_EXPIRED`, or `OPTOUT` |
86+
| Identity Is Available | available |`false` | A valid identity has been successfully established or refreshed. You can use the advertising token in targeted advertising. |`ESTABLISHED` or `REFRESHED` |
87+
| Identity Is Temporarily Unavailable |`undefined` | `false`| The advertising token has expired, therefore automatic refresh failed. [Background auto-refresh](#background-token-auto-refresh) attempts will continue until the refresh token expires or the user opts out.<br/>You can do either of the following:<br/>- Redirect the user, asking for the email or phone number.<br/>- Use untargeted advertising.<br/>NOTE: Identity might be successfully refreshed at a later time&#8212;for example, if the UID2 service is temporarily unavailable.| `EXPIRED` |
88+
| Identity Is Not Available | `undefined`| `false`| The identity is not available and cannot be refreshed. The SDK clears the first-party cookie.<br/>To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. | `INVALID`, `NO_IDENTITY`, `REFRESH_EXPIRED`, or `OPTOUT` |
8989

9090
The following diagram illustrates the four states, including the corresponding identity [status values](#identity-status-values) and possible transitions between them. The SDK invokes the [callback function](#callback-function) on each transition.
9191

0 commit comments

Comments
 (0)