Get action categories
GET/tool/action_category/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/tool/action_category/
Description
Use this endpoint to get action category enumeration values. Action categories are also referred to as behavioral categories in our documentation.
Action targeting provides advertisers with a way to serve relevant ads to users based on their recent in-app behaviors. In-app behaviors can be categorized into two types: video related actions (views, likes, comments or share), and creator related actions (following or viewed homepage). Accordingly, the action_scene where a developer can use action categories when calling /adgroup/create/ is CREATOR_RELATED, or VIDEO_RELATED.
> 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/action_category/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer 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_id | query | string | 7000000000000000001 | Tà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
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| special_industries | query | string[] | No | Special ad categories.
Enum values:
- HOUSING: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities.
- EMPLOYMENT: Ads for job offers, internship, professional certification programs or other related opportunities.
- CREDIT: Ads for credit card offers, auto loans, long-term financing or other related opportunities.
Note: This field is generally available to advertisers registered in America or Canada. Advertisers who are not registered in America or Canada but want to target these countries with special ad categories need to apply for an additional allowlist. | |
| language | query | string | No | Category name language in repsonse. Default value: en.
Supported languages: en, zh, ja, de, es, fr, id, it, ko, ru, th, tr, vi, ar, pt, ms.
For details, see Enumeration - Language Code. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/tool/action_category/" \ -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/action_category/",
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/action_category/');
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/action_category/' . '?' . 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)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Return code. For the complete list of response codes and descriptions, see Appendix-Return codes. | |
| message | string | Return message. For details, see Appendix-Return codes. | |
| data | object | Returned data. | |
| action_categories | object[] | Action Categories list. | |
| description | string | Action description. | |
| action_category_id | string | Action category ID. | |
| level | number | Level. | |
| sub_category_ids | string[] | Subcategory ID list. | |
| name | string | Action category name. | |
| special_industries | string[] | Special ad categories. Enum values: - `HOUSING`(Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities.) - `EMPLOYMENT`(Ads for job offers, internship, professional certification programs or other related opportunities.) - `CREDIT`(Ads for credit card offers, auto loans, long-term financing or other related opportunities.) Note: - If the returned value is empty(`[]`), it means that the action categories do not support any special ad categories. | |
| action_scene | string | Action scene. Enum values: `CREATOR_RELATED`, `VIDEO_RELATED`. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "20220630215533010245242106175C5C29",
"data": {
"action_categories": [
{
"description": "TikTok users who have followed comedy creators.",
"sub_category_ids": [
"1001"
],
"special_industries": [
"HOUSING",
"EMPLOYMENT",
"CREDIT"
],
"action_scene": "CREATOR_RELATED",
"level": 1,
"name": "Comedy",
"action_category_id": "1"
},
{
"description": "TikTok users who have followed creators that post original performance or original narration content.",
"sub_category_ids": [
"2001"
],
"special_industries": [
"HOUSING",
"EMPLOYMENT",
"CREDIT"
],
"action_scene": "CREATOR_RELATED",
"level": 1,
"name": "Drama",
"action_category_id": "2"
},
...
]
}
}
(/code);
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above