获取线下事件组列表

您可以使用本接口获取广告账户下的线下事件组列表。支持使用的线下事件组的ID或名称筛选结果。

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

请求

地址 https://business-api.tiktok.com/open_api/v1.3/offline/get/

方法 GET

Header

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

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
|event_set_ids| string[]|用于筛选结果的线下事件组ID列表。<br>若未传入本字段，将返回广告账户下的所有线下事件组。|
|name|string|用于筛选结果的线下事件组名称。<br>长度限制：40个字符。<br>若您同时传入`event_set_ids`和`name`，则将在匹配到使用所指定的名称，且该线下事件组的ID在指定的线下事件组ID列表中时，获取一条结果，或未匹配到线下事件组时，获取0条结果。|

示例

(code curl http)
curl --location --request GET "https://business-api.tiktok.com/open_api/v1.3/offline/get/?advertiser_id={{advertiser_id}}" 
--header "Access-Token: {{Access-Token}}" 
(/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| 返回数据。 |
#|event_set_list|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": {
        "event_set_list": [
            {
                "name": "{{name}}",
                "advertiser_id": "{{advertiser_id}}",
                "update_time": "2022-12-08T06:50:37Z",
                "create_time": "2022-12-06T08:42:36Z",
                "event_set_id": "{{event_set_id}}",
                "auto_tracking": true,
                "description": "{{description}}"
            },
            {
                "name": "{{name}}",
                "advertiser_id": "{{advertiser_id}}",
                "update_time": "2022-12-07T14:45:07Z",
                "create_time": "2022-12-07T14:45:07Z",
                "event_set_id": "{{event_set_id}}",
                "auto_tracking": true,
                "description": "{{description}}"
            }
        ]
    }
}
(/code)