文档中心 > API类目 > 国际站外贸直通车API

alibaba.scbp.ad.campaign.find.forbidden.keyword (查询屏蔽词)

查询屏蔽词

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	描述
top_context	TopContextDto	必须		用户信息
└ product_line_id Number 必须 110101 产品线id └ product_id Number 必须 110101010 产品id
campaign_id	Number	必须	123132612	计划id

响应参数

名称	类型	示例值	描述
result	ResultDto	{}	返回数据
└ success Boolean true 执行结果 └ msg String test 信息 └ code String 200 返回code result_list Result [] [] 服务出参 └ campaign_id Number 114793083 计划id └ keyword String test & test 关键词 └ normword String TEST AMP TEST 普通词 └ gmt_create Date 2021-01-01 00:00:00 创建时间 └ gmt_modified Date 2021-01-01 00:00:00 修改时间

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaScbpAdCampaignFindForbiddenKeywordRequest req = new AlibabaScbpAdCampaignFindForbiddenKeywordRequest();
AlibabaScbpAdCampaignFindForbiddenKeywordRequest.TopContextDto obj1 = new AlibabaScbpAdCampaignFindForbiddenKeywordRequest.TopContextDto();
obj1.setProductLineId(110101L);
obj1.setProductId(110101010L);
req.setTopContext(obj1);
req.setCampaignId(123132612L);
AlibabaScbpAdCampaignFindForbiddenKeywordResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_scbp_ad_campaign_find_forbidden_keyword_response>
    <result>
        <success>true</success>
        <msg>test</msg>
        <code>200</code>
        <result_list>
            <result>
                <campaign_id>114793083</campaign_id>
                <keyword>test &amp;amp; test</keyword>
                <normword>TEST AMP TEST</normword>
                <gmt_create>2021-01-01 00:00:00</gmt_create>
                <gmt_modified>2021-01-01 00:00:00</gmt_modified>
            </result>
        </result_list>
    </result>
</alibaba_scbp_ad_campaign_find_forbidden_keyword_response>

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

国际站外贸直通车API

alibaba.scbp.ad.campaign.find.forbidden.keyword (查询屏蔽词)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ