淘宝开放平台 - 文档中心

请求地址：

环境	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业务线编码 └ login_type Number 可选 1 1: 直客(正常)登录 2: 代理直投(叉乘账号) └ member_id Number 可选 12345 代理直投时被代理商家账号, 代理直投（叉乘）时必填。直客时也可以填入 memberId └ ext String 可选 {} 扩展内容, 暂时无用
word_package_query_v_o	WordPackageQueryVO	必须	关键词词包查询
└ campaign_id_list Number [] 可选 [68792788657] 计划id集合,计划已经存在场景必填 └ adgroup_id_list Number [] 可选 [68798447504] 单元id集合,单元已经存在场景必填 rpt_query RptQueryVO 可选横向管理-实体数据列表-通用报表查询条件报表数据查询条件 └ fields String 可选 adPv,click,charge,ctr,ecpc,ecpm 查询指标字段 condition_list RptQueryConditionVO [] 可选报表查询条件 └ start_time String 可选 2023-10-08 开始时间 └ end_time String 可选 2023-10-08 结束时间 └ adzone_pkg_id_list String [] 可选 ["114790550288", "114790550289", "114793500012", "114786650498"] 流量来源（资源位包id） └ is_rt Boolean 可选 true 是否查询实时报表，true查实时、false查离线，不传则默认查离线 └ unify_type String 可选 zhai 归因类型 └ source_list String [] 可选 ["campaign_detail","adgroup_list"] 来源,根据场景去选择,有的不需要传

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 word_package_v_o_top_bulk_data TopBulkData 结果集 └ count Number 10 成功数量 word_package_v_o_list WordPackageVO [] 批量成功结果集 └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ adgroup_id Number 68793666608 单元id └ word_package_id Number 38577 词包id └ word_package_name String 流量智选词包名称 └ word_package_type Number 20 词包类型,0:流量智选,1:好词优选,19:捡漏,20:卖点词包,21:类目优选 └ status Number 1 词包状态,1:在线,0:下线 └ bid_price String 5 词包基础出价 strategy_list WordPackageStrategyVO [] 词包策略信息 └ strategy_id Number 2 词包策略,0:流量智选,1:好词优选,2:捡漏,2:卖点词包,3:类目优选 └ strategy_name String 好词优选词包策略名称 └ word_package_type Number 20 词包类型,0:流量智选,1:好词优选,19:捡漏,20:卖点词包,21:类目优选 └ bid_price String 2.23 关键词基础出价 └ online_status Number 1 策略状态,1:在线,0:下线 └ adgroup_id Number 68793666608 单元id └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ report_info_map String 报表数据 └ report_info_map String 报表数据

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewWordpackageFindlistRequest req = new UniversalbpNewWordpackageFindlistRequest();
UniversalbpNewWordpackageFindlistRequest.TopServiceContext obj1 = new UniversalbpNewWordpackageFindlistRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewWordpackageFindlistRequest.WordPackageQueryVO obj2 = new UniversalbpNewWordpackageFindlistRequest.WordPackageQueryVO();
obj2.setCampaignIdList(new Long[] { 68792788657 };
);
obj2.setAdgroupIdList(new Long[] { 68798447504 };
);
UniversalbpNewWordpackageFindlistRequest.RptQueryVO obj3 = new UniversalbpNewWordpackageFindlistRequest.RptQueryVO();
obj3.setFields("adPv,click,charge,ctr,ecpc,ecpm");
List<UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVO> list5 = new ArrayList<UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVO>();
UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVO obj6 = new UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVO();
list5.add(obj6);
obj6.setStartTime("2023-10-08");
obj6.setEndTime("2023-10-08");
obj6.setAdzonePkgIdList(""114790550288", "114790550289", "114793500012", "114786650498"");
obj6.setIsRt(true);
obj6.setUnifyType("zhai");
obj6.setSourceList(""campaign_detail","adgroup_list"");
obj3.setConditionList(list5);
obj2.setRptQuery(obj3);
req.setWordPackageQueryVO(obj2);
UniversalbpNewWordpackageFindlistResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewWordpackageFindlistRequest req = new UniversalbpNewWordpackageFindlistRequest();
UniversalbpNewWordpackageFindlistRequest.TopServiceContextDomain obj1 = new UniversalbpNewWordpackageFindlistRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewWordpackageFindlistRequest.WordPackageQueryVODomain obj2 = new UniversalbpNewWordpackageFindlistRequest.WordPackageQueryVODomain();
obj2.CampaignIdList = new long[] { 68792788657 };
;
obj2.AdgroupIdList = new long[] { 68798447504 };
;
UniversalbpNewWordpackageFindlistRequest.RptQueryVODomain obj3 = new UniversalbpNewWordpackageFindlistRequest.RptQueryVODomain();
obj3.Fields = "adPv,click,charge,ctr,ecpc,ecpm";
List<UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVODomain> list5 = new List<UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVODomain>();
UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVODomain obj6 = new UniversalbpNewWordpackageFindlistRequest.RptQueryConditionVODomain();
list5.Add(obj6);
obj6.StartTime = "2023-10-08";
obj6.EndTime = "2023-10-08";
obj6.AdzonePkgIdList = ""114790550288", "114790550289", "114793500012", "114786650498"";
obj6.IsRt = true;
obj6.UnifyType = "zhai";
obj6.SourceList = ""campaign_detail","adgroup_list"";
obj3.ConditionList= list5;
obj2.RptQuery= obj3;
req.WordPackageQueryVO_ = obj2;
UniversalbpNewWordpackageFindlistResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewWordpackageFindlistRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$top_service_context->login_type="1";
$top_service_context->member_id="12345";
$top_service_context->ext="{}";
$req->setTopServiceContext(json_encode($top_service_context));
$word_package_query_v_o = new WordPackageQueryVO;
$word_package_query_v_o->campaign_id_list="[68792788657]";
$word_package_query_v_o->adgroup_id_list="[68798447504]";
$rpt_query = new RptQueryVO;
$rpt_query->fields="adPv,click,charge,ctr,ecpc,ecpm";
$condition_list = new RptQueryConditionVO;
$condition_list->start_time="2023-10-08";
$condition_list->end_time="2023-10-08";
$condition_list->adzone_pkg_id_list="[\"114790550288\", \"114790550289\", \"114793500012\", \"114786650498\"]";
$condition_list->is_rt="true";
$condition_list->unify_type="zhai";
$condition_list->source_list="[\"campaign_detail\",\"adgroup_list\"]";
$rpt_query->condition_list = $condition_list;
$word_package_query_v_o->rpt_query = $rpt_query;
$req->setWordPackageQueryVO(json_encode($word_package_query_v_o));
$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.new.wordpackage.findlist' \
-d 'partner_id=apidoc' \
-d 'session=af6b8764-6e0d-44c2-9590-ea4eaa3a6f55' \
-d 'sign=890181C52ABF12D9275FD3C96F8540F3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A29%3A40' \
-d 'v=2.0' \
-d 'top_service_context=TopServiceContext' \
-d 'word_package_query_v_o=%E5%85%B3%E9%94%AE%E8%AF%8D%E8%AF%8D%E5%8C%85%E6%9F%A5%E8%AF%A2'

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

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

req.top_service_context="TopServiceContext"
req.word_package_query_v_o="关键词词包查询"
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.new.wordpackage.findlist");
add_param(pRequest,"top_service_context","数据结构JSON示例");
add_param(pRequest,"word_package_query_v_o","数据结构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.new.wordpackage.findlist', {
	'top_service_context':'数据结构JSON示例',
	'word_package_query_v_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<universalbp_new_wordpackage_findlist_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <word_package_v_o_top_bulk_data>
            <count>10</count>
            <word_package_v_o_list>
                <word_package_v_o>
                    <campaign_id>68796878069</campaign_id>
                    <adgroup_id>68793666608</adgroup_id>
                    <word_package_id>38577</word_package_id>
                    <word_package_name>流量智选</word_package_name>
                    <word_package_type>20</word_package_type>
                    <status>1</status>
                    <bid_price>5</bid_price>
                    <strategy_list>
                        <word_package_strategy_v_o>
                            <strategy_id>2</strategy_id>
                            <strategy_name>好词优选</strategy_name>
                            <word_package_type>20</word_package_type>
                            <bid_price>2.23</bid_price>
                            <online_status>1</online_status>
                            <adgroup_id>68793666608</adgroup_id>
                            <campaign_id>68796878069</campaign_id>
                        </word_package_strategy_v_o>
                    </strategy_list>
                </word_package_v_o>
            </word_package_v_o_list>
        </word_package_v_o_top_bulk_data>
    </top_result>
</universalbp_new_wordpackage_findlist_response>

{
    "universalbp_new_wordpackage_findlist_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "word_package_v_o_top_bulk_data":{
                "count":10,
                "word_package_v_o_list":{
                    "word_package_v_o":[
                        {
                            "campaign_id":68796878069,
                            "adgroup_id":68793666608,
                            "word_package_id":38577,
                            "word_package_name":"流量智选",
                            "word_package_type":20,
                            "status":1,
                            "bid_price":"5",
                            "strategy_list":{
                                "word_package_strategy_v_o":[
                                    {
                                        "strategy_id":2,
                                        "strategy_name":"好词优选",
                                        "word_package_type":20,
                                        "bid_price":"2.23",
                                        "online_status":1,
                                        "adgroup_id":68793666608,
                                        "campaign_id":68796878069
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        }
    }
}

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.new.wordpackage.findlist (词包列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ