基于广告主 ID 获取可投放地域
您可以使用本接口获取基于广告主ID的可以投放广告的地域。
若您希望基于推广目标、版位、定向受众设备操作系统以及品牌安全设置来获取可以推广的国家或地区代码,请使用/tool/region/接口。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/search/region/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
| advertiser_id {必填} | string | 广告主ID。 |
| language | string | 您希望返回的地域名称所显示的语言。 默认值: `en`<br>目前,我们仅支持 `zh`, `fr`, `es`, `ko`, `vi`, `en`, `hi`, `it`, `tr`, `ru`, `ja`, `id`, `de`, `ms`, `ar`, `th`<br><p><span style="color:darkred"><b>注意</b></span>:如果您没有传入以上值之一,系统将默认处理为默认的`en`。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/search/region/' \
--header 'Content-Type: application/json' \
--header 'Access-Token: {{Access-Token}}' \
--data-raw '{
"advertiser_id": "{{advertiser_id}}",
"language": "ja"
}'
(/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)。 |
|data |object| 返回数据。 |
#|region_list|object[]|可投放地域列表。|
##|region_id|string|地域ID。 |
##|region_name|string|地域名称。|
##|region_level|string|地域层级。枚举值:`COUNTRY`(国家或地区级), `PROVINCE`, `CITY`, `DISTRICT`。<br> 指定市场区域以及都会区属于省级地域。|
##|country_code|string|地域所属的国家代码。|
##|parent_id|string|上级地域ID。如果没有上级地域,则不返回。|
##|area_type|string|地域类型。枚举值: `ADMIN`, `METROPOLITAN_OR_DMA`。|
##|support_below_18|boolean|该地域是否支持向18岁以下人群投放广告。|
|request_id |string| 请求的日志ID,唯一标识一个请求。 |
示例
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"region_list": [
{
"region_level": "COUNTRY",
"support_below_18": true,
"country_code": "US",
"area_type": "ADMIN",
"region_id": "6252001",
"region_name": "アメリカ"
},
{
"region_level": "COUNTRY",
"support_below_18": true,
"country_code": "EC",
"area_type": "ADMIN",
"region_id": "3658394",
"region_name": "エクアドル"
},
{
"region_level": "COUNTRY",
"support_below_18": true,
"country_code": "QA",
"area_type": "ADMIN",
"region_id": "289688",
"region_name": "カタール"
},
…
]
}
}
(/code)