淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
adgroup_batch_update_top_dto	AdgroupBatchUpdateTopDTO	必须			入参
└ advertiser_id Number 必须 1 广告主id └ ids Number [] 必须 1 计划ids └ status Number 必须 1 状态，-1：删除，0：暂停，1：启用

名称	类型	描述
result	Number []	成功的ids
error_details	ErrorDetail []	失败的结果信息
└ result Number 1 失败的id └ code String 错误码错误码 └ msg String 错误信息错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdAdgroupStatusUpdateRequest req = new UnideskRtaAdAdgroupStatusUpdateRequest();
UnideskRtaAdAdgroupStatusUpdateRequest.AdgroupBatchUpdateTopDTO obj1 = new UnideskRtaAdAdgroupStatusUpdateRequest.AdgroupBatchUpdateTopDTO();
obj1.setAdvertiserId(1L);
obj1.setIds(new Long[] { 1 };
);
obj1.setStatus(1L);
req.setAdgroupBatchUpdateTopDto(obj1);
UnideskRtaAdAdgroupStatusUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UnideskRtaAdAdgroupStatusUpdateRequest req = new UnideskRtaAdAdgroupStatusUpdateRequest();
UnideskRtaAdAdgroupStatusUpdateRequest.AdgroupBatchUpdateTopDTODomain obj1 = new UnideskRtaAdAdgroupStatusUpdateRequest.AdgroupBatchUpdateTopDTODomain();
obj1.AdvertiserId = 1L;
obj1.Ids = new long[] { 1 };
;
obj1.Status = 1L;
req.AdgroupBatchUpdateTopDto_ = obj1;
UnideskRtaAdAdgroupStatusUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UnideskRtaAdAdgroupStatusUpdateRequest;
$adgroup_batch_update_top_dto = new AdgroupBatchUpdateTopDTO;
$adgroup_batch_update_top_dto->advertiser_id="1";
$adgroup_batch_update_top_dto->ids="1";
$adgroup_batch_update_top_dto->status="1";
$req->setAdgroupBatchUpdateTopDto(json_encode($adgroup_batch_update_top_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.adgroup.status.update' \
-d 'partner_id=apidoc' \
-d 'session=e2a1ab8b-2130-4f76-abb3-bfe8f4277051' \
-d 'sign=E09833E6AF457BE0968963E8519CEF02' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+17%3A05%3A09' \
-d 'v=2.0' \
-d 'adgroup_batch_update_top_dto=null'

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

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

req.adgroup_batch_update_top_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.adgroup.status.update");
add_param(pRequest,"adgroup_batch_update_top_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.adgroup.status.update', {
	'adgroup_batch_update_top_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<unidesk_rta_ad_adgroup_status_update_response>
    <error_details>
        <error_detail>
            <result>1</result>
            <code>错误码</code>
            <msg>错误信息</msg>
        </error_detail>
    </error_details>
</unidesk_rta_ad_adgroup_status_update_response>

{
    "unidesk_rta_ad_adgroup_status_update_response":{,
        "error_details":{
            "error_detail":[
                {
                    "result":1,
                    "code":"错误码",
                    "msg":"错误信息"
                }
            ]
        }
    }
}

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.adgroup.status.update (UD计划批量修改状态接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ