Skip to content

Ian UI d2 2011 change policy to optout check #18

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Ian UI d2 2011 change policy to optout check #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6d0b296
change policy to optout check
Ian-Nara Oct 11, 2023
2a7508b
small fix
Ian-Nara Oct 11, 2023
24fcf59
update history section
Ian-Nara Oct 11, 2023
72f0de7
update history section
Ian-Nara Oct 11, 2023
9a80329
improve test
Ian-Nara Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ print(decrypted_token.uid2)

>IMPORTANT: Be sure to call this function only when you have obtained legal basis to convert the user’s [directly identifying information (DII)](https://unifiedid.com/docs/ref-info/glossary-uid#gl-dii) to UID2 tokens for targeted advertising.

>`do_not_generate_tokens_for_opted_out()` applies `policy=1` in the [/token/generate](https://unifiedid.com/docs/endpoints/post-token-generate#token-generation-policy) call. Without this, `policy` is omitted to maintain backwards compatibility.
>`do_not_generate_tokens_for_opted_out()` applies `optout_check=1` in the [/token/generate](https://unifiedid.com/docs/endpoints/post-token-generate) call. Without this, `optout_check` is omitted to maintain backwards compatibility.

### Standard Integration

Expand Down Expand Up @@ -175,3 +175,6 @@ make example_auto_refresh BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key
### 2.2.0 (07/26/2023)
* Added support for /token/generate
* Added support for /token/refresh

### 2.3.0 (10/11/2023)
* Update from deprecated "policy" parameter to "optout_check" parameter
2 changes: 2 additions & 0 deletions tests/test_publisher_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import json
import os
import unittest

Expand Down Expand Up @@ -56,6 +57,7 @@ def test_integration_optout_generate_token(self):
publisher_client = Uid2PublisherClient(self.EUID_BASE_URL, self.EUID_API_KEY, self.EUID_SECRET_KEY)
tc_string = "CPhJRpMPhJRpMABAMBFRACBoALAAAEJAAIYgAKwAQAKgArABAAqAAA"
input = TokenGenerateInput.from_email("optout@example.com").do_not_generate_tokens_for_opted_out().with_transparency_and_consent_string(tc_string)
self.assertEqual(1, json.loads(input.get_as_json_string())['optout_check'])
token_generate_response = publisher_client.generate_token(input)
self.assertTrue(token_generate_response.is_optout())
self.assertFalse(token_generate_response.is_success())
Expand Down
2 changes: 1 addition & 1 deletion uid2_client/token_generate_input.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def _create_json_request_for_generate_token(property, value, tc_string, generate
if tc_string is not None:
json_object["tcf_consent_string"] = tc_string
if not generate_for_opted_out:
json_object["policy"] = 1
json_object["optout_check"] = 1
Copy link
Contributor

@asloobq asloobq Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a unit test for this change ?

Copy link
Contributor Author

@Ian-Nara Ian-Nara Oct 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A test exists at test_publisher_client#test_integration_optout_generate_token that will make sure it stil works after this change.

return json.dumps(json_object)

def create_hashed_json_request_for_generate_token(self):
Expand Down