Skip to content
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

Make CSTG example site work with either UID2 or EUID SDK #88

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Make CSTG example site work with either UID2 or EUID SDK #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2092bc2
Make CSTG example site work with either UID2 or EUID SDK
mcollins-ttd Jul 23, 2024
bb02d43
Use sub_filter instead of SSI
mcollins-ttd Jul 30, 2024
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
6 changes: 3 additions & 3 deletions .vscode/tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@
}
],
"env": {
"UID2_BASE_URL": "http://localhost:8080",
"UID2_JS_SDK_URL": "http://localhost:9091/uid2-sdk.js",
"EUID_JS_SDK_URL": "http://localhost:9091/euid-sdk.js",
"UID_BASE_URL": "http://localhost:8080",
"UID_JS_SDK_URL": "http://localhost:9091/uid2-sdk.js",
"UID_JS_SDK_NAME": "__uid2",
"SERVER_PUBLIC_KEY": "UID2-X-L-MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEWyCP9O/6ppffj8f5PUWsEhAoMNdTBnpnkiOPZBkVnLkxOyTjPsKzf5J3ApPHzutAGNGgKAzFc6TuCfo+BWsZtQ==",
"SUBSCRIPTION_ID": "LBk2xJsgrS"
},
Expand Down
182 changes: 55 additions & 127 deletions examples/cstg/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,190 +6,118 @@
<link rel="stylesheet" type="text/css" href="/stylesheets/app.css" />
<link rel="shortcut icon" href="/images/favicon.png" />
<script defer src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script defer src="{{ UID2_JS_SDK_URL }}"></script>
<script defer src="{{ EUID_JS_SDK_URL }}"></script>
<script defer src="{{ UID_JS_SDK_URL }}"></script>
<script>
const clientSideIdentityOptions = {
subscriptionId: '{{ SUBSCRIPTION_ID }}',
serverPublicKey: '{{ SERVER_PUBLIC_KEY }}',
};

let callbackCounter = {
uid2: 0,
euid: 0,
};
let callbackCounter = 0;

function updateGuiElements(product, state) {
const productSelector = `#${product}_state`;
$(`${productSelector} #targeted_advertising_ready`).text(
__uid2.getAdvertisingToken() ? 'yes' : 'no'
);
$(`${productSelector} #advertising_token`).text(String(__uid2.getAdvertisingToken()));
$(`${productSelector} #login_required`).text(
__uid2.isLoginRequired() || __uid2.isLoginRequired() === undefined ? 'yes' : 'no'
// __uid2 for UID2 SDK, __euid for EUID SDK.
const sdkName = '{{ UID_JS_SDK_NAME }}';

function getUidSdk() {
return window[sdkName];
}

function updateGuiElements(state) {
const sdk = getUidSdk();
$('#targeted_advertising_ready').text(sdk.getAdvertisingToken() ? 'yes' : 'no');
$('#advertising_token').text(String(sdk.getAdvertisingToken()));
$('#login_required').text(
sdk.isLoginRequired() || sdk.isLoginRequired() === undefined ? 'yes' : 'no'
);
$(`${productSelector} #update_counter`).text(callbackCounter[product]);
$(`${productSelector} #identity_state`).text(String(JSON.stringify(state, null, 2)));
$('#update_counter').text(callbackCounter);
$('#identity_state').text(String(JSON.stringify(state, null, 2)));

updateSharedGuiElements();
}

function updateSharedGuiElements() {
const uid2LoginRequired = __uid2.isLoginRequired();
const euidLoginRequired = __euid.isLoginRequired();
if (uid2LoginRequired || euidLoginRequired) {
if (getUidSdk().isLoginRequired()) {
$('#login_form').show();
} else {
$('#login_form').hide();
}
if (uid2LoginRequired && euidLoginRequired) {
$('#logout_form').hide();
} else {
$('#login_form').hide();
$('#logout_form').show();
}
}

function isEnabled(product) {
console.log("Check", product, `${product}_state th input`, $(`${product}_state th input`)[0]);
return $(`#${product}_state th input`)[0].checked;
}

function onUid2IdentityUpdated(eventType, payload) {
function onIdentityUpdated(eventType, payload) {
if (
payload?.identity &&
(eventType === 'InitCompleted' || eventType === 'IdentityUpdated')
) {
++callbackCounter.uid2;
++callbackCounter;
}
updateGuiElements('uid2', payload);
}

function onEuidIdentityUpdated(eventType, payload) {
console.log('EUID Callback', payload);
if (
payload?.identity &&
(eventType === 'InitCompleted' || eventType === 'IdentityUpdated')
) {
++callbackCounter.euid;
}
updateGuiElements('euid', payload);
updateGuiElements(payload);
}

function onDocumentReady() {
$('#logout').click(() => {
if (isEnabled("uid2")) {
__uid2.disconnect();
updateGuiElements('uid2', undefined);
}
if (isEnabled("euid")) {
__euid.disconnect();
updateGuiElements('euid', undefined);
}
getUidSdk().disconnect();
updateGuiElements(undefined);
});

$('#login').click(async () => {
const email = $('#email').val();

try {
if (isEnabled("uid2")) {
await __uid2.setIdentityFromEmail(email, clientSideIdentityOptions);
}
if (isEnabled("euid")) {
await __euid.setIdentityFromEmail(email, clientSideIdentityOptions);
}
await getUidSdk().setIdentityFromEmail(email, clientSideIdentityOptions);
} catch (e) {
console.error('setIdentityFromEmail failed', e);
}
});
}

window.__uid2 = window.__uid2 || {};
window.__uid2.callbacks = window.__uid2.callbacks || [];
window[sdkName] = window[sdkName] || {};
const sdk = getUidSdk();
sdk.callbacks = sdk.callbacks || [];

window.__uid2.callbacks.push(onUid2IdentityUpdated);
window.__uid2.callbacks.push((eventType, payload) => {
sdk.callbacks.push(onIdentityUpdated);
sdk.callbacks.push((eventType, payload) => {
if (eventType === 'SdkLoaded') {
window.__uid2.init({
baseUrl: '{{ UID2_BASE_URL }}',
getUidSdk().init({
baseUrl: '{{ UID_BASE_URL }}',
});
$(document).ready(onDocumentReady);
}
});

window.__euid = window.__euid || {};
window.__euid.callbacks = window.__euid.callbacks || [];

window.__euid.callbacks.push(onEuidIdentityUpdated);
window.__euid.callbacks.push((eventType, payload) => {
if (eventType === 'SdkLoaded') {
window.__euid.init({
baseUrl: '{{ UID2_BASE_URL }}',
});
}
});
</script>
</head>
<body>
<h1>Client-Side Integration Example, UID2 & EUID JavaScript SDKs</h1>
<h1>UID2 Publisher Client-Side Integration Example using UID2 JavaScript SDK</h1>
<p>
This example demonstrates how a content publisher can follow the
<a href="https://unifiedid.com/docs/guides/publisher-client-side"
>Client-Side Integration Guide for JavaScript
</a>
to implement UID2 integration and generate UID2 tokens.
</p>
<div class="product-tables">
<table id="uid2_state">
<thead>
<th colspan="2">UID2 Enabled<input type="checkbox" checked></input></th>
</thead>
<tr>
<td class="label">Ready for Targeted Advertising:</td>
<td class="value"><pre id="targeted_advertising_ready"></pre></td>
</tr>
<tr>
<td class="label">UID2 Advertising Token:</td>
<td class="value"><pre id="advertising_token"></pre></td>
</tr>
<tr>
<td class="label">Is UID2 Login Required?</td>
<td class="value"><pre id="login_required"></pre></td>
</tr>
<tr>
<td class="label">UID2 Identity Updated Counter:</td>
<td class="value"><pre id="update_counter"></pre></td>
</tr>
<tr>
<td class="label">UID2 Identity Callback State:</td>
<td class="value"><pre id="identity_state"></pre></td>
</tr>
</table>
<table id="euid_state">
<thead>
<th colspan="2">EUID Enabled<input type="checkbox" checked></input></th>
</thead>
<tr>
<td class="label">Ready for Targeted Advertising:</td>
<td class="value"><pre id="targeted_advertising_ready"></pre></td>
</tr>
<tr>
<td class="label">UID2 Advertising Token:</td>
<td class="value"><pre id="advertising_token"></pre></td>
</tr>
<tr>
<td class="label">Is UID2 Login Required?</td>
<td class="value"><pre id="login_required"></pre></td>
</tr>
<tr>
<td class="label">UID2 Identity Updated Counter:</td>
<td class="value"><pre id="update_counter"></pre></td>
</tr>
<tr>
<td class="label">UID2 Identity Callback State:</td>
<td class="value"><pre id="identity_state"></pre></td>
</tr>
</table>
</div>
<table id="uid2_state">
<tr>
<td class="label">Ready for Targeted Advertising:</td>
<td class="value"><pre id="targeted_advertising_ready"></pre></td>
</tr>
<tr>
<td class="label">Advertising Token:</td>
<td class="value"><pre id="advertising_token"></pre></td>
</tr>
<tr>
<td class="label">Is Login Required?</td>
<td class="value"><pre id="login_required"></pre></td>
</tr>
<tr>
<td class="label">Identity Updated Counter:</td>
<td class="value"><pre id="update_counter"></pre></td>
</tr>
<tr>
<td class="label">Identity Callback State:</td>
<td class="value"><pre id="identity_state"></pre></td>
</tr>
</table>
<div id="login_form" style="display: none" class="form">
<div class="email_prompt">
<input
Expand Down
6 changes: 3 additions & 3 deletions examples/cstg/nginx/default.conf.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ server {
#access_log /var/log/nginx/host.access.log main;

location / {
sub_filter '{{ UID2_JS_SDK_URL }}' '${UID2_JS_SDK_URL}';
sub_filter '{{ EUID_JS_SDK_URL }}' '${EUID_JS_SDK_URL}';
sub_filter '{{ UID2_BASE_URL }}' '${UID2_BASE_URL}';
sub_filter '{{ UID_JS_SDK_URL }}' '${UID_JS_SDK_URL}';
sub_filter '{{ UID_JS_SDK_NAME }}' '${UID_JS_SDK_NAME}';
sub_filter '{{ UID_BASE_URL }}' '${UID_BASE_URL}';
sub_filter '{{ SERVER_PUBLIC_KEY }}' '${SERVER_PUBLIC_KEY}';
sub_filter '{{ SUBSCRIPTION_ID }}' '${SUBSCRIPTION_ID}';
sub_filter_types *;
Expand Down