创建Pixel
您可以使用本接口创建 Pixel,并在您的网站上进行安装。
重要提示
使用事件 API 接口代表您同意遵守TikTok 商业产品(数据)条款,并且不会与 TikTok 分享敏感数据。
准备条件:
- 您需要有一个业务网站。
- 您有编辑网站代码的权限。
注意:
- 像素名称建议为对应网站名称或域名,长度不能超过40字符且不能与已创建的像素名称重复,重复会有提醒。
- 建议一个像素对应一个网站。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/pixel/create/| /v1.3/pixel/create/|
|请求参数类型|advertiser_id: number |advertiser_id: string |
|返回参数类型|pixel_id: number |pixel_id: string |
|新增返回参数|/ |pixel_category<br>automatic_advanced_matching_fields<br>enable_first_party_cookies<br>enable_expanded_data_sharing`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/pixel/create/
**方法** POST
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求信息类型<br>允许格式:`application/json`。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID |
|pixel_name {必填}|string| Pixel 名称。<br><br>长度限制:40 个字符且不能包含 emoji。<br><br><p><span style="color:darkred"><b>注意</b></span>:不支持重复的 Pixel 名称。 |
|pixel_category{-即将废弃} |string| Pixel 追踪事件类型。<br><br><p><span style="color:darkred"><b>注意</b></span>:无论您是否传入本字段,都不再影响 Pixel 可以追踪的 Pixel 事件。建议新建 Pixel 时不要传入本字段。本字段将在下一个 API 版本中废弃。|
示例
(code curl http)
curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
"advertiser_id": "ADVERTISER_ID",
"pixel_name": "PIXEL_NAME"
}' \
https://business-api.tiktok.com/open_api/v1.3/pixel/create/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|request_id |string|请求的日志id,唯一标识一个请求。 |
|data|object|返回数据。|
#|pixel_code |string| Pixel 代码,即您事件管理平台看到的 ID。 |
#|pixel_id |string| Pixel ID。 |
#|pixel_name|string| Pixel 名称。 |
#| pixel_category{-即将废弃}| string | Pixel 追踪事件类型。<br><br> 枚举值:<ul><li>`ONLINE_STORE` :电商事件。</li><li>`FILLING_FORM` :表单事件。 </li><li>`CONTACTS` :联系事件。</li><li>`LANDING_PAGE` :APK 下载事件。</li><li>`CUSTOMIZE_EVENTS` :自定义事件。</li></ul><br>若请求中未传入本字段,本字段将默认设置为`CUSTOMIZE_EVENTS`。<br><br><p><span style="color:darkred"><b>注意</b></span>:无论是否为 Pixel 设置了本字段,都不再影响 Pixel 可以追踪的 Pixel 事件。本字段将在下一个 API 版本中废弃。|
#|partner_name|string| 合作商家名。|
#|advanced_matching_fields|object|该 Pixel 的手动高级匹配设置。|
##|phone_number|boolean|是否为电话号码启用手动高级匹配。<br><br>默认值: `true`。|
##|email|boolean|是否为电子邮件启用手动高级匹配。<br><br>默认值: `true`。|
#|automatic_advanced_matching_fields|object|该 Pixel 的自动高级匹配设置。<br>自动高级匹配功能自动使用通过 TikTok Pixel 收集的客户信息,如电子邮箱、姓名和电话号码,从而改善匹配率、转化监测和再营销。|
##|phone_number|boolean|是否为电话号码启用自动高级匹配。<br><br>默认值:`false`。|
##|email|boolean|是否为电子邮箱启用自动高级匹配。<br><br>默认值:`false`。|
##|name|boolean|是否为姓名启用自动高级匹配。<br><br>默认值:`false`。|
##|address|boolean|是否为地址启用自动高级匹配。<br><br>默认值:`false`。|
##|external_id|boolean|是否为外部 ID 启用自动高级匹配。<br><br>默认值: `false`。|
#|enable_first_party_cookies|boolean|是否允许第一方 Cookie。<br>允许第一方 Cookie 将与 TikTok 共享来自你网站的第一方 Cookie 数据,可改善衡量效果并帮助触达更多用户。[了解关于通过 TikTok Pixel 使用 Cookie](https://ads.tiktok.com/help/article/using-cookies-with-tiktok-pixel)。<br><br>默认值: `true`。|
#|enable_expanded_data_sharing|boolean|是否启用扩展数据共享。<br>启用扩展数据共享将允许此 Pixel 收集来自你的网站的更多信息,包括页面内容(如元标记和商品详情)、访客操作(如点击、按钮互动和使用时长)和网站性能(如页面加载速度和响应能力)。此数据可用于提升 TikTok 的广告投放成效和推广系列成效。你可以通过 TikTok Pixel 助手查看收集的所有数据。[了解通过 TikTok Pixel 实现扩展型数据共享功能](https://ads.tiktok.com/help/article/enhance-data-postback-with-the-tiktok-pixel)。<br><br>默认值: `true`。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"advanced_matching_fields": {
"email": true,
"phone_number": true
},
"automatic_advanced_matching_fields": {
"address": false,
"email": false,
"external_id": false,
"name": false,
"phone_number": false
},
"enable_expanded_data_sharing": true,
"enable_first_party_cookies": true,
"pixel_category": "CUSTOMIZE_EVENTS",
"pixel_code": "{{pixel_code}}",
"pixel_id": "{{pixel_id}}",
"pixel_name": "{{pixel_name}}"
}
}
(/code);