根据 ID 获取地域定向标签的信息
您可以使用本接口根据 ID 获取定向标签的信息。
您可获取三种定向标签的详情:邮政编码 ID(目前仅支持美国、加拿大、巴西、印度尼西亚、泰国、越南)、地域 ID 或互联网服务提供商 ID。
请查看下文的“不同的定向标签所需的参数设置”小节,了解获取不同定向标签时需要传入的参数的对比。
注意
- 欲获取邮政编码 ID 的信息,您仅可使用本接口,不支持使用/too/region/。
- 本接口需使用 POST 方法,因为 GET 请求会导致 URL 长度受限。
请求
地址: https://business-api.tiktok.com/open_api/v1.3/tool/targeting/info/
方法: 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。 |
|scene| string |所指定的`targeting_ids`适用的定向类型。 <br>枚举值:<ul><li>`GEO` :地理位置定向,包括行政区域定向和邮政编码定向。</li><li>`ISP` :互联网服务提供商定向。</li></ul><br>默认值:`GEO`。|
|targeting_ids {必填}|string[]|定向标签ID列表。<br>您可传入地域ID,邮政编码ID,地域ID和邮政编码ID的组合,或互联网服务提供商ID。<br>最大数量: 1000。<br>您可通过[/tool/targeting/search/](https://ads.tiktok.com/marketing_api/docs?id=1761236883355649)返回的`geo_id`获取地域ID或邮政编码ID,或通过[/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713)返回的`location_id`获取地域ID。<br>您可通过[/tool/targeting/list/](https://ads.tiktok.com/marketing_api/docs?id=1762962378261506)返回的`isp_id`获取互联网服务提供商ID。|
| objective_type{+条件必填} | string | 当`scene`设置为`GEO`时必填。<br>推广目标。<br>允许的枚举值:`REACH`,`TRAFFIC`,`VIDEO_VIEWS`,`LEAD_GENERATION`,`ENGAGEMENT`,`APP_PROMOTION`,`WEB_CONVERSIONS`,`PRODUCT_SALES`。<br>枚举值的描述请查看[推广目标](https://ads.tiktok.com/marketing_api/docs?id=1737585562434561)。|
|promotion_type {+条件必填} |string|当`scene`设置为`GEO`,且`objective_type`不是`REACH`,`VIDEO_VIEWS`或`ENGAGEMENT`时必填。<br>推广对象类型。<br>枚举值详见 [枚举值-推广对象类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
|placements {+条件必填}|string[]|当`scene`设置为`GEO`时必填。<br>广告版位。枚举值请查看[枚举值-版位](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br><p><span style="color:darkred"><b>注意</b></span>:若您希望获取可用于邮政编码定向的邮政编码ID的信息,本字段的值需包含`PLACEMENT_TIKTOK`。 |
| operating_system | string | 当`scene`设置为`GEO`时生效。<br>想要定向的受众设备的操作系统。枚举值:`ANDROID`,`IOS`。|
|brand_safety_type|string|品牌安全类型。仅当`scene`设置为`GEO`,且`placements`设置为`PLACEMENT_TIKTOK`时生效。默认值:`NO_BRAND_SAFETY`。枚举值: <ul><li>`NO_BRAND_SAFETY`:不使用任何品牌安全解决方案,即使用<strong>全部库存</strong>。您的广告可能会在某些包含成人主题的内容周围展示。</li><li>`EXPANDED_INVENTORY`:使用TikTok的品牌安全解决方案,即使用<b>扩展库存</b>。您的广告将不会出现在不当内容或包含成人主题的内容后面。在下个API版本中`EXPANDED_INVENTORY`将替代`NO_BRAND_SAFETY`,并成为默认的品牌安全选项。</li><li>`STANDARD_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>标准库存</strong>。您的广告将展示在适合大多数品牌的内容周围。 </li><li>`LIMITED_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>有限库存</strong>。您的广告将展示在不包含成人主题的内容周围。</li><li>`THIRD_PARTY`:使用第三方品牌安全解决方案。若选择本选项,您需要向`brand_safety_partner`字段传入第三方合作伙伴名称。</li></ul>您可以使用[/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713)接口查询品牌安全设置对应的广告可投放国家或地区。<br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>出价前第三方品牌安全解决方案和在使用`APP_PROMOTION`,`WEB_CONVERSIONS`,`TRAFFIC`和`LEAD_GENERATION`推广目标的竞价广告中应用出价前第一方品牌安全解决方案目前均为白名单功能。如需使用此功能,请联系您的TikTok销售代表。</li><li> 请查看[品牌安全](https://ads.tiktok.com/marketing_api/docs?id=1739381752981505),了解出价前品牌安全筛选的支持推广目标。</li></ul>|
|brand_safety_partner{+条件必填}|string|品牌安全合作伙伴。只有在品牌安全为第三方(`brand_safety_type` = `THIRD_PARTY`)时必填。枚举值:`IAS`, `OPEN_SLATE`(该合作伙伴在TikTok广告管理平台的对应名称为<strong>DoubleVerify</strong>,因为该合作伙伴已被DoubleVerify收购)。如果需要获取自己的品牌安全设置可以投放的国家和地区,您可以使用`/tool/region/`接口。您需要传入品牌安全类型和品牌安全合作伙伴。<br><p><span style="color:darkred"><b>注意</b></span>:出价前第三方品牌安全解决方案目前为白名单功能。如需使用此功能,请联系您的TikTok销售代表。|
不同的定向标签所需的参数设置
请查看下表,了解通过本接口获取不同的定向标签时需要传入的请求参数。对于某种定向标签,请求参数可能为必填(✅),选填(✔)或不支持(❌)。
``xtable
| 字段{25%} | 邮政编码ID{25%} | 地域ID{25%} | 互联网服务提供商ID {25%} |
|---|--|---|---|
|advertiser_id| ✅ | ✅ | ✅ |
|scene| ✅ <br>必须设置为GEO。| ✅ <br>必须设置为GEO。| ✅ <br>必须设置为ISP。|
|targeting_ids| ✅ | ✅ | ✅ |
|objective_type| ✅ | ✅ | ❌ |
|promotion_type| ✔ | ✔ | ❌ |
|placements| ✅ | ✅ | ❌ |
|operating_system| ✔ | ✔ | ❌ |
|brand_safety_type| ✔ | ✔ | ❌ |
|brand_safety_partner` | ✔ | ✔ | ❌ |
### 示例-获取邮政编码ID的信息
```xcodeblock
(code curl http)
curl --location "https://business-api.tiktok.com/open_api/v1.3/tool/targeting//info/" \
--header "Access-Token: {{Access-Token}}" \
--header "Content-Type: application/json" \
--data "{
"advertiser_id":"{{advertiser_id}}",
"objective_type":"{{objective_type}}",
"promotion_type":"{{promotion_type}}",
"placements":["PLACEMENT_TIKTOK","PLACEMENT_PANGLE"],
"targeting_ids":["8840000454548","8840000454525"]
}"
(/code)
示例-获取互联网服务提供商定向ID的信息
(code curl http)
curl --location "https://business-api.tiktok.com/open_api/v1.3/tool/targeting//info/"
--header "Access-Token: {{Access-Token}}"
--header "Content-Type: application/json"
--data "{
"advertiser_id":"{{advertiser_id}}",
"scene":"ISP",
"targeting_ids":["EG00045"]
}"
(/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| 返回数据。 |
#| targeting_tag_list | object[] |所指定的定向标签ID所匹配到的定向标签的信息。 |
##| targeting_type | string | 定向标签所适用的定向类型。<br>枚举值:<ul><li>`GEO` :地理位置定向,包括行政区域定向和邮政编码定向。</li><li>`ISP` :互联网服务提供商定向。</li> |
##| name | string | 定向标签的名称。|
##| status_info | object | 定向标签的状态信息。|
###| status | string |定向标签的状态。<br>枚举值: `ENABLED`(可用于定向), `DISABLED`(不可用于定向)。|
###| reason | string | 定向标签不可用于定向的原因。<br>仅当`status`为`DISABLED`时返回。<br>枚举值:<ul><li> `OFFLINE`:该定向标签已下线。 </li><li> `NOT_SUPPORTED`:该定向标签未下线,但在所选的设置下不支持。</li></ul> |
##| geo | object | 用于地域定向的定向标签的信息。<br>当`targeting_type`为`GEO`时返回。|
###| geo_id | string | 地域ID或邮政编码ID。 <br>地域ID可用于行政区域定向,邮政编码ID则可用于邮政编码定向。<ul><li>当对应的 `geo_type`为`ZIP_CODE`时,本字段的值为邮政编码ID,可在调用[/adgroup/create/](https://ads.tiktok.com/marketing_api/docs?id=1739499616346114),[/adgroup/update/](https://ads.tiktok.com/marketing_api/docs?id=1739586761631745),或[/ad/audience_size/estimate/](https://ads.tiktok.com/marketing_api/docs?id=1740302379236353)时传给`zipcode_ids`字段。</li><li> 当对应的 `geo_type`非 `ZIP_CODE`时,本字段的值为地域ID,可在调用[/adgroup/create/](https://ads.tiktok.com/marketing_api/docs?id=1739499616346114),[/adgroup/update/](https://ads.tiktok.com/marketing_api/docs?id=1739586761631745),或[/ad/audience_size/estimate/](https://ads.tiktok.com/marketing_api/docs?id=1740302379236353)时传给`location_ids` 字段。</li></ul>|
###| geo_type | string |`geo_id`对应的地域类型。<br>枚举值:`COUNTRY`(国家或地区),`PROVINCE`(省),`CITY`(城市),`DISTRICT`(区),`DMA`(指定市场区域),`ZIP_CODE`(邮政编码对应地域)。|
###| description | string | 所定向地域的描述。|
###| region_code | string | 该定向地域所属的国家或地区的代码。|
###| parent_id | string |父层级地域的ID。<br>若无对应父层级地域,则返回`0`。|
##| isp | object | 用于互联网服务提供商定向的定向标签的信息。<br>当`targeting_type`为`ISP`时返回。 |
###| isp_id | string | 可定向的互联网服务提供商ID。 |
###| location_id | string | 可与该`isp_id`同时使用的地域ID。<br>仅支持国家或地区层级的地域ID。 |
###| region_code | string | `isp_id` 所对应的国家或地区代码。 |
#| parent_tags | object[] | 所有父层级定向标签的相关信息。 |
##| targeting_type | string | 该父层级定向标签所适用的定向类型。<br>枚举值: `GEO `(地理位置定向,包括行政区域定向和邮政编码定向)。|
##| name | string | 该父层级定向标签的名称。|
##| status_info | object | 该父层级定向标签的状态信息。|
###| status | string | 该父层级定向标签的状态。<br>枚举值: `ENABLED` (可用于定向),`DISABLED`(不可用于定向)。 |
###| reason | string | 该父层级定向标签不可用于定向的原因。<br>仅当`status`为`DISABLED`时返回。<br>枚举值:<ul><li>`OFFLINE`:该父层级定向标签已下线。</li><li>`NOT_SUPPORTED`:该父层级定向标签未下线,但在所选的设置下不支持。</li></ul> |
##| geo | object |用于地域定向的父层级定向标签的信息。<br>当`targeting_type`为`GEO`时返回。 |
###| geo_id | string | 父层级地域ID或邮政编码ID。<ul><li> 当对应的 `geo_type`为`ZIP_CODE`时,本字段的值可在调用[/adgroup/create/](https://ads.tiktok.com/marketing_api/docs?id=1739499616346114),[/adgroup/update/](https://ads.tiktok.com/marketing_api/docs?id=1739586761631745),或[/ad/audience_size/estimate/](https://ads.tiktok.com/marketing_api/docs?id=1740302379236353)时传给`zipcode_ids`字段。</li><li> 当对应的 `geo_type`非 `ZIP_CODE`时,本字段的值可在调用[/adgroup/create/](https://ads.tiktok.com/marketing_api/docs?id=1739499616346114),[/adgroup/update/](https://ads.tiktok.com/marketing_api/docs?id=1739586761631745),或[/ad/audience_size/estimate/](https://ads.tiktok.com/marketing_api/docs?id=1740302379236353)时传给`location_ids` 字段。</li></ul>|
###| geo_type | string | `geo_id`对应的地域类型。<br>枚举值:`COUNTRY`(国家或地区),`PROVINCE`(省),`CITY`(城市),`DISTRICT`(区),`DMA`(指定市场区域),`ZIP_CODE`(邮政编码对应地域)。 |
###| description | string | 该父层级地域的描述。 |
###| region_code | string | 该父层级地域所属的国家或地区的代码。|
###| parent_id | string | 该父层级地域所对应的父层级地域的ID。<br>若无对应父层级地域,则返回`0`。 |
示例-获取邮政编码ID的信息
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"parent_tags": [
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "United States",
"geo": {
"region_code": "US",
"geo_type": "COUNTRY",
"description": "state",
"parent_id": "0",
"geo_id": "6252001"
},
"targeting_type": "GEO"
},
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "Wisconsin",
"geo": {
"region_code": "US",
"geo_type": "PROVINCE",
"description": "State",
"parent_id": "6252001",
"geo_id": "5279468"
},
"targeting_type": "GEO"
},
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "Oneida County",
"geo": {
"region_code": "US",
"geo_type": "CITY",
"description": "County",
"parent_id": "5279468",
"geo_id": "5265726"
},
"targeting_type": "GEO"
},
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "Minocqua",
"geo": {
"region_code": "US",
"geo_type": "DISTRICT",
"description": "City",
"parent_id": "5265726",
"geo_id": "5263156"
},
"targeting_type": "GEO"
},
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "Iron County",
"geo": {
"region_code": "US",
"geo_type": "CITY",
"description": "County",
"parent_id": "5279468",
"geo_id": "5257533"
},
"targeting_type": "GEO"
},
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "Gile",
"geo": {
"region_code": "US",
"geo_type": "DISTRICT",
"description": "City",
"parent_id": "5257533",
"geo_id": "116027566"
},
"targeting_type": "GEO"
}
],
"targeting_tag_list": [
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "54548",
"geo": {
"region_code": "US",
"geo_type": "ZIP_CODE",
"description": "postcode",
"parent_id": "5263156",
"geo_id": "8840000454548"
},
"targeting_type": "GEO"
},
{
"status_info": {
"status": "ENABLED",
"reason": null
},
"name": "54525",
"geo": {
"region_code": "US",
"geo_type": "ZIP_CODE",
"description": "postcode",
"parent_id": "116027566",
"geo_id": "8840000454525"
},
"targeting_type": "GEO"
}
]
}
}
(/code)
示例-获取互联网服务提供商定向ID的信息
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"targeting_tag_list": [
{
"status_info": {
"reason": null,
"status": "ENABLED"
},
"targeting_type": "ISP",
"geo": null,
"isp": {
"region_code": "EG",
"isp_id": "EG00045",
"location_id": "357994"
},
"name": "Etisalat Misr"
}
],
"parent_tags": []
}
}
(/code)