淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
uuid	String	可选	321321		屏幕唯一ID
period	Number	可选	213213		时间范围的排期

名称	类型	示例值	描述
programs	Result []	[{type:3,list:[]},{type:2,list:[]},{type:1,list:[]}]	各个类型的排期
└ type Number 1 排期类型 program_list Programs [] [] 排期列表 └ group_type String 3 组类型 └ cycle_time String 10 轮播时长 └ end_date String 2018-10-11 20:44:27 结束日期 └ contract_no String 231231 合同号 └ group_id String 123 组ID └ gmt_create String 2018-09-05 20:45:35 常见日期 └ type Number 3 素材类型 └ material_version String 3123213123 素材库版本 content Content {} 素材内容 └ size Number 32131 素材大小 └ id Number 12 素材id └ type Number 3 素材类型 └ url String http://mwork.cn-hangzhou.oss-pub.aliyun-inc.com/adscreen/1526290260620_167544.jpg 素材地址 └ material_name String 云货架会场素材名称 └ group_end_date String 1539261867000 轮播结束时间戳 └ group_name String 云货架轮播名称 └ group_start_date String 1536151467000 轮播开始时间戳 └ start_time String 2018-10-11 20:44:27 排期开始时间 └ end_time String 2018-10-11 20:44:27 排期结束时间 └ id Number 00:00:00 排期id └ start_date String 2018-10-11 20:44:27 开始时间

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AdscreenProgramGetRequest req = new AdscreenProgramGetRequest();
req.setUuid("321321");
req.setPeriod(213213L);
AdscreenProgramGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AdscreenProgramGetRequest req = new AdscreenProgramGetRequest();
req.Uuid = "321321";
req.Period = 213213L;
AdscreenProgramGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AdscreenProgramGetRequest;
$req->setUuid("321321");
$req->setPeriod("213213");
$resp = $c->execute($req);

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=taobao.adscreen.program.get' \
-d 'partner_id=apidoc' \
-d 'sign=EDF3C411DC5E9328378F10B5F2A807D4' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-04+13%3A00%3A56' \
-d 'v=2.0' \
-d 'period=213213' \
-d 'uuid=321321'

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

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

req.uuid="321321"
req.period=213213
try:
	resp= req.getResponse()
	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,"taobao.adscreen.program.get");
add_param(pRequest,"uuid","321321");
add_param(pRequest,"period","213213");
pResponse = top_execute(pClient,pRequest,NULL);
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('taobao.adscreen.program.get', {
	'uuid':'321321',
	'period':'213213'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<adscreen_program_get_response>
    <programs>
        <result>
            <type>1</type>
            <program_list>
                <programs>
                    <group_type>3</group_type>
                    <cycle_time>10</cycle_time>
                    <end_date>2018-10-11 20:44:27</end_date>
                    <contract_no>231231</contract_no>
                    <group_id>123</group_id>
                    <gmt_create>2018-09-05 20:45:35</gmt_create>
                    <type>3</type>
                    <material_version>3123213123</material_version>
                    <content>
                        <size>32131</size>
                        <id>12</id>
                        <type>3</type>
                        <url>http://mwork.cn-hangzhou.oss-pub.aliyun-inc.com/adscreen/1526290260620_167544.jpg</url>
                    </content>
                    <material_name>云货架会场</material_name>
                    <group_end_date>1539261867000</group_end_date>
                    <group_name>云货架</group_name>
                    <group_start_date>1536151467000</group_start_date>
                    <start_time>2018-10-11 20:44:27</start_time>
                    <end_time>2018-10-11 20:44:27</end_time>
                    <id>00:00:00</id>
                    <start_date>2018-10-11 20:44:27</start_date>
                </programs>
            </program_list>
        </result>
    </programs>
</adscreen_program_get_response>

{
    "adscreen_program_get_response":{
        "programs":{
            "result":[
                {
                    "type":1,
                    "program_list":{
                        "programs":[
                            {
                                "group_type":"3",
                                "cycle_time":"10",
                                "end_date":"2018-10-11 20:44:27",
                                "contract_no":"231231",
                                "group_id":"123",
                                "gmt_create":"2018-09-05 20:45:35",
                                "type":3,
                                "material_version":"3123213123",
                                "content":{
                                    "size":32131,
                                    "id":12,
                                    "type":3,
                                    "url":"http:\/\/mwork.cn-hangzhou.oss-pub.aliyun-inc.com\/adscreen\/1526290260620_167544.jpg"
                                },
                                "material_name":"云货架会场",
                                "group_end_date":"1539261867000",
                                "group_name":"云货架",
                                "group_start_date":"1536151467000",
                                "start_time":"2018-10-11 20:44:27",
                                "end_time":"2018-10-11 20:44:27",
                                "id":00:00:00,
                                "start_date":"2018-10-11 20:44:27"
                            }
                        ]
                    }
                }
            ]
        }
    }
}

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下载

开放平台

喵街API

taobao.adscreen.program.get (获取广告屏排期)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ