Skip to content

Commit 6d25c50

Browse files
authored
Merge pull request #750 from IABTechLab/gwh-APIDOCS-2748-refresh-token-time-copy-mod
updates re token refresh recommended period
2 parents 3403272 + 0bf43d6 commit 6d25c50

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

docs/ref-info/ref-tokens.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,18 @@ Here are some key points about refresh tokens:
4747

4848
### Recommended Token Refresh Frequency
4949

50-
The recommended refresh interval is hourly.
50+
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.
5151

52-
To determine when to refresh, you can use the timestamp of the `refresh_from` field in the response to the [POST /token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful Response](../endpoints/post-token-generate.md#successful-response)) or [POST /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 a call to one of the following UID2 API endpoints:
53+
54+
- [POST /token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful Response](../endpoints/post-token-generate.md#successful-response))
55+
- [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint (see [Successful Response With Tokens](../endpoints/post-token-refresh.md#successful-response-with-tokens))
56+
57+
The `refresh_from` field is a <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> timestamp, and the value is one hour from the time that the token was generated, expressed in milliseconds.
58+
59+
:::tip
60+
The recommended refresh interval could change in the future. Rather than using a fixed value, it's best to calculate based on the `refresh_from` value.
61+
:::
5362

5463
### Managing Token Refresh with an SDK
5564

0 commit comments

Comments
 (0)