获取自定义转化的详情
您可以使用本接口检索与 Pixel 或应用关联的自定义转化的详细信息。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/custom_conversion/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
|advertiser_id {必填}|string|广告主 ID。|
|custom_conversion_id {必填}|string|自定义转化的 ID。<br>要获取与 Pixel 或应用关联的自定义转化列表，可使用[/custom_conversion/list/](1842225174460673.html)。|
|event_source_type {必填}|string|事件源类型。<br><br>枚举值:<ul><li>`PIXEL`: Pixel。</li><li>`APP`: 应用。</li></ul>|
|event_source_id {必填}|string|事件源 ID。<br><br><ul><li>当 `event_source_type` 为 `PIXEL` 时，指定一个 Pixel ID。<ul><li>要获取广告账户中的 Pixel ID，可使用[/pixel/list/](1740858697598978.html)并检查返回的`pixel_id`。</li></ul></li><li>当 `event_source_type` 为 `APP` 时，指定自归因网络应用的应用平台 ID。<ul><li>要获取广告账户中自归因应用的应用平台 ID，可使用[/app/list/](1740859313270786.html)。确认应用的 `self_attribution_enabled` 返回值为 `true` 并检查返回的 `app_platform_id`。</li></ul></li></ul>|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/custom_conversion/get/?advertiser_id={{advertiser_id}}&event_source_type=PIXEL&event_source_id={{event_source_id}}&custom_conversion_id={{custom_conversion_id}}' \
--header 'Access-token: {{Access-token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述参见[附录-返回码](1737172488964097.html)。 |
|message|string|返回信息。更多信息参见[附录-返回码](1737172488964097.html)。|
|request_id |string|请求的日志 ID，唯一标识一个请求。 |
|data|object|返回数据。|
#|custom_conversion_id|string|自定义转化的 ID。|
#|name|string|自定义转化的名称。|
#|description|string|自定义转化的描述。|
#|event_source_type|string|事件源类型。<br><br>枚举值:<ul><li>`PIXEL`: Pixel。</li><li>`APP`: 应用。</li></ul>|
#|event_source_id|string|事件源 ID。<br><br><ul><li>当 `event_source_type` 为 `PIXEL` 时，指定一个 Pixel ID。<ul><li>要获取广告账户中的 Pixel ID，可使用[/pixel/list/](1740858697598978.html)并检查返回的`pixel_id`。</li></ul></li><li>当 `event_source_type` 为 `APP` 时，指定自归因网络应用的应用平台 ID。<ul><li>要获取广告账户中自归因应用的应用平台 ID，可使用[/app/list/](1740859313270786.html)。确认应用的 `self_attribution_enabled` 返回值为 `true` 并检查返回的 `app_platform_id`。</li></ul></li></ul>|
#|activity_status|string|自定义转化的活跃状态。<br><br>枚举值:<ul><li>`NO_RECENT_ACTIVITY`: 近期无活动。已收到回传活动，但并非是在过去 7 天内收到。</li><li>`ACTIVE`: 活跃。在过去 7 天内收到回传活动。</li><li>`WAITING_FOR_ACTIVITY`: 不活跃。过去 90 天内未收到回传活动。</li></ul>|
#|optimization_event|string|与自定义转化关联的转化事件（标准事件）。<br><br>枚举值参阅[ `optimization_event` 的可选值](https://business-api.tiktok.com/portal/docs?id=1842225226006530#item-link-optimization_event%20的可选值)。|
#|rules|object[]|自定义转化的转化规则详情。<br><br>只有满足这些条件的操作才会计为自定义转化。|
##|parameter|string|参数。<br><br>枚举值:<ul><li>`BRAND`: `brand`。</li><li>`CONTENT_CATEGORY`: `content_category`。</li><li>`CONTENT_ID`: `content_id`。</li><li>`CONTENT_NAME`: `content_name`。</li><li>`CONTENT_TYPE`: `content_type`。</li><li>`CURRENCY`: `currency`。</li><li>`DESCRIPTION`: `description`。</li><li>`EVENT_ID`: `event_id`。</li><li>`NUM_ITEMS`: `num_items`。</li><li>`PRICE`: `price`。</li><li>`SEARCH_STRING`: `search_string`。</li><li>`STATUS`: `status`。</li><li>`URL`: `url`。</li><li>`VALUE`: `value`。</li></ul>|
##|operator|string|运算符。<br><br><ul><li>当 `parameter` 为 `BRAND`、`CONTENT_CATEGORY`、`CONTENT_ID`、`CONTENT_NAME`、`CONTENT_TYPE`、`DESCRIPTION`、`EVENT_ID`、`SEARCH_STRING`、`STATUS` 或 `URL` 时，枚举值为:<ul><li>`CONTAIN`: 包含。</li><li>`NOT_CONTAIN`: 不包含。</li><li>`START_WITH`: 开头是。</li><li>`EQUAL`: 等于。</li><li>`NOT_EQUAL`: 不等于。</li></ul></li><li>当 `parameter` 为 `NUM_ITEMS`、`PRICE` 或 `VALUE` 时，枚举值为:<ul><li>`EQUAL`: 等于。</li><li>`NOT_EQUAL`: 不等于。</li><li>`LT`: 小于。</li><li>`GT`: 大于。</li><li>`LTE`: 小于或等于。</li><li>`GTE`: 大于或等于。</li></ul></li><li>当 `parameter` 为 `CURRENCY` 时，枚举值为:<ul><li>`EQUAL`: 等于。</li><li>`NOT_EQUAL`: 不等于。</li></ul></li></ul>|
##|values|string[]|参数的值。<br><br><ul><li>当 `parameter` 为 `BRAND`、`CONTENT_CATEGORY`、`CONTENT_ID`、`CONTENT_NAME`、`CONTENT_TYPE`、`DESCRIPTION`、`EVENT_ID`、`SEARCH_STRING`、`STATUS`、`URL` 时，该字段将是一个字符串数组，每个字符串的最大长度为 100 个字符，最多 100 个条目。</li><li>当 `parameter` 为 `NUM_ITEMS` 时，该字段将是一个介于 0 和 1,000,000,000 之间的整数。</li><li>当 `parameter` 为 `PRICE`、`VALUE` 时，该字段将是一个保留两位小数的浮点数，取值范围为 0.00到 1,000,000,000.00。</li><li>当 `parameter` 为 `CURRENCY` 时，该字段将是一个字符串数组。要了解枚举值，请参阅[币种的可选值](https://business-api.tiktok.com/portal/docs?id=1842225226006530#item-link-币种的可选值)。|
##|create_time|string|自定义转化的创建时间，格式为`YYYY-MM-DD HH:MM:SS`(UTC+0)。<br><br>示例: `2025-01-01 00:00:01`。|
##|update_time|string|自定义转化上次更新的时间，格式为`YYYY-MM-DD HH:MM:SS`(UTC+0)。<br><br>示例: `2025-01-01 00:00:01`。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"activity_status": "WAITING_FOR_ACTIVITY",
"create_time": "{{create_time}}",
"custom_conversion_id": "{{custom_conversion_id}}",
"description": "{{description}}",
"event_source_id": "{{event_source_id}}",
"event_source_type": "PIXEL",
"name": "{{name}}",
"optimization_event": "SHOPPING",
"rules": [
{
"operator": "NOT_CONTAIN",
"parameter": "EVENT_ID",
"values": [
"{{event_id}}",
"{{event_id}}"
]
},
{
"operator": "START_WITH",
"parameter": "DESCRIPTION",
"values": [
"{{description_value}}"
]
}
],
"update_time": "{{update_time}}"
}
}
(/code)