UID2を生成するための関数の使用 | イベントとビジター関数

Unified ID 2.0（UID2）は、The Trade Deskによって作成されたオープンソースのIDフレームワークで、サードパーティクッキーの代わりに使用できます。UID2は、ユーザーの個人識別情報（PII）（例えば、メールアドレス）に基づいて決定的なユーザー識別子であり、UIDはハッシュ化および暗号化されてUID2が生成され、UID2リクエストへの応答で返されます。詳細については、The Trade Desk UID2ドキュメントを参照してください。

UID2は、The Trade Deskコネクタおよびその他のサポートされているアウトバウンドコネクタで使用できます。

訪問プロファイルのためのUID2の生成

訪問関数を使用してUID2を生成することをお勧めします。訪問がPIIを持っているがUID2が割り当てられていない場合に関数をトリガーします。訪問関数についての詳細は、イベントおよび訪問関数についてを参照してください。

訪問関数は以下を行います：

訪問にUID2が割り当てられていない場合、UID2を生成します。
UID2とtealium_visitor_idを含むイベントをTealium Collectに送信します。

AudienceStream属性と訪問属性は、関数から送信されたイベントによって豊かにされます。

前提条件

UID2を生成するための訪問関数を作成する前に、以下を行ってください：

The Trade Deskから受け取ったデータの属性（uid_identifier、uid2、uid_timestamp）を持つUID2イベント仕様を作成します。このイベント仕様を使用して、関数はTealium Collectにイベントを送信します。例えば：
ユーザーの識別子として使用するPII属性を選択します。UID2は現在、電話番号またはメールアドレス識別子をサポートしています。
UID2を保存するための訪問属性を作成します。この訪問属性をイベントUID2属性の値でエンリッチするためにエンリッチメントを追加します。詳細については、属性の使用およびエンリッチメントについてを参照してください。
UID2が割り当てられていない識別された訪問（メールアドレス、電話番号、または他の識別子が割り当てられている訪問）のためのオーディエンスを作成します。例えば：

詳細については、オーディエンスの作成を参照してください。

UID2ジェネレーター関数

関数を作成する際には、以下を行ってください：

トリガーにはProcessed Visitorを選択します。
Audienceには、UID2が割り当てられていない識別された訪問のために作成したオーディエンスを選択します。Trigger Onはデフォルト値のJoined Audienceに構成したままにします。デフォルトの処理済み訪問関数のコードを削除し、例のコードに示されている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データソースキーに変更してください。
      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))
    the 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)
    the nonce = decrypted.substring(16, 32)
    the 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: [hashed_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)
    };

// このステップは、イベントデータオブジェクトを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))
    }
  })