← 返回目录
📁 Marketing API › Ad Measurement › Guides › Events API 1.0 › Events API : Web

设置外部 ID

外部 ID 是代表广告主自营平台上的用户的标识符,例如客户ID、会员卡号或订单号。您将外部ID分享给TikTok后,TikTok将尝试匹配与该ID对应的TikTok用户,从而提高匹配率,最终实现后续更好的度量与优化结果。

您可使用以下任意TikTok for Business工具将外部 ID传给TikTok: Pixel SDK或事件API。

优势

若您使用外部ID标识访问网站的用户,将可以: - 提升信号成效:提高各渠道的匹配率,捕获更多事件。 - 加强推广系列优化:为推广系列的出价模型赋能,增加转化事件。 - 度量全漏斗事件:实现跨设备和跨会话的匹配,报告更多事件。

注意
为充分发挥外部ID的优点,推荐同时设置手动匹配和自动匹配。在Pixel SDK配置高级匹配的步骤参见这里。

工作原理

  1. 用户在您的网站浏览某个商品。
  2. 您通过网站Pixel向TikTok发送ViewContent事件,其中包括: - 经散列处理的代表该用户的外部ID - 以下任一信息或全部信息:
    • 经散列处理的客户个人信息(邮箱地址/手机号码)
    • Pixel自带的Cookie信息
  3. TikTok使用与外部ID关联的经散列处理的个人信息查找匹配。若查找到匹配,则将外部ID与TikTok用户绑定。
  4. 几天后,同一用户在您的网站上完成购买。
  5. 您使用事件API向TikTok发送新的事件。事件中使用了external_id参数。
  6. TikTok获取到external_id参数后,将使用此前与此信号(即外部ID)关联的个人信息对应的客户的浏览活动,匹配出对应的TikTok用户。
  7. 这些信号将在后续用于提升您的推广系列的表现。

快速入门

使用Pixel SDK配置外部ID和高级匹配

使用须知

  • 您必须具备技术资源,且能够访问网站的代码。
  • 到这个阶段,您应当已经在网站的代码中设置了各类事件。如果尚未完成设置,请参阅使用代码安装Pixel,进一步了解如何设置事件。
  • 推荐同时启用手动自动高级匹配和自动高级匹配,充分发挥外部ID的作用。

步骤

  1. 导航到您想设置外部ID的事件(或事件代码)。以下是一个包含参数的 "Add to Cart"(添加到购物车)事件的例子。
(code curl http)
ttq.track('AddToCart', {
   contents: [
   {
     content_id: '301',
     content_name: 'running shoes',
     content_category: 'Shoes > Sneakers > running shoes',
     brand: 'your brand name',
     quantity: 1,
     price: 8,
   }],
   content_type: 'product',
   value: 9.2,
   currency: 'USD',
});
(/code)
  1. 使用ttq.identify开始编写外部ID的代码,与高级匹配代码类似,您可以: - a. 传入未经过散列处理的原始身份信息,我们会在用户侧对原值进行散列处理。
(code curl http)
ttq.identify({
      email: 'email@example.com',
      phone_number: '+15551234567',
})
(/code)
  • b. 传入经过散列处理的身份信息。确保散列处理前首尾空格已去掉。
(code curl http)
ttq.identify({
      sha256_email: '0c7e6a405862e402eb76a70f8a26fc732d07c32931e9fae9ab1582911d2e8a3b', 
      sha256_phone_number: '9f7ec22d72092cd3c0b58726ed9c2d91b92e51a3f29837508fb2948bb22dd2fd',
      external_id: '936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af',
})
(/code)

传入经过散列处理的信息时的重要提示 高级匹配和外部 ID - 在散列处理前需去掉首尾空格 - ttq.identify需置于事件代码之上。确保当事件被触发时,事件可以接收到高级匹配和外部 ID 的数据。

以下为一个事件示例:

(code curl http)
// Always Advanced Matching code before event code, see below for a sample event. 
// Repeat for each page where event(s)take place. 

ttq.identify({
      email: '0c7e6a405862e402eb76a70f8a26fc732d07c32931e9fae9ab1582911d2e8a3b',
      phone_number: '9f7ec22d72092cd3c0b58726ed9c2d91b92e51a3f29837508fb2948bb22dd2fd',
      external_id: '936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af',
})

ttq.track('ViewContent', {
    contents: [
    {
      content_id: '301',
      content_name: 'running shoes',
      content_category: 'Shoes > Sneakers > running shoes',
      brand: 'your brand name',
      quantity: 1,
      price: 8,
    }],
    content_type: 'product',
    value: 9.2,
    currency: 'USD',
});

ttq.track('AddToCart', {
    contents: [
    {
      content_id: '301',
      content_name: 'running shoes',
      content_category: 'Shoes > Sneakers > running shoes',
      brand: 'your brand name',
      quantity: 1,
      price: 8,
    }],
    content_type: 'product',
    value: 9.2,
    currency: 'USD',
});
(/code)
  1. 在您的网站上每个设置了事件代码的网页完成步骤1-3。
  2. 一旦您将高级匹配和外部ID的代码添加到所有的事件中,使用Pixel Helper chrome扩展程序检查是否安装成功。以下是检查方法:
    1. 安装Pixel Helper,然后进入您的网站。
    2. 依次测试各个事件。检测到的每个事件都会显示在Pixel Helper中。
    3. 打开每个事件的细节,若显示绿色对号,代表事件没有检测到问题。
    4. 打开事件详情下的Parameter Details部分。
    5. 打开Advanced Matching,查看是否同时显示email、phone和external_id。若显示,意味着我们的系统已经检测到电子邮件、电话号码和外部 ID 的有效高级匹配代码。

欲获取更多关于Pixel Helper的信息,参阅TikTok Pixel 自检器 2.0 简介。

支持的 Pixel 身份信息

|身份信息{22%}|描述{25%}| 格式要求{28%} |示例{25%}|
|---|---|---|---|
| email | 用户的邮箱地址,支持传入| 未经散列处理的值,或字母处理为小写后进行了散列处理的值。<br><br>对于未经散列处理的值:<ul><li>TikTok 将自动使用 SHA256 算法对值进行散列处理,然后将加密值传入系统。</li></ul><br>对于经散列处理的值:<ul><li>在散列处理前需去掉首尾空格,且将字母统一处理为小写。</li><li>在散列处理前不要对邮件地址进行其他预处理。</li><li>仅接受使用SHA256算法进行散列处理。推荐使用处理包: [https://github.com/emn178/js-sha256](https://github.com/emn178/js-sha256)</li></ul>| `email@example.com` |
| phone_number | 用户的电话号码,支持传入 |未经散列处理的值,或经散列处理的值。<br><br><ul><li>电话号码需格式化为E.164格式,即+&#91;国家电话区号&#93; &#91;去掉国家电话区号的电话号码&#93;。E.164格式的美国电话号码示例:+12133734253。</li><li>推荐使用 [https://github.com/catamphetamine/libphonenumber-js](https://github.com/catamphetamine/libphonenumber-js)  解析E.164格式的电话号码。</li></ul><br>对于未经散列处理的值:<ul><li>TikTok 将自动使用 SHA256 算法对值进行散列处理,然后将加密值传入系统。</li></ul><br>对于经散列处理的值: <ul><li>仅接受使用SHA256算法进行散列处理。推荐使用处理包: [https://github.com/emn178/js-sha256](https://github.com/emn178/js-sha256)。</li></ul> | `+12133734253` |
|external_id|来自广告主的唯一ID,例如会员 ID,用户 ID 或外部 Cookie ID。|未经散列处理的值,或经散列处理的值。<br><br>在散列处理前需去掉首尾空格,并确保与要使用的外部ID保持一致。<br><br>对于经散列处理的值: <ul><li>仅接受使用SHA256算法进行散列处理。推荐使用处理包: [https://github.com/emn178/js-sha256](https://github.com/emn178/js-sha256)。</li></ul> | |

使用事件API配置外部ID和高级匹配

查看报告网页事件和参数,了解如何使用事件API设置外部ID。

管理外部ID

若您正在通过TikTok Pixel SDK或事件API分享external_id给TikTok,且不希望TikTok使用该参数进行匹配或度量,请更新您的设置,移除external_id字段。

内容来源:TikTok API for Business 官方文档 · 本地归档

在接这个接口时卡住了?
Stuck wiring this API into production? We build ad-delivery tooling on these platforms — campaign automation, reporting pipelines, error-handling and migration between API versions.
联系我们 · Talk to us 每日平台更新简报 →