Developer resources

Get negative keywords — TikTok Business API

Get negative keywords · 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.

Open in the API index TikTok Business platform page

Get negative keywords

GET/search_ad/negative_keyword/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/search_ad/negative_keyword/get/

Description

Use this endpoint to get the list of negative keywords for Search Ads.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/search_ad/negative_keyword/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

Name	In	Type	Required	Description
object_type	query	string	Yes	Object type. Use this field to specify whether you want to get the list of negative keywords for a campaign or ad group. Enum values: - `CAMPAIGN`: campaign. - `ADGROUP`: ad group.
object_id	query	string	Yes	Object ID. Use this field to pass in a campaign ID or ad group ID that you want to get the list of negative keywords for. Specify this field according to `object_type`: - If `object_type` is `CAMPAIGN`, assign a campaign ID to this field. - If `object_type` is `ADGROUP`, assign an ad group ID to this field.
page	query	number	No	The number of pages you want to include the results in. Default value: 1. Value range: ≥ 1
page_size	query	number	No	Page size. Default value: 10. Value range: [1,50].

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/search_ad/negative_keyword/get/?object_type=&object_id=" \
  -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_ad/negative_keyword/get/",
    params={
        "object_type": "",
        "object_id": ""
    },
    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_ad/negative_keyword/get/');
for (const [k, v] of Object.entries({"object_type":"","object_id":""})) 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_ad/negative_keyword/get/' . '?' . http_build_query(['object_type' => '', 'object_id' => '']);
$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	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. If no negative word is found, an empty list will be returned.
keywords	object[]	Information about negative words. Max size: 1,000.
keyword_id	string	ID of the negative keyword.
name	string	Name of the negative keyword.
match_type	string	Match type for the negative keyword. Enum values: - `PRECISE_WORD`: exact match. - `PHRASE_WORD`: phrase match. - `BROAD_WORD`: broad match.
page_info	object	Pagination information.
page	number	Current page number.
page_size	number	Page size.
total_number	number	Total number of results.
total_page	number	Total pages of results.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "keywords": [
            {
                "match_type": "BROAD_WORD",
                "name": "{{name}}",
                "keyword_id": "{{keyword_id}}"
            },
            {
                "match_type": "BROAD_WORD",
                "name": "{{name}}",
                "keyword_id": "{{keyword_id}}"
            }
        ],
        "page_info": {
            "total_number": 2,
            "page": 1,
            "total_page": 1,
            "page_size": 50
        }
    }
}

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