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

设置 TikTok Click ID 和 Cookie

Cookie(_ttp)的定义

如果您正在使用TikTok Pixel,并在事件管理平台的Pixel设置中启用了第一方 Cookie,那么 TikTok 会将唯一标识符自动保存至_ttp第一方 Cookie。

我们强烈建议事件API用户传回_ttp的值。您可以提取_ttp的值并将其添加至事件API有效负载中的ttp字段。您可以使用该 Cookie 保存的值更好地将网站访客事件与TikTok广告进行匹配。了解 Cookie 的详细介绍,请参阅通过 TikTok Pixel 使用 Cookie。

传入了ttp的示例:

(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/pixel/track/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pixel_code": "BU35TSQHT2A1QT375GMG",
    "event": "InitiateCheckout",
     "event_id":"1616318632825_357",
     "timestamp": "2020-09-17T19:49:27Z",
     "context": {
         "ad": {
             "callback": "123ATXSfe"
         },
         "page": {
             "url": "http://demo.mywebsite.com/purchase",
             "referrer": "http://demo.mywebsite.com"
         },
         "user": {
             "external_id": "f0e388f53921a51f0bb0fc8a2944109ec188b59172935d8f23020b1614cc44bc",
             "phone_number": "2f9d2b4df907e5c9a7b3434351b55700167b998a83dc479b825096486ffcf4ea",
             "email": "dd6ff77f54e2106661089bae4d40cdb600979bf7edc9eb65c0942ba55c7c2d7f",
             "ttp":"94e2a4j9-h3j5-k2h5-98cc-c84a745mk098"
         },
         "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.109 Safari/537.36",
         "ip": "13.57.97.131"
     },
     "properties": {
         "contents": [
          {
             "price": 8,
             "quantity": 2,
             "content_type": "product_group",
             "content_id": "1077218"
           },
           {
             "price": 30,
             "quantity": 1,
             "content_type": "product_group",
             "content_id": "1197218"
           }
         ],
         "currency": "USD",
         "value": 46.00
     }
 }'
(/code)

TikTok Click ID(ttclid)的定义

TikTok Click ID(ttclid)是一个跟踪参数,每当用户点击TikTok上的广告时,一个唯一的TikTok Click ID就会自动添加到落地页的URL末尾。TikTok Click ID助力您准确地匹配用户网站事件与TikTok广告。我们强烈建议您设置ttclid,以提高广告效果。了解TikTok Click ID的详细介绍,请参阅此处。

如果您的网站已安装TikTok Pixel,那么Pixel将自动捕捉ttclid参数并将其保存在您域名下的ttclid第一方Cookie中。您可以通过ttclid键获取Cookie中的ttclid值,并将其传入事件API有效负载的context.ad.callback字段中。

(code curl http)
function getCookie(name) {
  let cookie = {};
  document.cookie.split(';').forEach(function(el) {
    let [k,v] = el.split('=');
    cookie[k.trim()] = v;
  })
  return cookie[name];
}
getCookie('ttclid') // TikTok Click ID
getCookie('_ttp') //Cookie id
(/code)

单路会话

  1. 从落地页网站获取ttclid。 点击后到达的URL会加载到TikTok网页视图中,并且其末尾附带ttclid。您需要以编程方式捕捉ttclid。使用如何预览广告测试设置情况。
  2. 确保网站跳转至不同页面时持续使用ttclid请求参数。
  3. 通过/pixel/track/或 /pixel/batch/将ttclid传入context.ad.callback字段,报告用户事件。了解如何报告网页事件和相关参数,请参阅报告网页事件和参数。
(code curl http)
   "context": {
    "ad": {
      "callback": "E.C.P.v3fQ2RHacdksKfofPmlyuStIIHJ4Af1tKYxF9zz2c2PLx1Oaw15oHpcfl5AH"
    },
(/code)

多路会话

  1. 持续使用ttclid,直到您能识别用户:
    1. 为了提高您的广告效果,请持续使用ttclid,直到您可以通过用户的订阅、注册、购买等行为,Cookie ID、电子邮件、电话号码、匿名ID等标识符来识别用户。
  2. 在您的数据库中建立用户和ttclid的映射关系:
    1. 请在您的后台系统中创建一个表格,用于管理用户和ttclid之间的映射关系。示例:ttclid<>email、ttclid<>external_id,等等。
    2. 同一用户在不同时间段点击广告,会生成不同的ttclid。请确保新生成的ttclid覆盖之前的ttclid。
    3. 注意:目前ttclid允许的最大长度为1,000字符。 为了避免数据被截断,建议您用于存储ttclid的数据类型支持的字符数不超过过1,000。
  3. 通过事件API发送带有ttclid的网站事件:
    1. 当网站事件触发时,您需要通过表格中的用户信息(电子邮件、电话、external_id等),确定该用户是否与ttclid关联,并将ttclid值传入/pixel/track/或/pixel/batch/的context.ad.callback字段,报告用户事件。了解如何报告网站事件和相关参数,请参阅报告网站事件和参数。

删除ttclid

如果您希望删除落地页URL中的ttclid,与管理其他请求参数的方式类似,您可以通过编程或编辑网站代码的方式来实现。以下是一个javascript的示例:

(code curl http)
// Add this before pixel tag
<script>
  const myurl = new URL(location.href);  // build a url object from current url
  myurl.searchParams.delete('ttclid');  // remove all ttclid url paramters
  history.replaceState({}, '', myurl);  // replace current url with updated one
</script>
(/code)

内容来源: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 每日平台更新简报 →