Skip to content

Commit 8c5fe8c

Browse files
authored
Merge pull request #848 from IABTechLab/gwh-APIDOCS-2944-js-sdk-update-isloginrequired
JS SDK isLoginRequired, correction to response info
2 parents ae8eee6 + f3a2491 commit 8c5fe8c

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ As part of the SDK [initialization](#initopts-object-void), a token auto-refresh
100100
Here's what you need to know about the token auto-refresh:
101101

102102
- Only one call to the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint call can be active at a time.
103-
- If the [POST /token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer ([isLoginRequired()](#isloginrequired-boolean) returns `true`). In all other cases, auto-refresh attempts continue in the background.
103+
- If the [POST /token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again if the refresh token has expired, you must obtain the email or phone number from the consumer ([isLoginRequired()](#isloginrequired-boolean) returns `true`). If the user has opted out, take no further steps. In all other cases, auto-refresh attempts continue in the background.
104104
- The [callback function](#callback-function) specified during the SDK initialization is invoked in the following cases:
105105
- After each successful refresh attempt.
106106
- After an initial failure to refresh an expired advertising token.
@@ -282,7 +282,7 @@ This function can also provide additional context for handling missing identitie
282282

283283
| Value | Description |
284284
| :--- | :--- |
285-
| `true` | The identity is not available. This value indicates any of the following:<br/>- The user has opted out.<br/>- The refresh token has expired.<br/>- A first-party cookie is not available and no server-generated identity has been supplied. |
285+
| `true` | The identity is not available. This value indicates one of the following:<br/>- The refresh token has expired.<br/>- A first-party cookie is not available and no server-generated identity has been supplied. |
286286
| `false` | This value indicates one of the following:<br/>- The identity is present and valid.<br/>- The identity has expired, and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt. |
287287
| `undefined` | The SDK initialization is not yet complete. |
288288

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ As part of the SDK [initialization](#initopts-object-void), a token auto-refresh
158158
Here's what you need to know about the token auto-refresh:
159159

160160
- Only one token refresh call can be active at a time.
161-
- If the [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. In all other cases, auto-refresh attempts continue in the background.
161+
- If the [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again if the refresh token has expired, you must obtain the email or phone number from the consumer. If the user has opted out, take no further steps. In all other cases, auto-refresh attempts continue in the background.
162162
- All [callback functions](#callback-function) provided using the [Array Push Pattern](#array-push-pattern) are invoked in the following cases:
163163
- After each successful refresh attempt.
164164
- When identity has become invalid&#8212;for example, because the user has opted out.<br/>NOTE: The callback is *not* invoked when identity is temporarily unavailable and the auto-refresh keeps failing. In this case, the SDK continues using the existing advertising token as long as it hasn't expired.
@@ -438,8 +438,8 @@ Specifies whether a UID2 [POST&nbsp;/token/generate](../endpoints/post-token-gen
438438

439439
| Value | Description |
440440
| :--- | :--- |
441-
| `true` | The identity is not available. This value indicates any of the following:<ul><li>The user has opted out.</li><li>The refresh token has expired.</li><li>A first-party cookie is not available and no server-generated identity has been supplied.</li></ul> |
442-
| `false` | This value indicates one of the following:<ul><li>The identity is present and valid.</li><li>The identity has expired (but the refresh token has not expired), and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
441+
| `true` | The identity is not available. This value indicates one of the following:<ul><li>The refresh token has expired.</li><li>A first-party cookie is not available and no server-generated identity has been supplied.</li></ul> |
442+
| `false` | This value indicates one of the following:<ul><li>The identity is present and valid.</li><li>The identity is present, but cannot be used for UID2 because the user has opted out.</li><li>The identity has expired (but the refresh token has not expired), and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
443443

444444
### isIdentityAvailable(): boolean
445445

@@ -458,8 +458,8 @@ If false, a UID2 [POST&nbsp;/token/generate](../endpoints/post-token-generate.md
458458

459459
| Value | Description |
460460
| :--- | :--- |
461-
| `true` | This value indicates one of the following:<ul><li> The identity is present and valid in a first-party cookie or local storage.</li><li> The identity has expired, and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
462-
| `false` | This value indicates any of the following:<ul><li> The user has opted out.</li><li> The identity is present, but the refresh token has expired.</li><li> The identity has expired, even if the refresh token is still valid.</li><li> A first-party cookie is not available and no server-generated identity has been supplied. </li></ul> |
461+
| `true` | This value indicates one of the following:<ul><li>The identity is present and valid in a first-party cookie or local storage.</li><li>The identity is present, but cannot be used for UID2 because the user has opted out.</li><li>The identity has expired, and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
462+
| `false` | This value indicates any of the following:<ul><li>The identity is present, but the refresh token has expired.</li><li>The identity has expired, even if the refresh token is still valid.</li><li>A first-party cookie is not available and no server-generated identity has been supplied. </li></ul> |
463463

464464
### disconnect(): void
465465

docs/sdks/sdk-ref-javascript.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ As part of the SDK [initialization](#initopts-object-void), a token auto-refresh
157157
Here's what you need to know about the token auto-refresh:
158158

159159
- Only one token refresh call can be active at a time.
160-
- If the [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. In all other cases, auto-refresh attempts continue in the background.
160+
- If the [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again if the refresh token has expired, you must obtain the email or phone number from the consumer. If the user has opted out, take no further steps. In all other cases, auto-refresh attempts continue in the background.
161161
- All [callback functions](#callback-function) provided using the [Array Push Pattern](#array-push-pattern) are invoked in the following cases:
162162
- After each successful refresh attempt.
163163
- When identity has become invalid&#8212;for example, because the user has opted out.<br/>NOTE: The callback is *not* invoked when identity is temporarily unavailable and the auto-refresh keeps failing. In this case, the SDK continues using the existing advertising token as long as it hasn't expired.
@@ -421,8 +421,8 @@ Specifies whether a UID2 [POST&nbsp;/token/generate](../endpoints/post-token-gen
421421

422422
| Value | Description |
423423
| :--- | :--- |
424-
| `true` | The identity is not available. This value indicates any of the following:<ul><li>The user has opted out.</li><li>The refresh token has expired.</li><li>A first-party cookie is not available and no server-generated identity has been supplied.</li></ul> |
425-
| `false` | This value indicates one of the following:<ul><li>The identity is present and valid.</li><li>The identity has expired (but the refresh token has not expired), and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
424+
| `true` | The identity is not available. This value indicates one of the following:<ul><li>The refresh token has expired.</li><li>A first-party cookie is not available and no server-generated identity has been supplied.</li></ul> |
425+
| `false` | This value indicates one of the following:<ul><li>The identity is present and valid.</li><li>The identity is present, but cannot be used for UID2 because the user has opted out.</li><li>The identity has expired (but the refresh token has not expired), and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
426426

427427
### isIdentityAvailable(): boolean
428428

@@ -439,8 +439,8 @@ If false, a UID2 [POST&nbsp;/token/generate](../endpoints/post-token-generate.md
439439

440440
| Value | Description |
441441
| :--- | :--- |
442-
| `true` | This value indicates one of the following:<ul><li> The identity is present and valid in a first-party cookie or local storage.</li><li> The identity has expired, and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
443-
| `false` | This value indicates any of the following:<ul><li> The user has opted out.</li><li> The identity is present, but the refresh token has expired.</li><li> The identity has expired, even if the refresh token is still valid.</li><li> A first-party cookie is not available and no server-generated identity has been supplied. </li></ul> |
442+
| `true` | This value indicates one of the following:<ul><li>The identity is present and valid in a first-party cookie or local storage.</li><li>The identity is present, but cannot be used for UID2 because the user has opted out.</li><li>The identity has expired, and the token was not refreshed due to an intermittent error. The identity might be restored after a successful auto-refresh attempt.</li></ul> |
443+
| `false` | This value indicates any of the following:<ul><li>The identity is present, but the refresh token has expired.</li><li>The identity has expired, even if the refresh token is still valid.</li><li>A first-party cookie is not available and no server-generated identity has been supplied. </li></ul> |
444444

445445
### disconnect(): void
446446

i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ UID2 [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) 呼び出
283283

284284
| Value | Description |
285285
| :--- | :--- |
286-
| `true` | ID が利用できません。この値は以下のいずれかを示します:<br/>- ユーザーがオプトアウトした。<br/>- Refresh token の有効期限が切れた。<br/>- ファーストパーティクッキーは利用できず、サーバーで生成した ID も提供されていません。 |
286+
| `true` | ID が利用できません。この値は以下のいずれかを示します:<br/>- Refresh token の有効期限が切れた。<br/>- ファーストパーティクッキーは利用できず、サーバーで生成した ID も提供されていません。 |
287287
| `false` | この値は以下のいずれかを示します:<br/>- ID が存在し、有効。<br/>- ID の有効期限が切れており、断続的なエラーによりトークンがリフレッシュされなかった。<br/>- ID の有効期限が切れており、断続的なエラーによりトークンがリフレッシュされなかった。 |
288288
| `undefined` | SDK の初期化はまだ完了していません。 |
289289

i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ UID2 ログイン [POST&nbsp;/token/generate](../endpoints/post-token-generate.
429429

430430
| Value | Description |
431431
| :--- | :--- |
432-
| `true` | ID が利用できません。この値は以下のいずれかを示します:<ul><li>ユーザーがオプトアウトした。</li><li>Refresh token の有効期限が切れた。</li><li>ファーストパーティクッキーは利用できず、サーバーで生成した ID も提供されていません。</li></ul> |
432+
| `true` | ID が利用できません。この値は以下のいずれかを示します:<ul><li>Refresh token の有効期限が切れた。</li><li>ファーストパーティクッキーは利用できず、サーバーで生成した ID も提供されていません。</li></ul> |
433433
| `false` | この値は以下のいずれかを示します:<ul><li>ID が存在し、有効。</li><li>ID の有効期限が切れており、断続的なエラーによりトークンがリフレッシュされなかった。</li><li>ID の有効期限が切れており、断続的なエラーによりトークンがリフレッシュされなかった。</li></ul> |
434434

435435
### isIdentityAvailable(): boolean

i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ UID2 ログイン [POST&nbsp;/token/generate](../endpoints/post-token-generate.
421421

422422
| Value | Description |
423423
| :--- | :--- |
424-
| `true` | ID が利用できません。この値は以下のいずれかを示します:<ul><li>ユーザーがオプトアウトした。</li><li>Refresh token の有効期限が切れた。</li><li>ファーストパーティクッキーは利用できず、サーバーで生成した ID も提供されていません。</li></ul> |
424+
| `true` | ID が利用できません。この値は以下のいずれかを示します:<ul><li>Refresh token の有効期限が切れた。</li><li>ファーストパーティクッキーは利用できず、サーバーで生成した ID も提供されていません。</li></ul> |
425425
| `false` | この値は以下のいずれかを示します:<ul><li>ID が存在し、有効。</li><li>ID の有効期限が切れており、断続的なエラーによりトークンがリフレッシュされなかった。</li><li>ID の有効期限が切れており、断続的なエラーによりトークンがリフレッシュされなかった。</li></ul> |
426426

427427
### isIdentityAvailable(): boolean

0 commit comments

Comments
 (0)