UID2の生成に関数を使用する
この記事では、訪問関数を使用してユーザーのUID2を生成し、訪問プロファイルに保存する方法について説明します。
Unified ID 2.0（UID2）は、The Tradedeskによって作成されたオープンソースのIDフレームワークであり、サードパーティのクッキーの代わりに使用することができます。UID2は、ユーザーの個人を特定できる情報（PII）（例：メールアドレス）に基づいた確定的なユーザー識別子です。UIDはハッシュ化および暗号化され、UID2リクエストへの応答として返されます。詳細については、Tradedesk UID2ドキュメントを参照してください。
UID2は、The Tradedeskコネクタおよび他のサポートされているアウトバウンドコネクタで使用することができます。
訪問プロファイルのUID2の生成
UID2を生成するためには、訪問関数を使用することをおすすめします。訪問がPIIを持っているが、UID2が割り当てられていない場合に、この関数をトリガーとして使用します。訪問関数の詳細については、イベントと訪問関数についてを参照してください。
訪問関数は、以下の操作を行います。
- 訪問にUID2が割り当てられていない場合、UID2を生成します。
- UID2と
tealium_visitor_idを含むイベントをTealium Collectに送信します。
イベントから送信されたデータによって、AudienceStream属性と訪問属性が拡張されます。
前提条件
UID2を生成するための訪問関数を作成する前に、以下の手順を実行してください。
-
The Tradedeskから受け取るデータに対して属性を持つUID2イベント仕様を作成します（
uid_identifier、uid2、uid_timestamp）。このイベント仕様は、関数がTealium Collectにイベントを送信するために使用されます。例：
-
ユーザーの識別子として使用するPII属性を選択します。UID2は現在、電話番号またはメールアドレスの識別子をサポートしています。
-
UID2を保存するための訪問属性を作成します。この訪問属性に対して、イベントのUID2属性の値を拡張するエンリッチメントを追加します。詳細については、属性の使用方法およびエンリッチメントについてを参照してください。
-
UID2が割り当てられていない識別された訪問（メールアドレス、電話番号、または他の識別子が割り当てられている訪問）のためのオーディエンスを作成します。例：
詳細については、オーディエンスの作成を参照してください。
UID2ジェネレータ関数
関数を作成する際には、以下の手順を実行してください。
- トリガーとしてProcessed Visitorを選択します。
- Audienceとして、UID2が割り当てられていない識別された訪問のために作成したオーディエンスを選択します。Trigger Onはデフォルト値のままにしておきます（
Joined Audience）。
処理された訪問関数のデフォルトコードを削除し、Example codeに示すUID2を生成するための例のコードをコピーして貼り付けます。必要に応じて例のコードを変更します。 - Advancedタブをクリックし、Assign Authenticationsをクリックして、関数にUID2認証を追加します。
詳細については、UID2認証の追加を参照してください。
例のコード
この例のコードは、訪問にUID2を割り当てるための関数の構成のガイドとしてのみ使用できます。構成に必要な変更が必要な行には、TODOというコメントがあります。
この例では、ユーザー識別子としてメールアドレスを使用していますが、他のユーザー識別子に適応することもできます。属性IDは、メール属性の値を取得するために使用されます。使用している属性に対応する正しい値に属性IDを更新してください。
import CryptoES from 'crypto-es'
activate(async ({ visitor, visit, helper }) => {
const genHash = (data) => {
return CryptoES.SHA256(data).toString(CryptoES.enc.Base64)
}
const validateEmail = (email) => {
return String(email)
.toLowerCase()
.match(
/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|.(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
);
};
let tealium_config = {
tealium_account: 'CURRENT',
tealium_profile: 'CURRENT',
tealium_datasource: 'DATA_SOURCE_KEY', // TODO: DATA_SOURCE_KEYをTealium Data Sourceキーに変更してください。
email_hashed: false // TODO: メールがすでにハッシュ化されている場合は、これをtrueに構成してください。
};
if(tealium_config.tealium_account == 'CURRENT') {
tealium_config.tealium_account = visitor.properties.account
}
if(tealium_config.tealium_profile == 'CURRENT') {
tealium_config.tealium_profile = visitor.properties.profile
}
// TODO: メール属性を持つ訪問の値を指すようにattribute_numberを変更してください。
const email = visitor.getAttributeValueById('ATTRIBUTE_ID')
let hashed_email = '';
console.log(email)
const tealium_vid = visitor.properties.visitor_id
if(!tealium_config.email_hashed) {
if(!validateEmail(email)) {
throw new Error(`Email Attribute is not a valid email`);
return false
}
hashed_email = genHash(email)
} else {
hashed_email = email
}
console.log(hashed_email)
// TODO: 以下の変数をTTD UID2の資格情報に更新してください。
const api_key = 'TTD_API_KEY' // TODO: TTD_API_KEYをTTD APIキーに変更してください。
const secret = 'UID2_SECRET' // TODO: UID2_SECRETをTTD UID2シークレットに変更してください。
const url = 'https://prod.uidapi.com/v2/identity/map'
const key = CryptoES.enc.Base64.parse(secret)
const hexRef = "0123456789abcdef"
const randomBytes = (bytes) => {
let buf = ''
for (let i = 0; i < bytes * 2; i++)
buf += hexRef.charAt(Math.floor(Math.random() * hexRef.length))
return buf
}
const writeBigUint64BE = (num, bytes = 8) => {
let buf = num.toString(16)
let padding = ''
for (let i = 0; i < bytes * 2 - buf.length; i++)
padding += '0'
return padding + buf
}
const encrypt = (data) => {
const iv = randomBytes(12)
const nonce = randomBytes(8)
const millisec = Date.now()
const timestamp = writeBigUint64BE(millisec)
const payload = CryptoES.enc.Utf8.parse(JSON.stringify(data))
const body = timestamp + nonce + payload
const ivBuf = CryptoES.enc.Hex.parse(iv)
const encryptedBody = CryptoES.AES.encrypt(
CryptoES.enc.Hex.parse(body),
key,
{
iv: ivBuf,
mode: CryptoES.mode.GCM,
padding: CryptoES.pad.NoPadding
}
)
const ciphertext = encryptedBody.ciphertext
const authTag = CryptoES.mode.GCM.mac(CryptoES.algo.AES, key, ivBuf, null, ciphertext).toString()
const enveloped = '01' + iv + ciphertext.toString() + authTag
return {
timestamp: parseInt(timestamp, 16),
nonce: parseInt(nonce, 16),
enveloped: CryptoES.enc.Hex.parse(enveloped).toString(CryptoES.enc.Base64)
}
}
const decrypt = (data) => {
const buf = CryptoES.enc.Base64.parse(data).toString(CryptoES.enc.Hex)
const iv = CryptoES.enc.Hex.parse(buf.substring(0, 24))
const ciphertext = CryptoES.enc.Hex.parse(buf.substring(24, buf.length - 32))
const tag = buf.substring(buf.length - 32)
const encryptedBody = new CryptoES.lib.CipherParams({ ciphertext: ciphertext })
const decrypted = CryptoES.AES.decrypt(encryptedBody,key,
{
iv: iv,
mode: CryptoES.mode.GCM,
padding: CryptoES.pad.NoPadding
}
).toString()
const timestamp = decrypted.substring(0, 16)
const nonce = decrypted.substring(16, 32)
const developed = decrypted.substring(32)
return {
timestamp: parseInt(timestamp, 16),
nonce: parseInt(nonce, 16),
developed: JSON.parse(CryptoES.enc.Hex.parse(developed).toString(CryptoES.enc.Utf8))
}
}
const payload = {
email_hash: [genHash(email)]
}
const {timestamp, nonce, enveloped} = encrypt(payload)
console.log('\n********** encypted **********')
console.log('timestamp:', timestamp)
console.log('nonce:', nonce)
console.log('enveloped:', enveloped)
const response = await fetch(url, {
method: 'POST',
body: enveloped,
headers: {
'Authorization': `Bearer ${api_key}`
}
})
if (response.status == 200) {
const body = await response.text()
console.log('\n********** response **********')
console.log(body)
const data = decrypt(body)
console.log('\n********** decrypted **********')
console.log('timeStamp:', data.timestamp)
console.log('nonce:', data.nonce)
console.log('response:', JSON.stringify(data.developed))
console.log('\n')
// TODO: このイベント仕様は、関数の最後にTealiumに送信されます。作成したイベント仕様の属性がevent_data内の属性と一致していることを確認してください。
let event_data ={
tealium_event: "UID2_event_data",
tealium_visitor_id: tealium_vid,
uid: data.developed.body.mapped[0].advertising_id,
uid_timestamp : JSON.stringify(data.timestamp)
};
// これがevent_dataオブジェクトをTealiumに送信して処理する手順です。
console.log(JSON.stringify(event_data))
if(event_data.uid) {
track(event_data, tealium_config)
.then(response => {
if (!response.ok) {
throw new Error(`Network response was not ok. Status code: ${response.status}.`);
}
console.log('Status code:', response.status);
return response.text();
})
.catch(error => console.error('Error:', error.message));
}
else {
console.error("Couldn't generate advertising ID")
}
}
else {
console.log('\nxxxxx failed xxxxx\n')
console.log(JSON.stringify(response))
}
})
最終更新日 :: 2024年May月15日