VI | EN
Message us on Messenger
Developer resources

Get available locations by advertiser ID — TikTok Business API

Get available locations by advertiser ID · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Get available locations by advertiser ID

GET/search/region/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/search/region/
Description

Use this endpoint to get available locations that your ads can be delivered to based on your advertiser IDs.

If you want to get available locations that your ads can be delivered to based on your objectives, placements, and optionally targeting operating systems, and brand safety settings, use the /tool/region/ endpoint.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/search/region/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring7000000000000000001Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

NameInTypeRequiredSampleDescription
languagequerystringNoThe language you want the returned region name to be translated into. Default value: en Currently, we only support zh, fr, es, ko, vi, en, hi, it, tr, ru, ja, id, de, ms, ar, and th Note: If you do not pass in one of the supported values above, it will return as the default en.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/search/region/" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/search/region/",
    params={},
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/search/region/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/search/region/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

NameTypeSampleDescription
codenumberResponse code. For the complete list of response codes and descriptions, see Appendix-Return Code.
messagestringResponse message. For details, see Appendix - Return Codes.
dataobjectReturned data.
region_listobject[]List of all available regions.
region_idstringRegion ID.
region_namestringRegion name.
region_levelstringRegion level. Enum values: `COUNTRY`(country or region level), `PROVINCE`, `CITY`, `DISTRICT`. DMA and metropolitans are at the province level.
country_codestringCountry code for the country of the region.
parent_idstringThe upper-level region id. This field will not be returned if `region_level` is `COUNTRY`.
area_typestringLocation type. Enum values: `ADMIN`, `METROPOLITAN_OR_DMA`.
support_below_18booleanWhether the location supports ads to be delivered to people under 18 years of age.
request_idstringThe log ID of a request, which uniquely identifies the request.

Response sample

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": "カタール"
            },
            …
        ]
    }
}

Get started

  1. Sign up for Partner
  2. Enable a data type of the Ads (Marketing API) group on the platform page
  3. Create an API key (tick the TikTok Business channel)
  4. Call it as in the examples above