Skip to content

add better disclaimers across all readmes and example sites #201

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

Merged
eiman-eltigani-ttd merged 7 commits into from
Jul 1, 2025
Merged

add better disclaimers across all readmes and example sites #201

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
33ea23e
add better disclaimers across all readmes and example sites
eiman-eltigani-ttd Jul 1, 2025
05ff19a
switched button names and removed redundant disclaimer
eiman-eltigani-ttd Jul 1, 2025
8a253df
replace submit in read me with correct label
eiman-eltigani-ttd Jul 1, 2025
8fd65b4
make sure all ReadMes are updated with generate uid2
eiman-eltigani-ttd Jul 1, 2025
42f3136
change value labels for remaining sites
eiman-eltigani-ttd Jul 1, 2025
82280e2
update last sentence in disclaimer
eiman-eltigani-ttd Jul 1, 2025
753429e
update securesignalsapp labels + check readme
eiman-eltigani-ttd Jul 1, 2025
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
7 changes: 5 additions & 2 deletions examples/cstg/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK</h1
>Client-Side Integration Guide for JavaScript
</a>
to implement UID2 integration and generate UID2 tokens.
<strong>Note:</strong> This is a <em>test-only</em> integration environment—not for production
use. It does not perform real user authentication or generate production-level tokens. Do not
connect this site to real user traffic.
</p>
<table id="uid2_state">
<tr>
Expand Down Expand Up @@ -134,11 +137,11 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK</h1
value="[email protected]"
/>
</div>
<div><button type="button" class="button" id="login">Log In</button>></div>
<div><button type="button" class="button" id="login">Generate UID2</button>></div>
</div>
<div id="logout_form" style="display: none" class="form">
<form>
<button type="button" class="button" id="logout">Log Out</button>
<button type="button" class="button" id="logout">Clear UID2</button>
</form>
</div>
</body>
Expand Down
20 changes: 10 additions & 10 deletions examples/google-secure-signals-integration/client_side/README.md
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions examples/google-secure-signals-integration/client_side/views/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK, Se
<a href="https://unifiedid.com/docs/guides/integration-javascript-client-side">Client-Side Integration Guide for JavaScript</a> to implement UID2 integration and generate UID2 tokens.
Secure Signals is updated when the page is reloaded.
Reload the page in order to update Secure Signals in local storage.
<strong>Note:</strong> This is a <em>test-only</em> integration environment—not for production use.
It does not perform real user authentication or generate production-level tokens.
Do not connect this site to real user traffic.
</p>
<div id="page-content">
<div id="video-container">
Expand Down Expand Up @@ -71,11 +74,11 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK, Se
value="[email protected]"
/>
</div>
<div><button type="button" class="button" id="login">Log In</button>></div>
<div><button type="button" class="button" id="login">Generate UID2</button></div>
</div>
<div id="logout_form" style="display: none" class="form">
<form>
<button type="button" class="button" id="logout">Log Out</button>
<button type="button" class="button" id="logout">Clear UID2</button>
</form>
</div>
<script src="https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js"></script>
Expand Down
20 changes: 10 additions & 10 deletions examples/google-secure-signals-integration/react_client_side/README.md
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions examples/google-secure-signals-integration/server_side/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ step is omitted, and the login process focuses on integration with the UID2 serv

The following table outlines and annotates the steps you can take to test and explore the example application.

| Step | Description | Comments |
| :--: | :--------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1 | In your browser, navigate to the application main page at `http://localhost:3000`. | The displayed main (index) page of the example application provides a [login form](views/login.html) for the user to complete the UID2 login process.</br>IMPORTANT: A real-life application must also display a form for the user to consent to targeted advertising. |
| 2 | Enter the email address that you want to use for testing and click **Log In**. | The click calls the Secure Signal [`clearAllCache()`](https://developers.google.com/publisher-tag/reference#googletag.secureSignals.SecureSignalProvidersArray_clearAllCache) function, to clear all cached signals from local storage, and then calls the `/login` endpoint ([server.js](server.js)). The login initiated on the server side then calls the [POST /token/generate](https://unifiedid.com/docs/endpoints/post-token-generate) endpoint and processes the received response. |
| | The main page updates to display the established UID2 identity information and a video player. | The displayed identity information is the `body` property of the [JSON response payload](https://unifiedid.com/docs/endpoints/post-token-generate#decrypted-json-response-format) from the successful `POST /token/generate` response. If the response is successful, the returned identity is saved to a session cookie (a real-world application would use a different way to store session data) and the protected index page is rendered. While the main page is loading, [Google Publisher Tag (GPT)](https://developers.google.com/publisher-tag/reference#googletag) auto-loads the Secure Signal UID2 script which pushes the advertising token to GPT local storage. The [Interactive Media Ads (IMA) SDK](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side) then makes an ad request, and transmits the encoded signal in the request. |
| 4 | Click **Play**. | This triggers AdsManager to insert the ad returned from the ad request, for display. The ad tag used in this example contains a 10-second pre-roll.ad. |
| 5 | To exit the application, click **Log Out**. | This calls the Secure Signal [`clearAllCache()`](https://developers.google.com/publisher-tag/reference#googletag.secureSignals.SecureSignalProvidersArray_clearAllCache) function, to clear all cached signals, and then calls the `/logout` endpoint on the server ([server.js](server.js)), which clears the UID2 session and the first-party cookie and presents the user with the login form again.<br/> NOTE: As long as the user is logged in, the page displays the **Log Out** button. |
| Step | Description | Comments |
| :--: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1 | In your browser, navigate to the application main page at `http://localhost:3000`. | The displayed main (index) page of the example application provides a [login form](views/login.html) for the user to complete the UID2 login process.</br>IMPORTANT: A real-life application must also display a form for the user to consent to targeted advertising. |
| 2 | Enter the email address that you want to use for testing and click **Submit**. Note: The button may be labeled different here as it is a testing environment; in a real production environment, labels may differ. | The click calls the Secure Signal [`clearAllCache()`](https://developers.google.com/publisher-tag/reference#googletag.secureSignals.SecureSignalProvidersArray_clearAllCache) function, to clear all cached signals from local storage, and then calls the `/login` endpoint ([server.js](server.js)). The login initiated on the server side then calls the [POST /token/generate](https://unifiedid.com/docs/endpoints/post-token-generate) endpoint and processes the received response. |
| | The main page updates to display the established UID2 identity information and a video player. | The displayed identity information is the `body` property of the [JSON response payload](https://unifiedid.com/docs/endpoints/post-token-generate#decrypted-json-response-format) from the successful `POST /token/generate` response. If the response is successful, the returned identity is saved to a session cookie (a real-world application would use a different way to store session data) and the protected index page is rendered. While the main page is loading, [Google Publisher Tag (GPT)](https://developers.google.com/publisher-tag/reference#googletag) auto-loads the Secure Signal UID2 script which pushes the advertising token to GPT local storage. The [Interactive Media Ads (IMA) SDK](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side) then makes an ad request, and transmits the encoded signal in the request. |
| 4 | Click **Play**. | This triggers AdsManager to insert the ad returned from the ad request, for display. The ad tag used in this example contains a 10-second pre-roll.ad. |
| 5 | To exit the application, click **Clear UID2**. | This event calls the Secure Signal [`clearAllCache()`](https://developers.google.com/publisher-tag/reference#googletag.secureSignals.SecureSignalProvidersArray_clearAllCache) function, to clear all cached signals, and then calls the `/logout` endpoint on the server ([server.js](server.js)), which clears the UID2 session and the first-party cookie and presents the user with the login form again.<br/> NOTE: The page displays the **Clear UID2** button as long as the user identity is valid and refreshable within the integration test environment. |
Loading