获取否定关键词

您可以使用本接口获取搜索广告的否定关键词列表。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/search_ad/negative_keyword/get/

方法 GET

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
| object_type {必填} | string | 对象类型。请通过本字段指定您想获取推广系列还是广告组对应的否定关键词列表。<br><br>枚举值：<ul><li>`CAMPAIGN`：推广系列。</li><li>`ADGROUP`：广告组。</li></ul>|
| object_id {必填} | string | 对象ID。请通过本字段传入推广系列ID或广告组ID，从而获取对应的否定关键词列表。 <br><br>您需根据 `object_type`字段传入本字段： <ul><li>若 `object_type`设置为`CAMPAIGN`，您需通过本字段传入推广系列ID。</li><li>若 `object_type` 设置为 `ADGROUP` , 您需通过本字段传入广告组ID。</li></ul>|
| page | number | 请通过本字段指定结果显示的页数。<br><br>默认值： 1。 <br><br>取值范围： ≥ 1。 |
| page_size| number | 分页大小。 <br><br>默认值： 10。<br><br>取值范围： [1,50]。 |

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/search_ad/negative_keyword/get/?advertiser_id={{advertiser_id}}&object_type=CAMPAIGN&object_id={{object_id}}&page=1&page_size=50' \
--header 'Access-Token: {{Access-Token}}'
(/code)

返回

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述，参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志ID，唯一标识一个请求。 |
|data |object| 返回数据。 |
#| keywords | object[] | 否定关键词相关信息。<br><br>最大数量：1,000。 |
##| keyword_id | string | 否定关键词的ID。 |
##| name | string | 否定关键词的名称。 |
##| match_type | string | 否定关键词的匹配类型。<br><br>枚举值：<ul><li>`PRECISE_WORD` ：精确匹配。</li><li>`PHRASE_WORD`：词组匹配。</li><li>`BROAD_WORD`：广泛匹配。</li></ul>|
#| page_info | object | 分页信息。 |
##| page | number | 当前页数。 |
##| page_size | number | 分页大小。 |
##| total_number | number | 总结果数。 |
##| total_page | number | 总页数。 |

示例

(code Success-Response http)
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
        }
    }
}
(/code)