← 返回目录
📁 API Reference › Events 1.0 › Pixel Events

获取Pixel列表

您可以使用本接口获取Pixel列表。

重要提示
使用事件 API 接口代表您同意遵守TikTok 商业产品（数据）条款，并且不会与 TikTok 分享敏感数据。

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。 ``xtable |变化内容{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径| /v1.2/pixel/list/| /v1.3/pixel/list/| |请求参数类型|advertiser_id: number <br>pixel_id: number |advertiser_id: string <br>pixel_id: string | |新增请求参数|/ |filtering<br>available_for_catalog_only| |返回参数名称|external_action|optimization_event| |返回参数类型|pixel_id: number <br>create_time: number<br>event_id: number |pixel_id: string <br>create_time: string <br>event_id: string | |返回参数名称与类型|owned_by: number |owner_bc_id: string | |新增返回参数|/ |pixel_category<br>custom_event_type<br>ownership_status<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/list/

**方法** GET

**请求Header**

```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

请求参数

|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|code |string| Pixel 代码。如传入则按照 Pixel 代码进行筛选。 |
|pixel_id |string| Pixel ID。如传入则按照 Pixel ID 进行筛选。 |
|name |string| Pixel 名称。模糊匹配，如传入则筛选名称包含传入数据的 Pixel。 |
|order_by |string| 排序方式。枚举值: `EARLIEST_CREATE`（最早创建优先）,`LATEST_CREATE`（最晚创建优先）。 默认值: `EARLIEST_CREATE`。|
|filtering|object|筛选条件。 |
#|available_for_catalog_only|boolean|Pixel 是否可作为事件源与商品库绑定。默认值：`false`。若想将Pixel与商品库绑定，您可以使用[/catalog/eventsource/bind/](https://ads.tiktok.com/marketing_api/docs?id=1740492491200513)。|
|page |number|当前页数。默认值: `1`。取值范围: ≥ 1。|
|page_size |number|分页大小。默认值: `10`。取值范围: 1-20。|

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/pixel/list/?advertiser_id={{advertiser_id}}&pixel_id={{pixel_id}}' \
--header 'Access-Token: {{Access-Token}}' \
(/code)

返回

|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|code |number|返回码，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data |object|返回数据。  |
#|pixels|object[]| Pixel 列表。 |
##|pixel_id |string| Pixel ID。 |
##|pixel_code |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><p><span style="color:darkred"><b>注意</b></span>：无论是否为 Pixel 设置了本字段，都不再影响 Pixel 可以追踪的 Pixel 事件。本字段将在下一个 API 版本中废弃。|
##|pixel_script |string| Pixel 代码，由系统生成，您需要将 Pixel 代码安装到您的网站以进行事件追踪。见 [帮助中心](https://ads.tiktok.com/help/article?aid=6669727593823993861) |
##|create_time |string| 创建时间的时间戳（如 1581679723600）。 |
##|pixel_setup_mode| string|Pixel安装模式。枚举值: `STANDARD` (标准模式), `DEVELOPER` (开发者模式)。2022年9月15日后使用`/pixel/create/`接口创建的所有Pixel都是开发者模式。|
##|partner_name|string| 合作商家名。|
##|advanced_matching_fields|object|该 Pixel 的手动高级匹配设置。|
###|phone_number|boolean|是否为电话号码启用手动高级匹配。<br><br>支持的值： `true`，`false`。|
###|email|boolean|是否为电子邮件启用手动高级匹配。<br><br>支持的值： `true`，`false`。|
##|automatic_advanced_matching_fields|object|该 Pixel 的自动高级匹配设置。<br>自动高级匹配功能自动使用通过 TikTok Pixel 收集的客户信息，如电子邮箱、姓名和电话号码，从而改善匹配率、转化监测和再营销。|
###|phone_number|boolean|是否为电话号码启用自动高级匹配。<br><br>支持的值： `true`，`false`。|
###|email|boolean|是否为电子邮箱启用自动高级匹配。<br><br>支持的值： `true`，`false`。|
###|name|boolean|是否为姓名启用自动高级匹配。<br><br>支持的值： `true`，`false`。|
###|address|boolean|是否为地址启用自动高级匹配。<br><br>支持的值： `true`，`false`。|
###|external_id|boolean|是否为外部 ID 启用自动高级匹配。<br><br>支持的值： `true`，`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`，`false`。|
##|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`，`false`。|
##|asset_ownership|object| 资产所有权数据。|
###| asset_relation_status | string | 资产关系状态。<br><br>枚举值: <ul><li> null: 该 Pixel 为当前广告主（`advertiser_id`）所有，且尚未作为资产转移至商务中心中。 </li><li>`TRANSFERRED`: 该 Pixel 已作为资产转移至商务中心中，但仍为当前广告主（`advertiser_id`）所有。若想转移 Pixel，可使用[/bc/pixel/transfer/](1753994928261122.html)。 </li><li> `SHARED`: 该 Pixel 已作为资产分享给当前广告主（`advertiser_id`）。对于由他人分享的资产 Pixel ，你可以修改，但是不能删除。</li><li>`UNBOUND`: 该 Pixel 之前作为资产分享给当前广告主（`advertiser_id`），但已与当前广告主解绑。在统计数据中，状态为`UNBOUND` 的资产不会被计入。</li></ul>|
###| ownership_status | boolean | 该 Pixel 是否为当前广告主（`advertiser_id`）所 有。<br><br>枚举值：`true`，`false`。<br><br><ul><li>若 `asset_relation_status` 字段的值为 null 或 `TRANSFERRED`，本字段的值将为 `true`。</li><li>若 `asset_relation_status` 字段的值为 `SHARED` 或`UNBOUND`，本字段的值将为 `false`。 </li></ul> |
###| owner_bc_id | string | 以资产形式拥有该 Pixel 的商务中心 ID。<br><br><ul><li>若 `asset_relation_status` 为`TRANSFERRED`，本字段的值代表以资产形式将该 Pixel 转移至的商务中心的 ID。</li><li>若 `asset_relation_status` 不为 `TRANSFERRED`，本字段的值将为 null。</li></ul>|
###|updated_at{-即将废弃}|integer|最后一次关系形成的时间。使用Unix时间戳格式(例如 1581679723600）。<br><p><span style="color:darkred"><b>注意</b></span>：本字段将在下次版本升级中废弃，您目前可能无法从该字段获取有效时间。|
##|events |object[]| Pixel 事件列表。<br>Pixel 事件数据每 2-4 小时刷新一次。如果事件在四小时内发生，本字段的值可能为空列表（`[]`）。您可以在四小时后重试，以获取这些事件的数据。|
###|currency_value |string| 转化价值（若创建时不传入则返回`""`）。 |
###|currency |string| 转化价值对应币种，枚举值: `INR`(印度卢比),`JPY`(日元),`USD`(美元)。 |
###|name |string| 事件名称。 |
###|deprecated|boolean| 该事件是否已被废弃。|
###|event_type |string| 仅当事件为标准网站事件（Pixel 事件）时返回。<br><br>标准网站事件类型。<br><br>本字段的枚举值参见[Pixel 事件类型- Pixel 事件](1739585696931842.html)小节中的“<b>用于广告创编的事件名称</b>”列。 |
###|optimization_event |string| 标准网站事件（`event_type`）对应的转化事件类型。您可在使用[/adgroup/create/](1739499616346114.html)创建广告组时将转化事件传入`optimization_event`字段。<br><br>本字段的枚举值参见[Pixel 事件类型- Pixel 事件](1739585696931842.html)小节中的“<b>用于广告创编的事件名称</b>”列。<br><br><p><span style="color:darkred"><b>注意</b></span>：标准网站事件`PAGE_VIEW` 不可用于优化。因此， `event_type` 为 `PAGE_VIEW` 时，本字段值将为 null。 |
###| custom_event_type | string | 仅当事件为自定义网站事件时返回。 <br> <br>自定义网站事件类型。 自定义事件是 TikTok 合作伙伴可以在预定义的标准事件列表外自定义的行为。若想了解自定义事件的详情，请查看[标准事件和自定义事件](https://ads.tiktok.com/help/article/standard-events-parameters?lang=zh)。  <br> <br>不支持使用[/pixel/event/create/](1740858807646209.html)创建自定义网站事件，但支持使用事件 1.0 接口[/pixel/track/](1740858531237890.html)或[/pixel/batch/](1740858565852225.html)，或事件 2.0 接口[/event/track/](1771101303285761.html)直接回传自定义网站事件。 例如，若回传 `SHOPPING` 事件，则该事件视作自定义事件，因为该事件类型未在[事件 API 1.0 - 报告网站事件和参数 - 支持的网站事件](https://business-api.tiktok.com/portal/docs?id=1741601162187777#item-link-支持的网站事件)或[事件 API 2.0 - 支持的事件 - 网站标准事件](https://business-api.tiktok.com/portal/docs?id=1771101186666498#item-link-网站标准事件)中的“<b>事件</b>”列列出。 |
###|event_code |string| 事件代码。|
###|event_id |string| 事件 ID 。|
###|statistic_type |string| 统计类型，枚举值: `EVERY_TIME`（每一次）,`ONCE`（仅一次）。 |
###|rules |object[]| 追踪事件规则，子字段规则及含义见 [Pixel事件类型-事件规则类型](https://ads.tiktok.com/marketing_api/docs?id=1739585696931842)。 |
####|operator |string| 操作符，枚举值: `OPERATORTYPE_CONTAINS`,`OPERATORTYPE_DOES_NOT_EQUAL`,`OPERATORTYPE_EQUALS`。|
####|trigger |string| 事件触发类型，枚举值: `TRIGGERTYPE_CLICK`,`TRIGGERTYPE_PAGEVIEW`。 |
####|value |string| 变量值。 |
####|variable |string| 变量类型，枚举值: `ELEMENT`,`PAGE_HOSTNAME`,`PAGE_PATH`,`PAGE_URL`。|
#|page_info |object | 分页信息。|
##|page |number | 当前页数。 |
##|page_size |number | 分页大小。 |
##|total_number |number | 总数。 |
##|total_page |number | 总页数。 |
|request_id |string|请求的日志 ID，唯一标识一个请求。  |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "page_info": {
            "page": 1,
            "page_size": 20,
            "total_number": 1,
            "total_page": 1
        },
        "pixels": [
            {
                "activity_status": "NO_RECENT_ACTIVITY",
                "advanced_matching_fields": {
                    "email": true,
                    "phone_number": true
                },
                "asset_ownership": {
                    "ownership_status": true,
                    "updated_at": 0
                },
                "automatic_advanced_matching_fields": {
                    "address": true,
                    "email": false,
                    "external_id": true,
                    "name": true,
                    "phone_number": true
                },
                "create_time": "{{create_time}}",
                "enable_expanded_data_sharing": true,
                "enable_first_party_cookies": true,
                "events": [],
                "pixel_category": "CUSTOMIZE_EVENTS",
                "pixel_code": "{{pixel_code}}",
                "pixel_id": "{{pixel_id}}",
                "pixel_name": "{{pixel_name}}",
                "pixel_script": "{{pixel_script}}",
                "pixel_setup_mode": "DEVELOPER"
            }
        ]
    }
}
(/code)
← Pixel 事件报告单个网站事件 →

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