mods to Java SDK doc to add publisher info #428
Conversation
docs/sdks/uid2-sdk-ref-java.md
Outdated
| :::important | ||
| <ul><li>Be sure to call this function only when you have obtained legal basis to convert the user’s [directly identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) to UID2 tokens for targeted advertising.</li></ul> | ||
|
|
||
| <ul><li>Always apply `doNotGenerateTokensForOptedOut()`. This applies `policy=1` in the [/token/generate](../endpoints/post-token-generate.md#token-generation-policy) call. Support for `policy=0` will be removed soon. (**GWH_SW01 to adjust this here + in the repo pending input. Readme line 53**)</li></ul> |
There was a problem hiding this comment.
Support for policy=0 will be removed soon. can be omitted.
The rest can stay as is
There was a problem hiding this comment.
Maybe tweak this to:
Always apply doNotGenerateTokensForOptedOut(). This applies a param similar to setting optout_check=1 in the /token/generate call.
policy=1 is not documented on the endpoint doc any more so we best not to say it. But i am trying to say doNOtGenerateTokensForOptedOut will apply policy=1 which has same effect as optout_check=1 so reader don't need to care about underlying implementation detail but just call the function. But maybe add something like:
Not calling this doNOtGenerateTokensForOptedOut method is only available for early UID2 participants.
(and don't even mention policy=0 as they probably dunno what that is)
Applies this to comment further below too.
There was a problem hiding this comment.
@sunnywu I fixed it to this (2 instances here, 2 in the repo readme):
IMPORTANT: Always apply doNotGenerateTokensForOptedOut(). This applies a parameter similar to setting optout_check=1 in the call to the POST /token/generate endpoint (see Unencrypted JSON Body Parameters).
I'd prefer to leave out the other part about early UID2 participants. Would you be OK with that? If you feel strongly that we should include it let me know. Thx!
There was a problem hiding this comment.
I'm ok either way but if the early participants change something and they wanna update the vesion of sdk, they need to know to call doNotGenerateTokensForOptedOut() hence my rationale. Yeh maybe don't mention it for now.
There was a problem hiding this comment.
@sunny thank you. Merging.
docs/sdks/uid2-sdk-ref-java.md
Outdated
|
|
||
| #### Standard Integration | ||
|
|
||
| If you're using standard integration (client and server) (see [UID2 SDK for JavaScript Integration Guide](../guides/publisher-client-side.md)), follow this step: (**GWH_SW02 not sure is this doc link correct, should we link to the client doc, or to both? Same in repo.**) |
There was a problem hiding this comment.
There was a problem hiding this comment.
Done, two instances in this file and two instances in the repo readme, thx.
docs/sdks/uid2-sdk-ref-java.md
Outdated
| :::important | ||
| - Be sure to call this endpoint only when you have obtained legal basis to convert the user’s [directly identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) to UID2 tokens for targeted advertising. | ||
|
|
||
| - Always apply `doNotGenerateTokensForOptedOut()`. This applies `policy=1` in the [/token/generate](../endpoints/post-token-generate.md#token-generation-policy) call. Support for `policy=0` will be removed soon. (**GWH_SW03 same comment as earlier occurrence.**) |
There was a problem hiding this comment.
Again just remove
Support for policy=0 will be removed soon.
There was a problem hiding this comment.
Addressed same as your earlier comment, see query, thx.
docs/sdks/uid2-sdk-ref-java.md
Outdated
|
|
||
| #### Standard Integration | ||
|
|
||
| If you're using standard integration (client and server) (see [UID2 SDK for JavaScript Integration Guide](../guides/publisher-client-side.md)): (**GWH_SW04 should this link to the client-side doc?**) |
There was a problem hiding this comment.
again it's the standard guide doc
http://localhost:3006/docs/guides/integration-javascript-standard
There was a problem hiding this comment.
Done, two instances in this file and two instances in the repo readme, thx.
mods to Java SDK doc to add publisher info