淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
creative_group_top_query_dto	CreativeGroupTopQueryDTO	必须			查询入参
└ adgroup_id Number 必须 1 广告主id └ advertiser_id Number 必须 1 计划id

名称	类型	示例值	描述
result	CreativeGroupTopDTO		出参
creatives CreativeTopDTO [] 创意内容 └ format Number 1 广告形式，1：竖版视频，2：横版视频，3：大图横图，5：小图，6：大图竖图，7：开屏图片，8：开屏视频。竖版视频：格式要求：mp4、mpeg、3gp、avi 视频格式，建议尺寸要求：宽高比9:16，分辨率≥ 7201280，视频码率≥516kbps，时长≥4s；竖版视频-视频封面：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比9:16，14402560 ≤ 尺寸≥ 7201280；横版视频：格式要求：mp4、mpeg、3gp、avi 视频格式，建议尺寸要求：宽高比16:9，分辨率≥ 1280720，视频码率≥516kbps，时长≥4s,大小≤1000M；横版视频-视频封面：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比16:9，25601440 ≤ 尺寸≥ 1280720；大图横图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比16:9，25601440 ≤ 尺寸≥ 1280720；组图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比1.52，1368900 ≤ 尺寸≥ 456300；小图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比1.52，1368900 ≤ 尺寸≥ 456300；大图竖图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比9:16，14402560 ≤ 尺寸≥ 7201280； └ img_ids String [] 图片素材id列表(组图存在多个) └ video_id String 1 视频素材id └ video_cover_img_id String 1 视频素材封面id。注：通过UDBP生成的自动封面不会返回封面ID，可先通过素材查询接口获取poster值（视频首帧图URL），再通过素材上传接口上传即可获得该视频的自动封面ID。 toutiao ToutiaoCreativeTopDTO 头条特有属性 └ creative_component_id Number 1 创意组件id └ promotion_card_creative_component_id Number 1 基础组件id └ action_text String 行动号召文本行动号召文本 └ tags String [] 创意标签 └ title String 创意标题创意标题 └ video_ids String [] 视频素材id列表，多视频自定义创意时使用，如快手 └ id Number 1 创意id toutiao ToutiaoCreativeGroupTopDTO 头条特有属性 └ creative_component_id Number 1 创意组件id └ auto_gen_video_switch Number 1 是否自动生成视频素材功能，1是，0否 └ ad_source String 1 广告来源 └ promotion_card_creative_component_id Number 1 基础组件id └ derive_switch Number 1 是否开启衍生创意功能，1是，0否 └ comment_switch Number 1 是否开启评论功能，1是，0否 └ action_text String 行动号召文本行动号召文本 └ titles String [] 1 创意标题 └ tags String [] 1 创意标签 └ category Number 1 创意分类 └ creative_group_type Number 1 创意分类：1：程序化创意，2：自定义创意 kuaishou KuaishouCreativeGroupTopDTO 快手特有参数 └ sticker_styles String [] 封面贴纸 └ sticker_titles String [] 封面广告语 └ creative_component_id Number 1 创意组件，投放范围是快手默认时必填 └ name String 创意名称创意名称

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdCreativegroupGetRequest req = new UnideskRtaAdCreativegroupGetRequest();
UnideskRtaAdCreativegroupGetRequest.CreativeGroupTopQueryDTO obj1 = new UnideskRtaAdCreativegroupGetRequest.CreativeGroupTopQueryDTO();
obj1.setAdgroupId(1L);
obj1.setAdvertiserId(1L);
req.setCreativeGroupTopQueryDto(obj1);
UnideskRtaAdCreativegroupGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UnideskRtaAdCreativegroupGetRequest req = new UnideskRtaAdCreativegroupGetRequest();
UnideskRtaAdCreativegroupGetRequest.CreativeGroupTopQueryDTODomain obj1 = new UnideskRtaAdCreativegroupGetRequest.CreativeGroupTopQueryDTODomain();
obj1.AdgroupId = 1L;
obj1.AdvertiserId = 1L;
req.CreativeGroupTopQueryDto_ = obj1;
UnideskRtaAdCreativegroupGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UnideskRtaAdCreativegroupGetRequest;
$creative_group_top_query_dto = new CreativeGroupTopQueryDTO;
$creative_group_top_query_dto->adgroup_id="1";
$creative_group_top_query_dto->advertiser_id="1";
$req->setCreativeGroupTopQueryDto(json_encode($creative_group_top_query_dto));
$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=taobao.unidesk.rta.ad.creativegroup.get' \
-d 'partner_id=apidoc' \
-d 'session=d2321c10-8a56-4bd4-9241-1865c327ba92' \
-d 'sign=70429A8EBCD8FDCB276E70CCA1584F69' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+17%3A11%3A45' \
-d 'v=2.0' \
-d 'creative_group_top_query_dto=null'

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

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

req.creative_group_top_query_dto="数据结构示例JSON格式"
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,"taobao.unidesk.rta.ad.creativegroup.get");
add_param(pRequest,"creative_group_top_query_dto","数据结构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('taobao.unidesk.rta.ad.creativegroup.get', {
	'creative_group_top_query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<unidesk_rta_ad_creativegroup_get_response>
    <result>
        <creatives>
            <creative_top_d_t_o>
                <format>1</format>
                <video_id>1</video_id>
                <video_cover_img_id>1</video_cover_img_id>
                <toutiao>
                    <creative_component_id>1</creative_component_id>
                    <promotion_card_creative_component_id>1</promotion_card_creative_component_id>
                </toutiao>
                <action_text>行动号召文本</action_text>
                <title>创意标题</title>
                <id>1</id>
            </creative_top_d_t_o>
        </creatives>
        <toutiao>
            <creative_component_id>1</creative_component_id>
            <auto_gen_video_switch>1</auto_gen_video_switch>
            <ad_source>1</ad_source>
            <promotion_card_creative_component_id>1</promotion_card_creative_component_id>
            <derive_switch>1</derive_switch>
            <comment_switch>1</comment_switch>
        </toutiao>
        <action_text>行动号召文本</action_text>
        <titles>
            <string>1</string>
        </titles>
        <tags>
            <string>1</string>
        </tags>
        <category>1</category>
        <creative_group_type>1</creative_group_type>
        <kuaishou>
            <creative_component_id>1</creative_component_id>
            <name>创意名称</name>
        </kuaishou>
    </result>
</unidesk_rta_ad_creativegroup_get_response>

{
    "unidesk_rta_ad_creativegroup_get_response":{
        "result":{
            "creatives":{
                "creative_top_d_t_o":[
                    {
                        "format":1,
                        "video_id":"1",
                        "video_cover_img_id":"1",
                        "toutiao":{
                            "creative_component_id":1,
                            "promotion_card_creative_component_id":1
                        },
                        "action_text":"行动号召文本",
                        "title":"创意标题",
                        "id":1
                    }
                ]
            },
            "toutiao":{
                "creative_component_id":1,
                "auto_gen_video_switch":1,
                "ad_source":"1",
                "promotion_card_creative_component_id":1,
                "derive_switch":1,
                "comment_switch":1
            },
            "action_text":"行动号召文本",
            "titles":{
                "string":[
                    "1"
                ]
            },
            "tags":{
                "string":[
                    "1"
                ]
            },
            "category":1,
            "creative_group_type":1,
            "kuaishou":{,
                "creative_component_id":1,
                "name":"创意名称"
            }
        }
    }
}

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

开放平台

阿里妈妈-UniDesk

taobao.unidesk.rta.ad.creativegroup.get (UD创意组查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ