创建Pixel事件
您可以使用本接口创建 Pixel 事件。在创建 Pixel 后，您可以通过本接口选择行业模板或者自定义模板来定义系列事件。 事件是用户在网站发生的操作（如用户将商品加入购物车）。事件可能是 TikTok 广告带来的（付费），也可能是自然流量产生的（未付费）。您可以在事件管理平台 (TikTok广告管理平台 > 资产 > 事件) 添加对业务有重要作用的系列事件，进而了解用户的体验情况。
重要提示
使用事件 API 接口代表您同意遵守TikTok 商业产品（数据）条款，并且不会与 TikTok 分享敏感数据。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/pixel/event/create/| /v1.3/pixel/event/create/|
|请求参数名称|name|event_name|
|请求参数类型|advertiser_id: number <br>event_id: number <br>pixel_id: number |advertiser_id: string <br>event_id: string <br>pixel_id`: string |
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/pixel/event/create/
**方法** POST
```xtable
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求信息类型<br>允许格式：`application/json`。
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|pixel_events {必填}|object[]| Pixel 事件列表。 |
#|currency_value |string| 转化价值（结合 `currency` 字段代表产生一次转化事件对业务的价值）。<br><br>如 `currency` 为 `USD` ，传入 `5.5` 代表产生一次转化事件会对业务产生 5.5 USD 的价值。|
#|currency |string| 转化价值对应币种。<br><br>枚举值：`INR`（印度卢比），`JPY`（日元），`USD`（美元）。<br>默认值： `USD`。 |
#|event_name |string| 事件名称。<br><br>名称不能超过 40 字符（不区分语言），不能包含 emoji。<br>默认值：`""`。 |
#|event_type {必填}|string| Pixel 事件类型。<br><br>支持的枚举值参见“[Pixel 事件类型 - Pixel 事件](1739585696931842.html)”小节中的“<b>用于广告创编的事件名称</b>”列。|
#|event_code |string| 事件代码。|
#|event_id |string| 事件 ID。|
#|statistic_type |string| 事件统计类型。<br><br>枚举值: `EVERY_TIME`（每一次）,`ONCE`（仅一次）。<br><br>如同一用户通过同一个广告产生两次转化行为，选择 `EVERY_TIME` 则统计值为 2，选择 `ONCE` 则统计值为 1。<br><br>默认值：`EVERY_TIME`。 |
#|rules |object[]| 追踪事件规则。<br><br>对应字段规则及含义见<a href="#item-link-事件规则类型">事件规则类型</a>小节。 |
##|trigger {必填}|string| 事件触发类型。<br><br>枚举值: `TRIGGERTYPE_CLICK`，`TRIGGERTYPE_PAGEVIEW`。 |
##|operator {必填}|string| 操作符。<br><br>枚举值: `OPERATORTYPE_CONTAINS`，`OPERATORTYPE_DOES_NOT_EQUAL`，`OPERATORTYPE_EQUALS`。|
##|value {必填}|string| 变量值。 |
##|variable {必填}|string| 变量类型。<br><br>枚举值: `ELEMENT`，`PAGE_HOSTNAME`，`PAGE_PATH`，`PAGE_URL`。|
|pixel_id {必填}|string| Pixel ID。 |
事件规则类型
对于每个 Pixel 事件，可指定事件规则（即一些列并列的条件，当这些条件都满足时便视作事件发生）。规则分为两种：Element click和Web browsing。每种规则对应不同的触发条件。
|trigger（规则）类型{28%}|可选 operator{26%}|可选 variable{23%}| value{23%} |
|---|---|---|---|
|`TRIGGERTYPE_CLICK`（元素点击）|`OPERATORTYPE_EQUALS`（等于）|`ELEMENT`（元素CSS选择器）| 填写 CSS 选择器的值，如 `"#my-element"`|
|`TRIGGERTYPE_PAGEVIEW`（网页浏览）|`OPERATORTYPE_CONTAINS`（包含）<br>`OPERATORTYPE_EQUALS`（等于）<br>`OPERATORTYPE_DOES_NOT_EQUAL`（不等于）|`PAGE_HOSTNAME`（域名）<br>`PAGE_PATH`（路径）<br>`PAGE_URL`（URL）| 域名/路径/URL 的值，如 `"tiktok.com"`（域名）或 `"/a/b"`（路径）|
举例说明：
1. trigger="TRIGGERTYPE_CLICK", operator="OPERATORTYPE_EQUALS", variable="ELEMENT", value="#my-element" 代表追踪页面上 ID 为 my-element 的元素的点击事件。
2. trigger="TRIGGERTYPE_PAGEVIEW", operator="OPERATORTYPE_CONTAINS",variable="PAGE_PATH", value="/a/b" 代表追踪页面路径（PAGE_PATH）包含（OPERATORTYPE_CONTAINS）/a/b 的网页浏览。
示例
(code curl http)
curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
"advertiser_id": "ADVERTISER_ID",
"pixel_events": [
{
"event_type": "EVENT_TYPE",
"event_id": "EVENT_ID",
"currency": "CURRENCY",
"statistic_type": "STATISTIC_TYPE",
"rules": [
{
"operator": "OPERATOR",
"variable": "VARIABLE",
"trigger": "TRIGGER",
"value": "VALUE"
}
],
"event_code": "EVENT_CODE",
"currency_value": "CURRENCY_VALUE",
"name": "NAME"
}
],
"pixel_id": "PIXEL_ID"
}' \
https://business-api.tiktok.com/open_api/v1.3/pixel/event/create/
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number|返回码，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)|
|message |string|返回信息，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)|
|data|object|返回数据|
|request_id |string|请求的日志 ID，唯一标识一个请求。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {},
"request_id": "202003181250360101890560280F44C7EF"
}
(/code);