-
Notifications
You must be signed in to change notification settings - Fork 50
Update docs for removal of optout_check #985
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
swibi-ttd
commented
Feb 9, 2026
- Remove optout_check from JSON body parameters
- Remove deprecated optout_check functions from Python/Java SDK examples
docs/sdks/sdk-ref-java.md
Outdated
|
|
||
| - --> 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](../endpoints/post-token-generate.md#unencrypted-json-body-parameters)). | ||
| ::: | ||
| <!-- :::important |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious why we are keeping this but commented out?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No particular reason, I just left it in case it was important to keep track of the UID2 vs EUID diffs.
Edit: I've removed the comments
docs/sdks/sdk-ref-python.md
Outdated
| ::: | ||
| ::: --> | ||
|
|
||
| <!-- uid2_euid_diff re legal basis for admonition above (not in UID2) --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this still a difference between UID2 and EUID? Or are they now the same? If so we could make them the same and remove this comment (in both).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Be sure to call this endpoint only when you have a legal basis to convert the user’s personal data to an EUID token for targeted advertising.
^ This part is still only in the EUID docs
EDIT: I've removed the comments indicating EUID diff
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to identify differences... it just needs to be clear.
genwhittTTD
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Couple of comments.
| The `optout_check` parameter, required with a value of `1`, checks whether the user has opted out. | ||
| ::: | ||
|
|
||
| <!-- uid2_euid_diff re legal basis for admonition above --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@swibi-ttd is there no longer a difference between UID2 and EUID WRT the optout check?
This comment, line 19, relates to the admonition ("important" tag) which you've removed -- so it doesn't make sense to leave the comment there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep there's no difference WRT the optout check. I've removed the admonition comment
docs/ref-info/updates-doc.md
Outdated
|
|
||
| The following documents were released in the first quarter of 2026. | ||
|
|
||
| <CustomTagsContainer tags="Endpoints, SDKs"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is also a tag "Opt-Out" (see APIDOCS-1739 in the file) so use that one as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the "Opt-Out" tag
docs/sdks/sdk-ref-java.md
Outdated
| - Be sure to call the POST /token/generate endpoint only when you have a legal basis to convert the user’s <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> to UID2 tokens for targeted advertising. | ||
| ::: --> | ||
|
|
||
| <!-- uid2_euid_diff re legal basis for admonition above (first bullet not in UID2) --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment wording needs update to be clear, since there is now one bullet (bullet not needed but no worries). Suggest:
As background... UID2 and EUID are different repos, and since they use a lot of the same technology, with some key differences, it's really important to keep them in sync but it isn't a simple copy/paste. I'll send you a link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "Be sure to call the..." part has since been removed, and I've also removed the uid2_euid_diff comment as this section now only exists in the EUID docs. Is that fine?
genwhittTTD
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We just needed to update the comments rather than remove them. Sorry I didn't make an exact suggestion but I didn't have both repos in front of me to see the picture clearly.
With that it's good to go. The rest is great. Just one empty line before and after comments please.
Reinstate uid2_euid_diff comment Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Reinstate uid2_euid_diff comment Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
genwhittTTD
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM -- Thanks much.