Skip to content

Commit 3062d65

Browse files
eiman-eltigani-ttdeiman-eltigani-ttd
authored
Merge pull request #201 from IABTechLab/eee-UID2-5666-rename-sample-login-buttons
add better disclaimers across all readmes and example sites
2 parents 7b3ae33 + 753429e commit 3062d65

File tree

14 files changed

+77
-61
lines changed

14 files changed

+77
-61
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+
use real user data on this page.
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="testing@example.com"
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">Generate UID2</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: 10 additions & 10 deletions
Large diffs are not rendered by default.

‎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 use real user data on this page.
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="validate@example.com"
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">Generate UID2</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>

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

Lines changed: 10 additions & 10 deletions
Large diffs are not rendered by default.

‎examples/google-secure-signals-integration/react_client_side/src/SecureSignalsApp.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,15 +383,15 @@ const SecureSignalsApp = () => {
383383
</div>
384384
<div>
385385
<button type='button' className='button' onClick={handleLogin}>
386-
Log In
386+
Generate UID2
387387
</button>
388388
</div>
389389
</div>
390390
) : (
391391
<div id='logout_form' className='form'>
392392
<form>
393393
<button type='button' className='button' onClick={handleLogout}>
394-
Log Out
394+
Clear UID2
395395
</button>
396396
</form>
397397
</div>

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ step is omitted, and the login process focuses on integration with the UID2 serv
5858

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

61-
| Step | Description | Comments |
62-
| :--: | :--------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
63-
| 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. |
64-
| 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. |
65-
| | 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. |
66-
| 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. |
67-
| 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. |
61+
| Step | Description | Comments |
62+
| :--: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
63+
| 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. |
64+
| 2 | Enter the email address that you want to use for testing and click **Generate UID2**. 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. |
65+
| | 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. |
66+
| 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. |
67+
| 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. |

‎examples/google-secure-signals-integration/server_side/views/identity.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
onsubmit="return window.googletag.secureSignalProviders.clearAllCache()"
66
>
77
<form action="/logout" method="GET">
8-
<input type="submit" value="Log Out" class="button" />
8+
<input type="submit" value="Clear UID2" class="button" />
99
</form>
1010
</div>

‎examples/google-secure-signals-integration/server_side/views/login.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
style="border-style: none"
1010
/>
1111
</div>
12-
<div><input type="submit" value="Log In" class="button" /></div>
12+
<div><input type="submit" value="Generate UID2" class="button" /></div>
1313
</form>
1414
<script>
1515
document.forms['loginForm'].addEventListener('submit', (event) => {

0 commit comments

Comments
 (0)