Skip to content

Commit d45a962

Browse files
committed
edits from GM+SW
1 parent 337c00b commit d45a962

File tree

4 files changed

+23
-26
lines changed

4 files changed

+23
-26
lines changed

docs/ref-info/glossary-uid.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,9 @@ import Link from '@docusaurus/Link';
307307

308308
<dl>
309309

310+
<dt><MdxJumpAnchor id="gl-opaque"><a href="#gl-opaque">Opaque</a></MdxJumpAnchor></dt>
311+
<dd>When we say a UID2 token is an opaque string, we mean that the way that the token is computed is not shared. No assumptions should be made about the format or length of the string, or any other aspect of it.</dd>
312+
310313
<dt><MdxJumpAnchor id="gl-open-operator"><a href="#gl-open-operator">Open Operator</a></MdxJumpAnchor></dt>
311314
<dd>Open Operator is another term for a <a href="#gl-public-operator">Public Operator</a>.</dd>
312315

docs/ref-info/ref-tokens.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,20 @@ import Link from '@docusaurus/Link';
99

1010
# UID2 Tokens and Refresh Tokens
1111

12-
When a publisher sends a user's <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (email address or phone number) to the UID2 Operator, whether via one of the UID2 SDKs or the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) endpoint, the UID2 Operator returns a <a href="glossary-uid#gl-uid2-token">UID2 token</a> with associated values such as refresh token. The token is an opaque alphanumeric string. Every time a token is generated from DII input, the token value is different. Token values are never the same. Because of the way UID2 works, different instances of activity, on browsers, CTV, and electronic devices such as phone and tablets, can be matched without compromising the privacy of the individual. The token is designed so that it cannot be reverse engineered to arrive at the original email address or phone number.
12+
When a publisher sends a user's <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (email address or phone number) to the UID2 Operator, whether via one of the UID2 SDKs or the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) endpoint, the UID2 Operator returns a <a href="glossary-uid#gl-uid2-token">UID2 token</a> with associated values, including a refresh token. The token is an alphanumeric string. Each time a token is generated from DII input, the token value is different. Because of the way UID2 works, different instances of activity, on browsers, CTV, and electronic devices such as phone and tablets, can still be matched to the same <a href="glossary-uid#gl-raw-uid2">raw UID2</a> generated from the user's DII, even though the token might be different. The token is designed to protect against reverse engineering that might reveal the original email address or phone number.
1313

14-
For security reasons, the UID2 token has a short life. Along with the UID2 token, the UID2 Operator sends a <a href="glossary-uid#gl-refresh-token">refresh token</a> that the publisher can use to generate a new UID2 token. If the token is not refreshed before it expires, it becomes invalid and cannot be used for targeted advertising.
14+
The UID2 token has a short life. Along with the UID2 token, the UID2 Operator sends a <a href="glossary-uid#gl-refresh-token">refresh token</a> that the publisher can use to generate a new UID2 token. If the UID2 token is not refreshed before the refresh token expires, it becomes invalid.
1515

1616
## UID2 Tokens: Key Information
1717

1818
Here are some key points about UID2 tokens:
1919

2020
- The UID2 token is a unique value: no two UID2 tokens are the same.
2121
- UID2 tokens are case sensitive.
22-
- The token value is opaque: do not make any assumptions about the format or about the length of the string.
22+
- The token value is an <a href="glossary-uid#gl-opaque">opaque</a> string: do not make any assumptions about the format or length of the string.
2323
- 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).
2424
- The token has a limited life, but can be refreshed using the refresh token.
25-
- The token can be refreshed many times, to get a new UID2 token, as long as the UID2 token is always refreshed before the refresh token expires.
26-
- As an alternative to refreshing an existing UID2 token, you can always generate a new UID2 token from the original hashed or unhashed email address or phone number instead.
25+
- 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.
2726
- If the token has expired, or as an alternative to refreshing an existing token, you can always generate a new UID2 token from the original hashed or unhashed email address or phone number.
2827
- Publishers send UID2 tokens in the bidstream.
2928
- Refreshing a UID2 token does not invalidate/expire the original or previous UID2 token. You can still use the earlier token until it expires.
@@ -32,23 +31,21 @@ Here are some key points about UID2 tokens:
3231

3332
Here are some key points about refresh tokens:
3433

35-
- A refresh token is an opaque string that is issued along with the <a href="glossary-uid#gl-uid2-token">UID2 token</a>.
34+
- A refresh token is a string that is issued along with the <a href="glossary-uid#gl-uid2-token">UID2 token</a>.
3635
- Refresh tokens are case sensitive.
37-
- The token value is opaque: do not make any assumptions about the format or about the length of the string.
38-
- You can use the refresh token to generate a new UID2 token before the old one expires.
36+
- The token value is <a href="glossary-uid#gl-opaque">opaque</a>: do not make any assumptions about the format or length of the string.
37+
- You can use the refresh token to generate a new UID2 token and new refresh token before the current refresh token expires.
3938
- Using refresh tokens is optional: you could choose to generate a new token from DII each time rather than refreshing an existing token.
4039
- Token refresh can be managed in a variety of ways, such as:
4140
- With a UID2 SDK (see [SDK Functionality](../sdks/summary-sdks.md#sdk-functionality))
4241
- By calling the [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoint
4342
- By using the UID2 Prebid.js module (see [UID2 Integration Overview for Prebid.js](../guides/integration-prebid.md))
4443
- The [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoint does not require authentication with your UID2 credentials.
4544
- When a new UID2 token is generated and returned, a new refresh token is returned along with it.
46-
- As long as you refresh the token before it expires, you can refresh many times. There is no limit as long as the UID2 token and corresponding refresh token are valid.
47-
- If you refresh the token, and get a new token before the old one has expired, you can use either the new token or the old one, as long as you use a token that is still valid/has not expired.
48-
- 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).
45+
- 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).
4946
- 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).
5047

51-
## Recommended Token Refresh Frequency
48+
### Recommended Token Refresh Frequency
5249

5350
The recommended refresh interval is hourly.
5451

i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-tokens.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,20 @@ import Link from '@docusaurus/Link';
99

1010
# UID2 Tokens and Refresh Tokens
1111

12-
When a publisher sends a user's <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (email address or phone number) to the UID2 Operator, whether via one of the UID2 SDKs or the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) endpoint, the UID2 Operator returns a <a href="glossary-uid#gl-uid2-token">UID2 token</a> with associated values such as refresh token. The token is an opaque alphanumeric string. Every time a token is generated from DII input, the token value is different. Token values are never the same. Because of the way UID2 works, different instances of activity, on browsers, CTV, and electronic devices such as phone and tablets, can be matched without compromising the privacy of the individual. The token is designed so that it cannot be reverse engineered to arrive at the original email address or phone number.
12+
When a publisher sends a user's <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (email address or phone number) to the UID2 Operator, whether via one of the UID2 SDKs or the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) endpoint, the UID2 Operator returns a <a href="glossary-uid#gl-uid2-token">UID2 token</a> with associated values, including a refresh token. The token is an alphanumeric string. Each time a token is generated from DII input, the token value is different. Because of the way UID2 works, different instances of activity, on browsers, CTV, and electronic devices such as phone and tablets, can still be matched to the same <a href="glossary-uid#gl-raw-uid2">raw UID2</a> generated from the user's DII, even though the token might be different. The token is designed to protect against reverse engineering that might reveal the original email address or phone number.
1313

14-
For security reasons, the UID2 token has a short life. Along with the UID2 token, the UID2 Operator sends a <a href="glossary-uid#gl-refresh-token">refresh token</a> that the publisher can use to generate a new UID2 token. If the token is not refreshed before it expires, it becomes invalid and cannot be used for targeted advertising.
14+
The UID2 token has a short life. Along with the UID2 token, the UID2 Operator sends a <a href="glossary-uid#gl-refresh-token">refresh token</a> that the publisher can use to generate a new UID2 token. If the UID2 token is not refreshed before the refresh token expires, it becomes invalid.
1515

1616
## UID2 Tokens: Key Information
1717

1818
Here are some key points about UID2 tokens:
1919

2020
- The UID2 token is a unique value: no two UID2 tokens are the same.
2121
- UID2 tokens are case sensitive.
22-
- The token value is opaque: do not make any assumptions about the format or about the length of the string.
22+
- The token value is an <a href="glossary-uid#gl-opaque">opaque</a> string: do not make any assumptions about the format or length of the string.
2323
- 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).
2424
- The token has a limited life, but can be refreshed using the refresh token.
25-
- The token can be refreshed many times, to get a new UID2 token, as long as the UID2 token is always refreshed before the refresh token expires.
26-
- As an alternative to refreshing an existing UID2 token, you can always generate a new UID2 token from the original hashed or unhashed email address or phone number instead.
25+
- 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.
2726
- If the token has expired, or as an alternative to refreshing an existing token, you can always generate a new UID2 token from the original hashed or unhashed email address or phone number.
2827
- Publishers send UID2 tokens in the bidstream.
2928
- Refreshing a UID2 token does not invalidate/expire the original or previous UID2 token. You can still use the earlier token until it expires.
@@ -32,23 +31,21 @@ Here are some key points about UID2 tokens:
3231

3332
Here are some key points about refresh tokens:
3433

35-
- A refresh token is an opaque string that is issued along with the <a href="glossary-uid#gl-uid2-token">UID2 token</a>.
34+
- A refresh token is a string that is issued along with the <a href="glossary-uid#gl-uid2-token">UID2 token</a>.
3635
- Refresh tokens are case sensitive.
37-
- The token value is opaque: do not make any assumptions about the format or about the length of the string.
38-
- You can use the refresh token to generate a new UID2 token before the old one expires.
36+
- The token value is <a href="glossary-uid#gl-opaque">opaque</a>: do not make any assumptions about the format or length of the string.
37+
- You can use the refresh token to generate a new UID2 token and new refresh token before the current refresh token expires.
3938
- Using refresh tokens is optional: you could choose to generate a new token from DII each time rather than refreshing an existing token.
4039
- Token refresh can be managed in a variety of ways, such as:
4140
- With a UID2 SDK (see [SDK Functionality](../sdks/summary-sdks.md#sdk-functionality))
4241
- By calling the [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoint
4342
- By using the UID2 Prebid.js module (see [UID2 Integration Overview for Prebid.js](../guides/integration-prebid.md))
4443
- The [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoint does not require authentication with your UID2 credentials.
4544
- When a new UID2 token is generated and returned, a new refresh token is returned along with it.
46-
- As long as you refresh the token before it expires, you can refresh many times. There is no limit as long as the UID2 token and corresponding refresh token are valid.
47-
- If you refresh the token, and get a new token before the old one has expired, you can use either the new token or the old one, as long as you use a token that is still valid/has not expired.
48-
- 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).
45+
- 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).
4946
- 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).
5047

51-
## Recommended Token Refresh Frequency
48+
### Recommended Token Refresh Frequency
5249

5350
The recommended refresh interval is hourly.
5451

sidebars.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,9 +305,9 @@ const fullSidebar = [
305305
collapsed: true,
306306
items: [
307307
'ref-info/ref-operators-public-private',
308-
'ref-info/ref-server-side-token-generation',
309-
'ref-info/ref-tokens',
310308
'ref-info/ref-integration-approaches',
309+
'ref-info/ref-tokens',
310+
'ref-info/ref-server-side-token-generation',
311311
'summary-doc-v2',
312312
],
313313
},

0 commit comments

Comments
 (0)