VI | EN
Message us on Messenger
Developer resources

Search for additional interest categories — TikTok Business API

Search for additional interest categories · 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.

Search for additional interest categories

GET/tool/interest_keyword/recommend/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/tool/interest_keyword/recommend/
Description

Use this endpoint to search for additional interest categories. You need to specify one or more seed keywords and the seed keyword or keywords will be used to search for related additional interest categories.

The returned additional interest categories (keyword_id) with status as EFFECTIVE can be passed to the interest_keyword_ids field when calling /adgroup/create/. Then the additional interest categories will be used in the ad group to target audience.

> Note

> We recommend that you use the Consolidated Interest and Behavior API (/targeting/search/) to search for or list targeting categories and hashtags for interests and behaviors. This API provides a consolidated and efficient approach to access the necessary targeting information.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/tool/interest_keyword/recommend/

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
keywordsquerystring[]No- Either keywords or keyword has to be set. - If keywords and keyword are passed simultaneously, keyword will be ignored. A list of seed keywords that you provide to search for additional interest categories. Each seed keyword will be used separately to generate corresponding additional interest categories. Max size: 10.
keywordquerystringNo- Either keywords or keyword has to be set. - If keywords and keyword are passed simultaneously, keyword will be ignored. One seed keyword that you provide to search for additional interest categories.
modequerystringNoSearch mode. Enum values: FUZZ_MATCH, SEMANTIC_RECOMMEND. Default value: FUZZ_MATCH.
languagequerystringNoKeyword language. Enum values: fr, id, it, ja, ms, ar, vi, en, ru, es, th, tr, hi, zh, de, ko. Default value: en. Note that target audience languages are not limited by keyword languages. You can use English categories to target audience that do not speak English.
limitquerynumberNoNumber of additional interest categories you want to get. Default value: 50. Value range: 1-50.
audience_typequerystringNoAudience type. Enum values: - GENERAL_INTEREST:  General interest. The audiences have a general, long-term interest in a video category. - PURCHASE_INTENTION (deprecated): Purchase intent. The audiences' recent behavior suggests they may buy something related to a content category. Default value: GENERAL_INTEREST.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/tool/interest_keyword/recommend/" \
  -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/tool/interest_keyword/recommend/",
    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/tool/interest_keyword/recommend/');
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/tool/interest_keyword/recommend/' . '?' . 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
codenumberThe return code. For the complete list of error codes and descriptions, see Appendix - Return Codes.
messagestringThe return message. For details, see Appendix - Return Codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data.
recommended_keywordsobject[]A list of additional interest categories.
input_keywordstringReturned only when `keywords` is included in the request and contains more than one keyword. The specific seed keyword for which the additional interest category is generated. For instance, if the additional interest category "Tester" is generated for the seed keyword "test", the returned `input_keyword` will be `"test"`, and `keyword` will be `"Tester"`.
keywordstringAdditional interest category.
keyword_idstringID of the additional interest category.
languagestringLanguage of the additional interest category. Enum values: `fr`, `id`, `it`, `ja`, `ms`, `ar`, `vi`, `en`, `ru`, `es`, `th`, `tr`, `hi`, `zh`, `de`, `ko`.
statusstringWhether the additional interest category will be effective. Enum values: - `EFFECTIVE`: effective. An additional interest category is effective if using it can reach a reasonable number of people. - `INEFFECTIVE`: ineffective. An additional interest category is ineffective if the estimated audience size is too small. Note: Only effective additional interest categories can be used in ad groups to target audiences.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "202207011538040102452421060C18B592",
    "data": {
        "recommended_keywords": [
            {
                "status": "EFFECTIVE",
                "language": "1",
                "keyword": "Testament",
                "keyword_id": "1915651459"
            },
            {
                "status": "EFFECTIVE",
                "language": "1",
                "keyword": "Tester",
                "keyword_id": "1916254642"
            },
            {
                "status": "EFFECTIVE",
                "language": "1",
                "keyword": "Brain test",
                "keyword_id": "2027741302"
            },
            {
                "status": "EFFECTIVE",
                "language": "1",
                "keyword": "Test",
                "keyword_id": "2027749623"
            },
            {
                "status": "EFFECTIVE",
                "language": "1",
                "keyword": "Test drive",
                "keyword_id": "2027768725"
            },
            ...
        ]
    }
}
(/code);

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