淘宝开放平台

请求地址：

环境	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_service_context	TopServiceContext	必须	topServiceContext
└ biz_code String 必须 xxxxx api业务线编码
data_list	AdgroupUpdatePartCommandVo	必须	list
└ campaign_id Number 必须 68796878069 计划id └ adgroup_id Number 必须 68793666608 单元id └ material_id Number 可选 714616513841 物料id └ display_status String 可选 pause 前端展示状态,pause:暂停推广,start:正在推广,terminate:结束推广,wait:等待推广,pending:准备推广,wait_pay:计划未付款

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 adgroup_v_o_top_bulk_data TopBulkData 结果集 adgroup_v_o_list AdgroupVo [] 批量结果集 └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ campaign_name String 管家计划_宝贝候选集计划名称 └ adgroup_id Number 68793666608 单元id └ adgroup_name String ds460418344 单元名称 └ online_status Number 0 投放状态,-1:未进入投放状态,0:用户设置状态-下线,1:用户设置状态-上线,2:合同未生效,9:投放结束,105:待支付 └ display_status String pause 前端展示状态,pause:暂停推广,start:正在推广,terminate:结束推广,wait:等待推广,pending:准备推广,wait_pay:计划未付款 └ audit_status Number 1 风控审核状态,-1:待审核,0:后台下线状态,1:后台上线状态 └ audit_reason String xxxxx 审核拒绝原因 adgroup_ocpc AdgroupOcpcVo 单元智能出价信息 └ enable_ocpc Boolean true OCPC是否开启，false:否，true:是 └ ocpc_ratio Number 200 OCPC溢价比例 └ promotion_type String item 推广主体类型,item:商品,item_private_mini:独享橱窗,shop:店铺,content:内容,short_video:短视频,user_define:自定义; └ sub_promotion_type String item 推广子主体类型,item:商品，item_private_mini:独享橱窗，shop:店铺，you_hao_huo:有好货，picture:图文，short_video:短视频，live_room:直播间，live_spot:看点，tao_blocks:淘积木，user_define_url:自定义url material CommonMaterialVo 主体类型对应的物料信息 └ material_id Number 714616513841 物料id └ material_type Number 1 物料类型,1:淘宝宝贝,2:淘宝店铺,3:cms LandingPage页面,4:cms 分流总页面,5:自定义,201:PC店铺LandingPage页面,202:无线店铺LandingPage页面,203:内容LandingPage页面,204:淘宝直播,210:淘宝直播用户ID,205:有好货,209:无线店铺Tab3页面,212:超级品牌日LandingPage页面,211:超级发布会LandingPage页面,301:ICBU商品,302:ICBU PC店铺LandingPage页面,303:ICBU PC店铺,8:用户ID,9:信息流淘积木用户ID,10:口碑用户ID,206:店铺优惠券,207:商品优惠券,208:直播单品,309:直播间商品半屏卡,304:1688商品,305:内容平台-短视频,306:附近门店-用户ID,307:饿了么-菜品,401:LAZADA商品,501:飞猪酒店,502:飞猪商品,503:飞猪短信,601:淘积木页面,1001:AE宝贝,1101:淘宝宝贝SKU,310:内容平台-订阅内容 └ material_name String yiliantest测试请不要拍22 物料名称 └ title String yiliantest测试请不要拍22 标题 └ img_url String //img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg 图片地址 └ link_url String http://item.taobao.com/item.htm?id=715121254343 跳转链接 └ price String 999900 价格 └ bid_count Number 899900 销量 └ quantity Number 10 库存 └ first_starts_time Date 2023-04-26 14:51:03 首次上架时间 └ starts Date 2023-04-26 14:51:03 最近上架时间 └ category_id String 16 50010850 主站类目路径，空格分隔多级 └ promotion_type String item 推广主体类型,item:商品,item_private_mini:独享橱窗,shop:店铺,content:内容,short_video:短视频,user_define:自定义; └ sub_promotion_type String item 推广子主体类型,item:商品，item_private_mini:独享橱窗，shop:店铺，you_hao_huo:有好货，picture:图文，short_video:短视频，live_room:直播间，live_spot:看点，tao_blocks:淘积木，user_define_url:自定义url └ alive_group_id Number 0 视频组件id,0:宝贝链接,3:订阅店铺,5:直播,6:加购,7:收藏加购,8:入会有礼,12:关注有礼,11:直播联动,10:自定义模板,13:同店搜 └ alive_group_name String 宝贝链接(默认) 视频组件名称 └ black_creative_status String success 智能创意生成状态,success:合成成功,fail:合成失败 └ count Number 1 数量

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpAdgroupUpdatepartRequest req = new UniversalbpAdgroupUpdatepartRequest();
UniversalbpAdgroupUpdatepartRequest.TopServiceContext obj1 = new UniversalbpAdgroupUpdatepartRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpAdgroupUpdatepartRequest.AdgroupUpdatePartCommandVo obj2 = new UniversalbpAdgroupUpdatepartRequest.AdgroupUpdatePartCommandVo();
obj2.setCampaignId(68796878069L);
obj2.setAdgroupId(68793666608L);
obj2.setMaterialId(714616513841L);
obj2.setDisplayStatus("pause");
req.setDataList(obj2);
UniversalbpAdgroupUpdatepartResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpAdgroupUpdatepartRequest req = new UniversalbpAdgroupUpdatepartRequest();
UniversalbpAdgroupUpdatepartRequest.TopServiceContextDomain obj1 = new UniversalbpAdgroupUpdatepartRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
req.TopServiceContext_ = obj1;
UniversalbpAdgroupUpdatepartRequest.AdgroupUpdatePartCommandVoDomain obj2 = new UniversalbpAdgroupUpdatepartRequest.AdgroupUpdatePartCommandVoDomain();
obj2.CampaignId = 68796878069L;
obj2.AdgroupId = 68793666608L;
obj2.MaterialId = 714616513841L;
obj2.DisplayStatus = "pause";
req.DataList_ = obj2;
UniversalbpAdgroupUpdatepartResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpAdgroupUpdatepartRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$req->setTopServiceContext(json_encode($top_service_context));
$data_list = new AdgroupUpdatePartCommandVo;
$data_list->campaign_id="68796878069";
$data_list->adgroup_id="68793666608";
$data_list->material_id="714616513841";
$data_list->display_status="pause";
$req->setDataList(json_encode($data_list));
$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.universalbp.adgroup.updatepart' \
-d 'partner_id=apidoc' \
-d 'session=d6bd9726-a69e-4852-867d-140c7b43413a' \
-d 'sign=1C103DBADA3DED4F9CD07FD15B43D76B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+16%3A09%3A48' \
-d 'v=2.0' \
-d 'data_list=null' \
-d 'top_service_context=null'

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

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

req.top_service_context="数据结构示例JSON格式"
req.data_list="数据结构示例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.universalbp.adgroup.updatepart");
add_param(pRequest,"top_service_context","数据结构JSON示例");
add_param(pRequest,"data_list","数据结构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.universalbp.adgroup.updatepart', {
	'top_service_context':'数据结构JSON示例',
	'data_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<universalbp_adgroup_updatepart_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <adgroup_v_o_top_bulk_data>
            <adgroup_v_o_list>
                <adgroup_vo>
                    <campaign_id>68796878069</campaign_id>
                    <campaign_name>管家计划_宝贝候选集</campaign_name>
                    <adgroup_id>68793666608</adgroup_id>
                    <adgroup_name>ds460418344</adgroup_name>
                    <online_status>0</online_status>
                    <display_status>pause</display_status>
                    <audit_status>1</audit_status>
                    <audit_reason>xxxxx</audit_reason>
                    <adgroup_ocpc>
                        <enable_ocpc>true</enable_ocpc>
                        <ocpc_ratio>200</ocpc_ratio>
                    </adgroup_ocpc>
                    <promotion_type>item</promotion_type>
                    <sub_promotion_type>item</sub_promotion_type>
                    <material>
                        <material_id>714616513841</material_id>
                        <material_type>1</material_type>
                        <material_name>yiliantest测试请不要拍22</material_name>
                        <title>yiliantest测试请不要拍22</title>
                        <img_url>//img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg</img_url>
                        <link_url>http://item.taobao.com/item.htm?id=715121254343</link_url>
                        <price>999900</price>
                        <bid_count>899900</bid_count>
                        <quantity>10</quantity>
                        <first_starts_time>2023-04-26 14:51:03</first_starts_time>
                        <starts>2023-04-26 14:51:03</starts>
                        <category_id>16 50010850</category_id>
                        <promotion_type>item</promotion_type>
                        <sub_promotion_type>item</sub_promotion_type>
                    </material>
                    <alive_group_id>0</alive_group_id>
                    <alive_group_name>宝贝链接(默认)</alive_group_name>
                    <black_creative_status>success</black_creative_status>
                </adgroup_vo>
            </adgroup_v_o_list>
            <count>1</count>
        </adgroup_v_o_top_bulk_data>
    </result>
</universalbp_adgroup_updatepart_response>

{
    "universalbp_adgroup_updatepart_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "adgroup_v_o_top_bulk_data":{
                "adgroup_v_o_list":{
                    "adgroup_vo":[
                        {
                            "campaign_id":68796878069,
                            "campaign_name":"管家计划_宝贝候选集",
                            "adgroup_id":68793666608,
                            "adgroup_name":"ds460418344",
                            "online_status":0,
                            "display_status":"pause",
                            "audit_status":1,
                            "audit_reason":"xxxxx",
                            "adgroup_ocpc":{
                                "enable_ocpc":true,
                                "ocpc_ratio":200
                            },
                            "promotion_type":"item",
                            "sub_promotion_type":"item",
                            "material":{
                                "material_id":714616513841,
                                "material_type":1,
                                "material_name":"yiliantest测试请不要拍22",
                                "title":"yiliantest测试请不要拍22",
                                "img_url":"\/\/img.alicdn.com\/bao\/uploaded\/i1\/3838159498\/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg",
                                "link_url":"http:\/\/item.taobao.com\/item.htm?id=715121254343",
                                "price":"999900",
                                "bid_count":899900,
                                "quantity":10,
                                "first_starts_time":"2023-04-26 14:51:03",
                                "starts":"2023-04-26 14:51:03",
                                "category_id":"16 50010850",
                                "promotion_type":"item",
                                "sub_promotion_type":"item"
                            },
                            "alive_group_id":0,
                            "alive_group_name":"宝贝链接(默认)",
                            "black_creative_status":"success"
                        }
                    ]
                },
                "count":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下载

万相台无界API

taobao.universalbp.adgroup.updatepart (修改单元或主体状态)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ