Get the Brand Safety Hub settings of an ad account
GET/tiktok_inventory_filters/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/tiktok_inventory_filters/get/
Description
Use this endpoint to retrieve the Brand Safety Hub settings of an ad account.
The Brand Safety Hub allows you to define the default ad account-level first-party brand safety settings, including TikTok Inventory Filter and Suitability Controls such as Category Exclusion and Vertical Sensitivity.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/tiktok_inventory_filters/get/
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
No specific parameters (besides the common ones).
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/tiktok_inventory_filters/get/" \ -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/tiktok_inventory_filters/get/",
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/tiktok_inventory_filters/get/');
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/tiktok_inventory_filters/get/' . '?' . 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 | Response code. For the complete list of response codes and descriptions, see Appendix-Return Code. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. | |
| data | object | Returned data. | |
| cover_all_ad_objectives | boolean | Whether to apply the brand safety settings (`brand_safety_type`, `category_exclusion_ids`, and `vertical_sensitivity_id`) to all advertising objectives. Supported values: - `true`: To apply the brand safety settings to all objectives, including Reach, Video views, Community Interaction, Traffic, App Promotion, Lead Generation, Website Conversions, and Product Sales. - `false`: To apply the brand safety settings only to Reach, Video Views, and Community Interaction objectives. | |
| brand_safety_type | string | Inventory filter tier. The tier you select will apply to placements in the For You, Following, and Profile Page feeds, as well as Search feed, where ads appear next to search results being viewed. Enum values: - `EXPANDED_INVENTORY`: Expanded inventory. Your ads will not appear next to explicitly inappropriate content, but they may appear next to content that features mature themes. - `STANDARD_INVENTORY`: Standard inventory. Your ads will appear next to content that is appropriate for most brands. - `LIMITED_INVENTORY`: Limited inventory. Your ads will not appear next to content that contains mature themes. - `NO_BRAND_SAFETY`: Full inventory without using any brand safety solution, which means your ads may appear next to some content featuring mature themes. | |
| category_exclusion_ids | string[] | The ID list of content categories that you want to avoid showing your ads next to. To obtain the details of the content categories based on category IDs, use /tool/content_exclusion/info/. Note: Currently, category exclusion is not available for the Product Sales objective. | |
| vertical_sensitivity_id | string | The ID of the vertical category to exclude sensitive vertical-related content that you want to avoid showing your ads next to. To obtain the details of the vertical categories based on category IDs, use /tool/content_exclusion/info/. Note: Currently, vertical sensitivity controls are not available for the following objectives: Traffic, App Promotion, Lead Generation, Website Conversions, and Product Sales. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"brand_safety_type": "LIMITED_INVENTORY",
"category_exclusion_ids": [
"201"
],
"cover_all_ad_objectives": true,
"vertical_sensitivity_id": "1001"
}
}
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