淘宝开放平台 - 文档中心

请求地址：

环境	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 可选 110101008 产品id
campaign_query	CampaignQueryDto	必须	请求实体类
└ title String 可选 test 计划标题，配合exactMatch使用 └ sub_type String 可选 1 子类型 └ online_status Number 可选 1 推广状态 └ exact_match Boolean 可选 true 标题是否精确匹配 └ type_list String [] 可选 [1,2,3] 计划类型列表 └ cate_id Number 可选 1 类目id └ page Number 可选 1 当前页数 └ size Number 可选 10 每页数量

名称	类型	示例值	描述
total_count	Number	10000	总数量
result_list	CampaignDto []	{}	返回数据
└ title String test 计划标题 └ start_time Date 1970-01-01 00:00:00 计划开始时间 └ end_time Date 1970-01-01 00:00:00 计划结束时间 └ online_status Number 1 用户上下线 └ settle_status Number 1 结算上下线 └ settle_reason String test 结算上下线原因 └ settle_time Date 1970-01-01 00:00:00 settleTime └ type Number 1 计划类型 └ campaign_model Number 1 计划模型 └ top_time Date 1970-01-01 00:00:00 置顶时间 └ settle_version Number 1 结算版本 └ scene_id Number 1 场景ID └ properties String {} Campaign扩展属性 └ product_line_id Number 100010 产品线id └ member_id Number 1 广告用户ID └ cust_id Number 1 客户ID └ biz_number Number 1 业务流水号 └ id Number 1 实体主键 └ gmt_create Date 1970-01-01 00:00:00 计划创建时间 └ gmt_modified Date 1970-01-01 00:00:00 计划修改时间 └ sub_type String 2 计划子类型 └ week_budget_status String on 周预算状态 on:开启 off:关闭 └ bid_type Number 1 出价模式 value =1 为智能出价 value =2 为手动出价 └ min_price String 3 最低价格 └ max_price String 15 最大价格 └ budget String 50 预算

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaScbpAdCampaignFindCampaignPageRequest req = new AlibabaScbpAdCampaignFindCampaignPageRequest();
AlibabaScbpAdCampaignFindCampaignPageRequest.TopContextDto obj1 = new AlibabaScbpAdCampaignFindCampaignPageRequest.TopContextDto();
obj1.setProductLineId(110101L);
obj1.setProductId(110101008L);
req.setTopContext(obj1);
AlibabaScbpAdCampaignFindCampaignPageRequest.CampaignQueryDto obj2 = new AlibabaScbpAdCampaignFindCampaignPageRequest.CampaignQueryDto();
obj2.setTitle("test");
obj2.setSubType("1");
obj2.setOnlineStatus(1L);
obj2.setExactMatch(true);
obj2.setTypeList("1,2,3");
obj2.setCateId(1L);
obj2.setPage(1L);
obj2.setSize(10L);
req.setCampaignQuery(obj2);
AlibabaScbpAdCampaignFindCampaignPageResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaScbpAdCampaignFindCampaignPageRequest req = new AlibabaScbpAdCampaignFindCampaignPageRequest();
AlibabaScbpAdCampaignFindCampaignPageRequest.TopContextDtoDomain obj1 = new AlibabaScbpAdCampaignFindCampaignPageRequest.TopContextDtoDomain();
obj1.ProductLineId = 110101L;
obj1.ProductId = 110101008L;
req.TopContext_ = obj1;
AlibabaScbpAdCampaignFindCampaignPageRequest.CampaignQueryDtoDomain obj2 = new AlibabaScbpAdCampaignFindCampaignPageRequest.CampaignQueryDtoDomain();
obj2.Title = "test";
obj2.SubType = "1";
obj2.OnlineStatus = 1L;
obj2.ExactMatch = true;
obj2.TypeList = "1,2,3";
obj2.CateId = 1L;
obj2.Page = 1L;
obj2.Size = 10L;
req.CampaignQuery_ = obj2;
AlibabaScbpAdCampaignFindCampaignPageResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaScbpAdCampaignFindCampaignPageRequest;
$top_context = new TopContextDto;
$top_context->product_line_id="110101";
$top_context->product_id="110101008";
$req->setTopContext(json_encode($top_context));
$campaign_query = new CampaignQueryDto;
$campaign_query->title="test";
$campaign_query->sub_type="1";
$campaign_query->online_status="1";
$campaign_query->exact_match="true";
$campaign_query->type_list="[1,2,3]";
$campaign_query->cate_id="1";
$campaign_query->page="1";
$campaign_query->size="10";
$req->setCampaignQuery(json_encode($campaign_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.campaign.find.campaign.page' \
-d 'partner_id=apidoc' \
-d 'session=a08cca9e-b661-4993-8ecd-a14bb2c47b8f' \
-d 'sign=07E05FF16123F31BB843500B7C8691C9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+18%3A38%3A29' \
-d 'v=2.0' \
-d 'campaign_query=null' \
-d 'top_context=null'

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

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

req.top_context=""
req.campaign_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.campaign.find.campaign.page");
add_param(pRequest,"top_context","数据结构JSON示例");
add_param(pRequest,"campaign_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.campaign.find.campaign.page', {
	'top_context':'数据结构JSON示例',
	'campaign_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_scbp_ad_campaign_find_campaign_page_response>
    <total_count>10000</total_count>
    <result_list>
        <campaign_dto>
            <title>test</title>
            <start_time>1970-01-01 00:00:00</start_time>
            <end_time>1970-01-01 00:00:00</end_time>
            <online_status>1</online_status>
            <settle_status>1</settle_status>
            <settle_reason>test</settle_reason>
            <settle_time>1970-01-01 00:00:00</settle_time>
            <type>1</type>
            <campaign_model>1</campaign_model>
            <top_time>1970-01-01 00:00:00</top_time>
            <settle_version>1</settle_version>
            <scene_id>1</scene_id>
            <properties>{}</properties>
            <product_line_id>100010</product_line_id>
            <member_id>1</member_id>
            <cust_id>1</cust_id>
            <biz_number>1</biz_number>
            <id>1</id>
            <gmt_create>1970-01-01 00:00:00</gmt_create>
            <gmt_modified>1970-01-01 00:00:00</gmt_modified>
            <sub_type>2</sub_type>
            <week_budget_status>on</week_budget_status>
            <bid_type>1</bid_type>
            <min_price>3</min_price>
            <max_price>15</max_price>
            <budget>50</budget>
        </campaign_dto>
    </result_list>
</alibaba_scbp_ad_campaign_find_campaign_page_response>

{
    "alibaba_scbp_ad_campaign_find_campaign_page_response":{
        "total_count":10000,
        "result_list":{
            "campaign_dto":[
                {
                    "title":"test",
                    "start_time":"1970-01-01 00:00:00",
                    "end_time":"1970-01-01 00:00:00",
                    "online_status":1,
                    "settle_status":1,
                    "settle_reason":"test",
                    "settle_time":"1970-01-01 00:00:00",
                    "type":1,
                    "campaign_model":1,
                    "top_time":"1970-01-01 00:00:00",
                    "settle_version":1,
                    "scene_id":1,
                    "properties":"{}",
                    "product_line_id":100010,
                    "member_id":1,
                    "cust_id":1,
                    "biz_number":1,
                    "id":1,
                    "gmt_create":"1970-01-01 00:00:00",
                    "gmt_modified":"1970-01-01 00:00:00",
                    "sub_type":"2",
                    "week_budget_status":"on",
                    "bid_type":1,
                    "min_price":"3",
                    "max_price":"15",
                    "budget":"50"
                }
            ]
        }
    }
}

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.campaign.find.campaign.page (分页查询计划)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ