Skip to content

Commit f1af16c

Browse files
genwhittTTDgenwhittTTD
authored
Merge pull request #718 from IABTechLab/gwh-PIDOCS-2611-time-values-clarify
add glossary def for Unix time
2 parents 1bb8d10 + 8b12787 commit f1af16c

File tree

11 files changed

+24
-20
lines changed

11 files changed

+24
-20
lines changed

‎docs/endpoints/post-optout-status.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ The response body includes the following properties.
107107
| Property | Format | Description |
108108
| :--- | :--- | :--- |
109109
| `advertising_id` | string | The <Link href="../ref-info/glossary-uid#gl-advertising-id">advertising ID</Link> (raw UID2). |
110-
| `opted_out_since` | number | The UNIX timestamp (in milliseconds) that indicates when the raw UID2 was opted out. |
110+
| `opted_out_since` | number | The <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> timestamp (in milliseconds) that indicates when the raw UID2 was opted out. |
111111

112112
### Response Status Codes
113113

‎docs/endpoints/post-token-generate.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ The response body includes the properties shown in the following table.
125125
| :--- | :--- | :--- |
126126
| `advertising_token` | string | An encrypted advertising (UID2) token for the user. |
127127
| `refresh_token` | string | An encrypted token that can be exchanged with the UID2 Service for the latest set of identity tokens. |
128-
| `identity_expires` | number | The UNIX timestamp (in milliseconds) that indicates when the advertising token expires. |
129-
| `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.<br/>TIP: If you are not using the SDK, consider refreshing the UID2 token from this timestamp, too. |
130-
| `refresh_expires` | number | The UNIX timestamp (in milliseconds) that indicates when the refresh token expires. |
128+
| `identity_expires` | number | The <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> timestamp (in milliseconds) that indicates when the advertising token expires. |
129+
| `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.<br/>TIP: If you are not using the SDK, consider refreshing the UID2 token from this timestamp, too. |
130+
| `refresh_expires` | number | The Unix timestamp (in milliseconds) that indicates when the refresh token expires. |
131131
| `refresh_response_key` | string | A key to be used in a [POST&nbsp;/token/refresh](post-token-refresh.md) request for response decryption. |
132132

133133
### Response Status Codes

‎docs/endpoints/post-token-refresh.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,9 @@ The response body includes the properties shown in the following table.
9999
| :--- | :--- | :--- |
100100
| `advertising_token` | string | The <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> (also known as advertising token) for the user. |
101101
| `refresh_token` | string | An encrypted token that can be exchanged with the UID2 Service for the latest set of identity tokens. |
102-
| `identity_expires` | number | The UNIX timestamp (in milliseconds) that indicates when the UID2 token expires. |
103-
| `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, if the SDK is in use.<br/>TIP: If you are not using the SDK, consider refreshing the UID2 token from this timestamp, too. |
104-
| `refresh_expires` | number | The UNIX timestamp (in milliseconds) that indicates when the refresh token expires. |
102+
| `identity_expires` | number | The <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> timestamp (in milliseconds) that indicates when the UID2 token expires. |
103+
| `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, if the SDK is in use.<br/>TIP: If you are not using the SDK, consider refreshing the UID2 token from this timestamp, too. |
104+
| `refresh_expires` | number | The Unix timestamp (in milliseconds) that indicates when the refresh token expires. |
105105
| `refresh_response_key` | string | A key to be used in a new [POST&nbsp;/token/refresh](post-token-refresh.md) request for response decryption. |
106106

107107
### Response Status Codes

‎docs/getting-started/gs-encryption-decryption.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The following table describes the field layout for request encryption code.
5757

5858
| Offset (Bytes) | Size (Bytes) | Description |
5959
| :--- | :--- | :--- |
60-
| 0 | 8 | The UNIX timestamp (in milliseconds). Must be int64 big endian. |
60+
| 0 | 8 | The <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> timestamp (in milliseconds). Must be int64 big endian. |
6161
| 8 | 8 | Nonce: Random 64 bits of data used to help protect against replay attacks. The corresponding [Unencrypted Response Data Envelope](#unencrypted-response-data-envelope) should contain the same nonce value for the response to be considered valid. |
6262
| 16 | N | Payload, which is a request JSON document serialized in UTF-8 encoding. |
6363

@@ -96,7 +96,7 @@ The following table describes the field layout for response decryption code.
9696

9797
| Offset (Bytes) | Size (Bytes) | Description |
9898
| :--- | :--- | :--- |
99-
| 0 | 8 | The UNIX timestamp (in milliseconds). Must be int64 big endian. |
99+
| 0 | 8 | The Unix timestamp (in milliseconds). Must be int64 big endian. |
100100
| 8 | 8 | Nonce. For the response to be considered valid, this should match the nonce in the [unencrypted request data envelope](#unencrypted-request-data-envelope). |
101101
| 16 | N | Payload, which is a response JSON document serialized in UTF-8 encoding. |
102102

‎docs/ref-info/glossary-uid.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,10 @@ import Link from '@docusaurus/Link';
471471
<dt><MdxJumpAnchor id="gl-unified-id-20"><a href="#gl-unified-id-20">Unified ID 2.0</a></MdxJumpAnchor></dt>
472472
<dd>The term UID2 can be used to mean the <a href="#gl-uid2-framework">UID2 framework</a>, the <a href="#gl-uid2-service">UID2 service</a>, a <a href="#gl-raw-uid2">raw UID2</a>, or a <a href="#gl-uid2-token">UID2 token</a> (advertising token).</dd>
473473

474+
<dt><MdxJumpAnchor id="gl-unix-time"><a href="#gl-unix-time">Unix time</a></MdxJumpAnchor></dt>
475+
<dd>Unix time, also called Epoch time, is defined as the number of seconds since 00:00:00 <a href="#gl-utc">UTC</a> on Thursday, 1 January 1970. Unix time is used in some UID2 response messages, expressed in milliseconds: for example, in the response to the `POST&nbsp;/token/refresh` endpoint (see <a href="../endpoints/post-token-refresh#successful-response-with-tokens">Successful Response With Tokens</a>).</dd>
476+
<dd>Example: 1 January 2024, 9:00:00 AM GMT, expressed in Unix time, is `1704067200`. In milliseconds it is: `1704067200000`.</dd>
477+
474478
<dt><MdxJumpAnchor id="gl-utc"><a href="#gl-utc">UTC</a></MdxJumpAnchor></dt>
475479
<dd>UTC is an abbreviation for Coordinated Universal Time, also called Zulu time, which is the primary time standard in general use. UTC essentially equates to Greenwich Mean Time (GMT), but is more scientifically precise.</dd>
476480

‎docs/ref-info/ref-tokens.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Here are some key points about refresh tokens:
4949

5050
The recommended refresh interval is hourly.
5151

52-
To determine when to refresh, you can use the timestamp of the `refresh_from` field in the response to the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful Response](../endpoints/post-token-generate.md#successful-response)) or [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoint (see [Successful Response With Tokens](../endpoints/post-token-refresh.md#successful-response-with-tokens)). The value of this field is a timestamp in UNIX time, expressed in milliseconds.
52+
To determine when to refresh, you can use the timestamp of the `refresh_from` field in the response to the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful Response](../endpoints/post-token-generate.md#successful-response)) or [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoint (see [Successful Response With Tokens](../endpoints/post-token-refresh.md#successful-response-with-tokens)). The value of this field is a timestamp in Unix time, expressed in milliseconds.
5353

5454
### Managing Token Refresh with an SDK
5555

‎i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-optout-status.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ echo '{"advertising_ids": ["ufv1uGRovNiJNbJqiE/xzM+aKE7jP69MgspOZoEQ3xc="]}' | p
107107
| Property | Format | Description |
108108
| :--- | :--- | :--- |
109109
| `advertising_id` | string | <Link href="../ref-info/glossary-uid#gl-advertising-id">Advertising ID</Link> (raw UID2). |
110-
| `opted_out_since` | number | raw UID2 がいつオプトアウトされたかを示す UNIX timestamp (ミリ秒単位)。 |
110+
| `opted_out_since` | number | raw UID2 がいつオプトアウトされたかを示す Unix timestamp (ミリ秒単位)。 |
111111

112112
### Response Status Codes
113113

‎i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-generate.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=","optout_chec
125125
| :--- | :--- | :--- |
126126
| `advertising_token` | string | ユーザーの暗号化された Advertising Token (UID2) です。 |
127127
| `refresh_token` | string | UID2 Service と最新の identity トークンのセットを交換できる暗号化されたトークンです。 |
128-
| `identity_expires` | number | Advertising Token の有効期限を示す UNIX タイムスタンプ (ミリ秒単位) です。 |
129-
| `refresh_from` | number | SDK for JavaScript ([SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照してください) が UID2 Token のリフレッシュを開始するタイミングを示す UNIX タイムスタンプ(ミリ秒単位)。<br/>TIP: SDK を使用していない場合は、このタイムスタンプから UID2 Token もリフレッシュすることを検討してください。|
130-
| `refresh_expires` | number | Refresh Token の有効期限を示す UNIX タイムスタンプ (ミリ秒単位) です。 |
128+
| `identity_expires` | number | Advertising Token の有効期限を示す Unix タイムスタンプ (ミリ秒単位) です。 |
129+
| `refresh_from` | number | SDK for JavaScript ([SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照してください) が UID2 Token のリフレッシュを開始するタイミングを示す Unix タイムスタンプ(ミリ秒単位)。<br/>TIP: SDK を使用していない場合は、このタイムスタンプから UID2 Token もリフレッシュすることを検討してください。|
130+
| `refresh_expires` | number | Refresh Token の有効期限を示す Unix タイムスタンプ (ミリ秒単位) です。 |
131131
| `refresh_response_key` | string | [POST&nbsp;/token/refresh](post-token-refresh.md) リクエストでレスポンス復号化のために使用される鍵です。 |
132132

133133
### Response Status Codes

‎i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-refresh.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,9 @@ Used by: このエンドポイントは、主にパブリッシャーが使用
9999
| :--- | :--- | :--- |
100100
| `advertising_token` | string | ユーザーの <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> (Advertising Token とも呼ばれます) です。 |
101101
| `refresh_token` | string | UID2 Service と最新の ID トークンのセットを交換できる暗号化されたトークンです。 |
102-
| `identity_expires` | number | UID2 Token の有効期限を示す UNIX タイムスタンプ (ミリ秒単位) です。 |
103-
| `refresh_from` | number | SDK for JavaScript ([SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照してください) が UID2 Token のリフレッシュを開始するタイミングを示す UNIX タイムスタンプ(ミリ秒単位)。<br/>TIP: SDK を使用していない場合は、このタイムスタンプから Advertising Token もリフレッシュすることを検討してください。|
104-
| `refresh_expires` | number | Refresh Token の有効期限を示す UNIX タイムスタンプ(ミリ秒単位)。 |
102+
| `identity_expires` | number | UID2 Token の有効期限を示す Unix タイムスタンプ (ミリ秒単位) です。 |
103+
| `refresh_from` | number | SDK for JavaScript ([SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照してください) が UID2 Token のリフレッシュを開始するタイミングを示す Unix タイムスタンプ(ミリ秒単位)。<br/>TIP: SDK を使用していない場合は、このタイムスタンプから Advertising Token もリフレッシュすることを検討してください。|
104+
| `refresh_expires` | number | Refresh Token の有効期限を示す Unix タイムスタンプ(ミリ秒単位)。 |
105105
| `refresh_response_key` | string | [POST&nbsp;/token/refresh](post-token-refresh.md) リクエストでレスポンス復号化のために使用される鍵です。 |
106106

107107
### Response Status Codes

‎i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-encryption-decryption.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ UID2 API のリクエストレスポンスワークフローは、以下のス
5757

5858
| Offset (Bytes) | Size (Bytes) | Description |
5959
| :--- | :--- | :--- |
60-
| 0 | 8 | UNIX タイムスタンプ (ミリ秒単位) です。int64 のビッグエンディアンでなければなりません。 |
60+
| 0 | 8 | Unix タイムスタンプ (ミリ秒単位) です。int64 のビッグエンディアンでなければなりません。 |
6161
| 8 | 8 | Nonce: リプレイ攻撃から保護するために使用されるランダムな 64 ビットのデータです。対応する [復号化済みレスポンスデータエンベローブ](#unencrypted-response-data-envelope) には、レスポンスが有効とみなされるために同じ nonce 値が含まれていなければなりません。 |
6262
| 16 | N | UTF-8 エンコーディングでシリアライズされたリクエスト JSON ドキュメントをペイロードとします。 |
6363

@@ -96,7 +96,7 @@ UID2 API のリクエストレスポンスワークフローは、以下のス
9696

9797
| Offset (Bytes) | Size (Bytes) | Description |
9898
| :--- | :--- | :--- |
99-
| 0 | 8 | UNIX タイムスタンプ (ミリ秒単位) です。int64 のビッグエンディアンでなければなりません。 |
99+
| 0 | 8 | Unix タイムスタンプ (ミリ秒単位) です。int64 のビッグエンディアンでなければなりません。 |
100100
| 8 | 8 | Nonce: レスポンスが有効であるとみなされるためには、これは [暗号化前リクエストデータエンベローブ](#unencrypted-request-data-envelope) の nonce と一致する必要があります。 |
101101
| 16 | N | UTF-8 エンコーディングでシリアライズされたレスポンス JSON ドキュメントをペイロードとします。 |
102102

0 commit comments

Comments
 (0)