检查屏蔽词是否存在
您可以使用本接口检查某个词是否是屏蔽词。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/blockedword/check/| /v1.3/blockedword/check/|
|请求参数类型|advertiser_id: number |advertiser_id: string |
|返回参数名称|blocked_word<br>existed|word<br>blocked`|
## 请求
**地址**
https://business-api.tiktok.com/open_api/v1.3/blockedword/check/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID |
|blocked_words {必填}|string[]| 您想要检查的屏蔽词列表 |
示例
(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
--data-urlencode "blocked_words=[\"BLOCKED_WORDS\"]" \
https://business-api.tiktok.com/open_api/v1.3/blockedword/check/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)|
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)|
|data|object|返回数据|
#|results |object[]| 查询结果 |
##|word|string| 您希望检查的屏蔽词|
##|blocked|boolean|是否已屏蔽。枚举值: `True`(已屏蔽), `False`未屏蔽)|
|request_id |string|请求的日志id,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {}
}
(/code);