更新线下事件组
您可以使用本接口更新线下事件组的名称,自动监测设置,或同时更新名称和自动监测设置。
重要提示
使用事件 API 接口代表您同意遵守TikTok 商业产品(数据)条款,并且不会与 TikTok 分享敏感数据。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/offline/update/
方法 POST
Header
|字段{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。 |
| event_set_id {必填} | string | 想要更新的线下事件组的ID。<br>您可使用[/offline/get/](https://ads.tiktok.com/marketing_api/docs?id=1765596808589313)获取广告账户下的线下事件组ID。 |
| name | string | 线下事件组的新名称。 <br>长度限制:40个字符。 <br>示例:in_store_purchases。 <br><p><span style="color:darkred"><b>注意</b></span>:不支持指定其他线下事件组已使用的 名称。否则,将出现报错。 |
| auto_tracking | boolean | 是否开启自动监测。<br>枚举值:`true`,`false`。<br>如果本字段设置为`true`,今后在本广告主账户下新建的所有推广系列都会将该线下事件组用于广告监测和归因。<br><p><span style="color:darkred"><b>注意</b></span>:单个广告账户下最多创建10个开启自动监测的线下事件组。若达到上限,将无法再为非自动监测的线下事件组开启自动监测。不过您可以使用[/offline/delete/](https://ads.tiktok.com/marketing_api/docs?id=1765596790860802)删除现有的线下事件组。 |
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/offline/update/'
--header 'Access-Token: {{Access-Token}}'
--header 'Content-Type: application/json'
--data-raw '{
"advertiser_id":"{{advertiser_id}}",
"event_set_id":"{{event_set_id}}",
"auto_tracking":"true"
}'
(/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)。 |
|request_id |string| 请求的日志ID,唯一标识一个请求。 |
|data |object| 返回数据。 |
#| advertiser_id | string | 广告主ID。 |
#| event_set_id| string | 线下事件组ID。 |
#| name | string | 线下事件组的名称。 |
#| description | string | 线下事件组的描述。<br>若未设置描述,将返回`""`。 |
#| auto_tracking | boolean | 该线下事件组是否开启了自动监测。 |
#| create_time | string | 该线下事件组创建的时间,以[ISO 8601](https://zh.wikipedia.org/wiki/ISO_8601)格式表示。 <br>示例:`2023-04-15T00:23:38Z`。 |
#| update_time | string | 该线下事件组最后一次更新的时间,以[ISO 8601](https://zh.wikipedia.org/wiki/ISO_8601)格式表示。<br> 示例:`2023-04-15T00:23:38Z`。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"name": "{{name}}",
"advertiser_id": "{{advertiser_id}}",
"update_time": "2023-05-05T09:53:02Z",
"create_time": "2023-05-05T09:51:47Z",
"event_set_id": "{{event_set_id}}",
"auto_tracking": true,
"description": "{{description}}"
}
}
(/code)