Skip to content

Commit 33ea23e

Browse files
eiman-eltigani-ttdeiman-eltigani-ttd
committed
add better disclaimers across all readmes and example sites
1 parent 41e5b3e commit 33ea23e

File tree

10 files changed

+40
-29
lines changed

10 files changed

+40
-29
lines changed

‎examples/cstg/html/index.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK</h1
9696
>Client-Side Integration Guide for JavaScript
9797
</a>
9898
to implement UID2 integration and generate UID2 tokens.
99+
<strong>Note:</strong> This is a <em>test-only</em> integration environment—not for production
100+
use. It does not perform real user authentication or generate production-level tokens. Do not
101+
connect this site to real user traffic.
99102
</p>
100103
<table id="uid2_state">
101104
<tr>
@@ -134,11 +137,11 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK</h1
134137
value="[email protected]"
135138
/>
136139
</div>
137-
<div><button type="button" class="button" id="login">Log In</button>></div>
140+
<div><button type="button" class="button" id="login">Submit</button>></div>
138141
</div>
139142
<div id="logout_form" style="display: none" class="form">
140143
<form>
141-
<button type="button" class="button" id="logout">Log Out</button>
144+
<button type="button" class="button" id="logout">Clear UID2</button>
142145
</form>
143146
</div>
144147
</body>

‎examples/google-secure-signals-integration/client_side/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ The following table outlines and annotates the steps you may take to test and ex
2424
| Step | Description | Comments |
2525
| :--: | :---------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2626
| 1 | In your browser, navigate to the application main page at `http://localhost:3000`. | The displayed main [page](views/index.html) of the example application provides a login form for the user to complete the UID2 login process.</br>IMPORTANT: A real-life application must also display a form for the user to express their consent to targeted advertising. |
27-
| 2 | In the text field at the bottom, enter the user 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. Then, it makes a call on the client side to the `setIdentityFromEmail` function of the JS SDK ([Configuring the SDK for Javascript](https://unifiedid.com/docs/guides/integration-javascript-client-side#configure-the-sdk-for-javascript)). |
27+
| 2 | In the text field at the bottom, enter the user email address that you want to use for testing and click **Submit**. (Note: The button is labeled "Submit" here to ensure differentiation of testing environments; in a real production environment, users would see a button labeled "Login", not "Submit".) | 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. Then, it makes a call on the client side to the `setIdentityFromEmail` function of the JS SDK ([Configuring the SDK for Javascript](https://unifiedid.com/docs/guides/integration-javascript-client-side#configure-the-sdk-for-javascript)). |
2828
| 3 | A confirmation message appears with the established UID2 identity information. | 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 `client-generate` response. Next, the identity information is passed to the UID2 SDK [`setIdentity()`](https://unifiedid.com/docs/sdks/sdk-ref-javascript#setidentityidentity-identity-void) function. If the identity is valid, the SDK stores it either in local storage or a first-party UID2 cookie (see [UID2 Storage Format](https://unifiedid.com/docs/sdks/sdk-ref-javascript#uid2-storage-format) for use on subsequent page loads.) |
2929
| 4 | Click the **Back to the main page** link. | On the updated application main page, note the newly populated **UID2 Advertising Token** value and a video player. While the [page](views/index.html) is loading, [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, and the [IMA](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side) makes an ad request which transmits the encoded signal in the request. The [page](views/index.html) calls the [init()](https://unifiedid.com/docs/sdks/sdk-ref-javascript#initopts-object-void) function again, but this time without passing an explicit identity. Instead, the identity is loaded from the first-party cookie or local storage. |
3030
| 5 | 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. |
3131
| 6 | (Optional) Right-click the main page to inspect the source code. | When the UID2 SDK initialization is complete, the SDK invokes the passed [callback function](https://unifiedid.com/docs/sdks/client-side-identity#callback-function) (`onUid2IdentityUpdated()` in this example).</br>IMPORTANT: The callback updates the page elements with the state of UID2 identity: this is the place where you should define your logic for initiating targeted advertising. |
3232
| 7 | Keep the application main page open or refresh it after awhile and note the UID2 identity state, updated counter, and login information values. | In the background, the UID2 SDK continuously validates whether the advertising token is up-to-date and refreshes it automatically when needed. If the refresh succeeds, the user opts out, or the refresh token expires, the callback function is invoked and the UI elements are updated with the current state of the UID2 identity. For details, see [Workflow States and Transitions](https://unifiedid.com/docs/sdks/client-side-identity#workflow-states-and-transitions) and [Background Token Auto-Refresh](https://unifiedid.com/docs/sdks/client-side-identity#background-token-auto-refresh). |
33-
| 8 | To exit the application, click **Log Out**. | This calls the UID2 SDK [`disconnect()`](https://unifiedid.com/docs/sdks/sdk-ref-javascript#disconnect-void) function, which clears the UID2 session and the first-party cookie or local storage and calls the Secure Signal [`clearAllCache()`](https://developers.google.com/publisher-tag/reference#googletag.secureSignals.SecureSignalProvidersArray_clearAllCache) function to clear all cached signals. This call also makes the UID2 SDK [`isLoginRequired()`](https://unifiedid.com/docs/sdks/sdk-ref-javascript#isloginrequired-boolean) function return `true`, which presents the user with the login form again.<br/> NOTE: The page displays the **Log Out** button as long as the user identity is valid and refreshable. |
33+
| 8 | To exit the application, click **Clear UID2**. (Note: The button is labeled "Clear UID2" here to ensure differentiation of testing environments; in a real production environment, users would see a button labeled "Logout", not "Clear UID2".) | This event calls the UID2 SDK [`disconnect()`](https://unifiedid.com/docs/sdks/sdk-ref-javascript#disconnect-void) function, which clears the UID2 session and the first-party cookie or local storage and calls the Secure Signal [`clearAllCache()`](https://developers.google.com/publisher-tag/reference#googletag.secureSignals.SecureSignalProvidersArray_clearAllCache) function to clear all cached signals. This call also makes the UID2 SDK [`isLoginRequired()`](https://unifiedid.com/docs/sdks/sdk-ref-javascript#isloginrequired-boolean) function return `true`, which 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. |

‎examples/google-secure-signals-integration/client_side/views/index.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK, Se
1818
<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.
1919
Secure Signals is updated when the page is reloaded.
2020
Reload the page in order to update Secure Signals in local storage.
21+
<strong>Note:</strong> This is a <em>test-only</em> integration environment—not for production use.
22+
It does not perform real user authentication or generate production-level tokens.
23+
Do not connect this site to real user traffic.
2124
</p>
2225
<div id="page-content">
2326
<div id="video-container">
@@ -71,11 +74,11 @@ <h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK, Se
7174
value="[email protected]"
7275
/>
7376
</div>
74-
<div><button type="button" class="button" id="login">Log In</button>></div>
77+
<div><button type="button" class="button" id="login">Submit</button></div>
7578
</div>
7679
<div id="logout_form" style="display: none" class="form">
7780
<form>
78-
<button type="button" class="button" id="logout">Log Out</button>
81+
<button type="button" class="button" id="logout">Clear UID2</button>
7982
</form>
8083
</div>
8184
<script src="https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js"></script>

0 commit comments

Comments
 (0)