淘宝开放平台 - 文档中心

请求地址：

环境	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 必须 110101003 产品id
campaign_id	Number	必须	1	计划id
campaign_keyword_query	CampaignKeywordQuery	必须		搜索条件
└ type String 可选 1 类型:base(基础信息)，star(基础信息加星级),full（所有信息），不传默认查所有信息 └ begin_date String 可选 2021-01-01 开始时间（查询关键词报告需要的参数） └ end_date String 可选 2021-01-01 结束时间（查询关键词报告需要的参数） └ setting_key String 可选 test 配置ksy └ setting_value String 可选 test 配置value └ norm_word String 可选 test 普通词 └ word_id_list Number [] 可选 test 词id集合 └ product_id Number 可选 110101010 产品id └ campaign_id Number 可选 1 计划id └ online_status Number 可选 1 状态

名称	类型	示例值	描述
result_list	KeywordDto []	1	返回数据集合
effect KeywordEffectDto {} 效果数据 └ keyword String test 关键词 └ stat_date String 2021-01-01 开始时间 └ impr Number 1 曝光 └ click Number 1 点击 └ cost Number 1 消耗 └ online_min Number 1 推广时长 └ id Number 1 主键 └ gmt_create Date 2021-01-01 00:00:00 创建时间 └ gmt_modify Date 2021-01-01 00:00:00 更新时间 └ product_id Number 1 产品id └ campaign_id Number 1 计划id └ word String test 词 └ norm_word String test 普通词 └ online_status Number 1 状态 └ bid_price String 1 出价分 └ avg_price String 1 平均出价 └ sug_price String 1 建议出价 └ base_price String 1 低价 └ qs_star Number 1 星级 └ best_match_product Number 1 最优商品id └ relative_products_count Number 1 相关性产品数量 └ search_count Number 1 搜索数量 └ buy_count Number 1 购买数量 └ properties String {} 配置信息 bid_strategy BidStrategyDto {} 战略数据 └ id String 1 主键 └ gmt_create Date 2021-01-01 00:00:00 创建时间 └ gmt_modified Date 2021-01-01 00:00:00 修改时间 └ topn Number 1 目标排名，前N名 └ duration Number 1 出价间隔分钟为单位的数值型 └ product_id Number 1 产品 └ discount Number 1 溢价比例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaScbpAdKeywordListCampaignKeywordsRequest req = new AlibabaScbpAdKeywordListCampaignKeywordsRequest();
AlibabaScbpAdKeywordListCampaignKeywordsRequest.TopContextDto obj1 = new AlibabaScbpAdKeywordListCampaignKeywordsRequest.TopContextDto();
obj1.setProductLineId(110101L);
obj1.setProductId(110101003L);
req.setTopContext(obj1);
req.setCampaignId(1L);
AlibabaScbpAdKeywordListCampaignKeywordsRequest.CampaignKeywordQuery obj2 = new AlibabaScbpAdKeywordListCampaignKeywordsRequest.CampaignKeywordQuery();
obj2.setType("1");
obj2.setBeginDate("2021-01-01");
obj2.setEndDate("2021-01-01");
obj2.setSettingKey("test");
obj2.setSettingValue("test");
obj2.setNormWord("test");
obj2.setWordIdList(new Long[] { test };
);
obj2.setProductId(110101010L);
obj2.setCampaignId(1L);
obj2.setOnlineStatus(1L);
req.setCampaignKeywordQuery(obj2);
AlibabaScbpAdKeywordListCampaignKeywordsResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaScbpAdKeywordListCampaignKeywordsRequest req = new AlibabaScbpAdKeywordListCampaignKeywordsRequest();
AlibabaScbpAdKeywordListCampaignKeywordsRequest.TopContextDtoDomain obj1 = new AlibabaScbpAdKeywordListCampaignKeywordsRequest.TopContextDtoDomain();
obj1.ProductLineId = 110101L;
obj1.ProductId = 110101003L;
req.TopContext_ = obj1;
req.CampaignId = 1L;
AlibabaScbpAdKeywordListCampaignKeywordsRequest.CampaignKeywordQueryDomain obj2 = new AlibabaScbpAdKeywordListCampaignKeywordsRequest.CampaignKeywordQueryDomain();
obj2.Type = "1";
obj2.BeginDate = "2021-01-01";
obj2.EndDate = "2021-01-01";
obj2.SettingKey = "test";
obj2.SettingValue = "test";
obj2.NormWord = "test";
obj2.WordIdList = new long[] { test };
;
obj2.ProductId = 110101010L;
obj2.CampaignId = 1L;
obj2.OnlineStatus = 1L;
req.CampaignKeywordQuery_ = obj2;
AlibabaScbpAdKeywordListCampaignKeywordsResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaScbpAdKeywordListCampaignKeywordsRequest;
$top_context = new TopContextDto;
$top_context->product_line_id="110101";
$top_context->product_id="110101003";
$req->setTopContext(json_encode($top_context));
$req->setCampaignId("1");
$campaign_keyword_query = new CampaignKeywordQuery;
$campaign_keyword_query->type="1";
$campaign_keyword_query->begin_date="2021-01-01";
$campaign_keyword_query->end_date="2021-01-01";
$campaign_keyword_query->setting_key="test";
$campaign_keyword_query->setting_value="test";
$campaign_keyword_query->norm_word="test";
$campaign_keyword_query->word_id_list="test";
$campaign_keyword_query->product_id="110101010";
$campaign_keyword_query->campaign_id="1";
$campaign_keyword_query->online_status="1";
$req->setCampaignKeywordQuery(json_encode($campaign_keyword_query));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.scbp.ad.keyword.list.campaign.keywords' \
-d 'partner_id=apidoc' \
-d 'session=2aeed9b7-db93-41e4-b4f9-316aca0fc31b' \
-d 'sign=8B113A42009CB5F6889687FA9DCAA85A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+18%3A35%3A59' \
-d 'v=2.0' \
-d 'campaign_id=1' \
-d 'campaign_keyword_query=null' \
-d 'top_context=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaScbpAdKeywordListCampaignKeywordsRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.top_context=""
req.campaign_id=1
req.campaign_keyword_query=""
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.scbp.ad.keyword.list.campaign.keywords");
add_param(pRequest,"top_context","数据结构JSON示例");
add_param(pRequest,"campaign_id","1");
add_param(pRequest,"campaign_keyword_query","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.scbp.ad.keyword.list.campaign.keywords', {
	'top_context':'数据结构JSON示例',
	'campaign_id':'1',
	'campaign_keyword_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_scbp_ad_keyword_list_campaign_keywords_response>
    <result_list>
        <keyword_dto>
            <effect>
                <keyword>test</keyword>
                <stat_date>2021-01-01</stat_date>
                <impr>1</impr>
                <click>1</click>
                <cost>1</cost>
                <online_min>1</online_min>
            </effect>
            <id>1</id>
            <gmt_create>2021-01-01 00:00:00</gmt_create>
            <gmt_modify>2021-01-01 00:00:00</gmt_modify>
            <product_id>1</product_id>
            <campaign_id>1</campaign_id>
            <word>test</word>
            <norm_word>test</norm_word>
            <online_status>1</online_status>
            <bid_price>1</bid_price>
            <avg_price>1</avg_price>
            <sug_price>1</sug_price>
            <base_price>1</base_price>
            <qs_star>1</qs_star>
            <best_match_product>1</best_match_product>
            <relative_products_count>1</relative_products_count>
            <search_count>1</search_count>
            <buy_count>1</buy_count>
            <properties>{}</properties>
            <bid_strategy>
                <id>1</id>
                <gmt_create>2021-01-01 00:00:00</gmt_create>
                <gmt_modified>2021-01-01 00:00:00</gmt_modified>
                <topn>1</topn>
                <duration>1</duration>
                <product_id>1</product_id>
                <discount>1</discount>
            </bid_strategy>
        </keyword_dto>
    </result_list>
</alibaba_scbp_ad_keyword_list_campaign_keywords_response>

{
    "alibaba_scbp_ad_keyword_list_campaign_keywords_response":{
        "result_list":{
            "keyword_dto":[
                {
                    "effect":{
                        "keyword":"test",
                        "stat_date":"2021-01-01",
                        "impr":1,
                        "click":1,
                        "cost":1,
                        "online_min":1
                    },
                    "id":1,
                    "gmt_create":"2021-01-01 00:00:00",
                    "gmt_modify":"2021-01-01 00:00:00",
                    "product_id":1,
                    "campaign_id":1,
                    "word":"test",
                    "norm_word":"test",
                    "online_status":1,
                    "bid_price":"1",
                    "avg_price":"1",
                    "sug_price":"1",
                    "base_price":"1",
                    "qs_star":1,
                    "best_match_product":1,
                    "relative_products_count":1,
                    "search_count":1,
                    "buy_count":1,
                    "properties":"{}",
                    "bid_strategy":{
                        "id":"1",
                        "gmt_create":"2021-01-01 00:00:00",
                        "gmt_modified":"2021-01-01 00:00:00",
                        "topn":1,
                        "duration":1,
                        "product_id":1,
                        "discount":1
                    }
                }
            ]
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

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

开放平台

国际站外贸直通车操作

alibaba.scbp.ad.keyword.list.campaign.keywords (获取计划关键词)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ