From 236daf45b0292e357efec6f2407d0065562d92ca Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 9 Dec 2025 14:55:09 -0500 Subject: [PATCH 1/2] edits --- docs/guides/integration-options-publisher-all.md | 2 +- .../current/guides/integration-options-publisher-all.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/integration-options-publisher-all.md b/docs/guides/integration-options-publisher-all.md index 7f769d14e..625a9a713 100644 --- a/docs/guides/integration-options-publisher-all.md +++ b/docs/guides/integration-options-publisher-all.md @@ -11,4 +11,4 @@ import SnptPublisherImplementationResources from '../snippets/_snpt-publisher-im # Publisher Integration Resources - + diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md index 077285ae9..2acef0cab 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md @@ -11,4 +11,4 @@ import SnptPublisherImplementationResources from '../snippets/_snpt-publisher-im # Publisher Integration Resources - + From 780cc2f3157db5d80463e5e2326cda962b6e8888 Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Wed, 10 Dec 2025 10:53:49 -0500 Subject: [PATCH 2/2] clarify token refresh --- docs/endpoints/post-token-generate.md | 2 +- docs/guides/integration-ctv-guide.md | 4 +++- docs/ref-info/ref-tokens.md | 11 +++++++++-- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index 4eda798c7..904e2ac6f 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -129,7 +129,7 @@ The response body includes the properties shown in the following table. | `advertising_token` | string | An encrypted advertising (UID2) token for the user. | | `refresh_token` | string | An encrypted token that can be exchanged with the UID2 Service for the latest set of identity tokens. | | `identity_expires` | number | The Unix timestamp (in milliseconds) that indicates when the advertising token expires. | -| `refresh_from` | number | The Unix timestamp (in milliseconds) that indicates when the SDK for JavaScript (see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md)) will start refreshing the UID2 token.
TIP: If you are not using the SDK, consider refreshing the UID2 token from this timestamp, too. | +| `refresh_from` | number | The Unix timestamp (in milliseconds) that indicates the point at which you should consider refreshing the UID2 token. | | `refresh_expires` | number | The Unix timestamp (in milliseconds) that indicates when the refresh token expires. | | `refresh_response_key` | string | A key to be used in a [POST /token/refresh](post-token-refresh.md) request for response decryption. | diff --git a/docs/guides/integration-ctv-guide.md b/docs/guides/integration-ctv-guide.md index 4896b1159..e78765fc8 100644 --- a/docs/guides/integration-ctv-guide.md +++ b/docs/guides/integration-ctv-guide.md @@ -20,7 +20,9 @@ If you're a Connected TV (CTV) publisher, there are several ways that you can in At a high level, to integrate with UID2, you'll implement these three key steps: 1. Generate the UID2 token. -1. Refresh the UID2 token as needed. +1. Refresh or regenerate the UID2 token frequently to ensure the token stays current. + + For details, see [Keeping the Token Current](../ref-info/ref-tokens.md#keeping-the-token-current) and [Recommended Token Refresh Frequency](../ref-info/ref-tokens.md#recommended-token-refresh-frequency). 1. Pass the UID2 token into the bidstream. To determine how you'll implement these steps, choose from the [CTV Integration Options](#ctv-integration-options). diff --git a/docs/ref-info/ref-tokens.md b/docs/ref-info/ref-tokens.md index e12e12acc..920cec42e 100644 --- a/docs/ref-info/ref-tokens.md +++ b/docs/ref-info/ref-tokens.md @@ -20,13 +20,12 @@ Here are some key points about UID2 tokens: - The UID2 token is a unique value: no two UID2 tokens are the same. - UID2 tokens are case sensitive. +- Publishers send UID2 tokens in the bidstream. - The token value is an opaque string: do not make any assumptions about the format or length of the string. - UID2 tokens representing different instances of user activity, on browsers, CTV, and electronic devices such as phones and tablets, can still be matched to the same raw UID2. - The token generation logic checks for user opt-out. If the user has opted out of UID2, no UID2 token is generated. For details, see [User Opt-Out](../getting-started/gs-opt-out.md). - The token has a limited life, but can be refreshed using the refresh token. - You can refresh many times, to get a new UID2 token and corresponding new refresh token, as long as the current UID2 token is always refreshed before the current refresh token expires. -- If the token has expired, or as an alternative to refreshing an existing token, you can generate a new UID2 token from the original hashed or unhashed email address or phone number. -- Publishers send UID2 tokens in the bidstream. - Refreshing a UID2 token does not invalidate/expire the original or previous UID2 token. You can still use the earlier token until it expires. For more information, see [How the UID2 Token Is Created](ref-how-uid-is-created.md). @@ -48,6 +47,14 @@ Here are some key points about refresh tokens: - In most cases, you can refresh tokens on the client side, even if the token was generated on the server side. For details about refresh functionality for the various SDKs, see [SDK Functionality](../sdks/summary-sdks.md#sdk-functionality) (*Refresh UID2 Token* column). - When the UID2 Operator Service receives the refresh token with a request for a new UID2 token, it checks for user opt-out. If the user has opted out of UID2, no new UID2 token is generated. For details, see [User Opt-Out](../getting-started/gs-opt-out.md). +### Keeping the Token Current + +It's very important to keep your UID2 tokens current (not expired). You get the advantages of UID2 only if the token is current. + +There are two options for keeping your UID2 tokens current: +- Refresh frequently, using the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint or the token refresh feature of many UID2 SDKs. For details, see [Recommended Token Refresh Frequency](#recommended-token-refresh-frequency). +- As an alternative to refreshing an existing token, generate a new token each time, using the [POST /token/generate](../endpoints/post-token-generate.md) endpoint or the token generate feature of many UID2 SDKs. + ### Recommended Token Refresh Frequency Currently, the recommended refresh interval is hourly. An hourly interval helps ensure that the token doesn't get close to being expired, and is ready to be sent to the bidstream. In addition, since user opt-out is checked before a new token is generated, this helps ensure that user opt-out preferences are implemented promptly.