淘宝开放平台 - 文档中心

请求地址：

环境	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 可选 {} 扩展内容, 暂时无用
potential_bidword_query_v_o	PotentialBidwordQueryVO	必须	potentialBidwordQueryVO
└ campaign_id Number 可选 70575863770 计划id └ adgroup_id Number 可选 70580701012 单元id └ start_time String 可选 2024-07-27 开始时间 └ end_time String 可选 2024-08-25 结束时间

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 potential_bid_word_v_o_top_bulk_data TopBulkData 结果集 └ count Number 10 成功数量 potential_bid_word_v_o_list PotentialBidWordVO [] 批量成功结果集 └ bidword_pkg_name String 流量智选词包词包名称 └ original_word String 香蕉片原词 └ bidword_id Number 1430453211888 词id └ promotion_name String 【香蕉片250g】进口香蕉干脆片薄片果干休闲零食特产名称 └ adgroup_id Number 70580701012 单元id └ member_id Number 31536383 人员id └ ctr String 0.13103 点击率 └ charge String 624.75 花费 └ ad_pv String 5800.0 展现量 └ click String 760.0 点击量 └ roi String 4.64844 投入产出比 └ cvr String 0.23289 点击转化率 └ ecpc String 0.82204 点击成本 └ col_num String 17.0 总收藏数 └ item_col_inshop_num String 13.0 收藏宝贝数 └ item_col_inshop_cost String 48.05769 宝贝收藏成本 └ cart_inshop_num String 251.0 总购物车数 └ col_cart_num String 268.0 总收藏加购数 └ potential_index String 100.0 潜力指数 └ shop_col_dir_num String 4.0 收藏店铺数 └ alipay_inshop_num String 177.0 总成交笔数 └ alipay_inshop_amt String 2904.11 总成交金额 └ is_black_word Boolean true 是否是屏蔽词 └ alipay_dir_amt String 2904.11 直接成交金额

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewPotentialBidwordFindRequest req = new UniversalbpNewPotentialBidwordFindRequest();
UniversalbpNewPotentialBidwordFindRequest.TopServiceContext obj1 = new UniversalbpNewPotentialBidwordFindRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewPotentialBidwordFindRequest.PotentialBidwordQueryVO obj2 = new UniversalbpNewPotentialBidwordFindRequest.PotentialBidwordQueryVO();
obj2.setCampaignId(70575863770L);
obj2.setAdgroupId(70580701012L);
obj2.setStartTime("2024-07-27");
obj2.setEndTime("2024-08-25");
req.setPotentialBidwordQueryVO(obj2);
UniversalbpNewPotentialBidwordFindResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

XML示例
JSON示例

<universalbp_new_potential_bidword_find_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <potential_bid_word_v_o_top_bulk_data>
            <count>10</count>
            <potential_bid_word_v_o_list>
                <potential_bid_word_v_o>
                    <bidword_pkg_name>流量智选词包</bidword_pkg_name>
                    <original_word>香蕉片</original_word>
                    <bidword_id>1430453211888</bidword_id>
                    <promotion_name>【香蕉片250g】进口香蕉干脆片薄片果干休闲零食特产</promotion_name>
                    <adgroup_id>70580701012</adgroup_id>
                    <member_id>31536383</member_id>
                    <ctr>0.13103</ctr>
                    <charge>624.75</charge>
                    <ad_pv>5800.0</ad_pv>
                    <click>760.0</click>
                    <roi>4.64844</roi>
                    <cvr>0.23289</cvr>
                    <ecpc>0.82204</ecpc>
                    <col_num>17.0</col_num>
                    <item_col_inshop_num>13.0</item_col_inshop_num>
                    <item_col_inshop_cost>48.05769</item_col_inshop_cost>
                    <cart_inshop_num>251.0</cart_inshop_num>
                    <col_cart_num>268.0</col_cart_num>
                    <potential_index>100.0</potential_index>
                    <shop_col_dir_num>4.0</shop_col_dir_num>
                    <alipay_inshop_num>177.0</alipay_inshop_num>
                    <alipay_inshop_amt>2904.11</alipay_inshop_amt>
                    <is_black_word>true</is_black_word>
                    <alipay_dir_amt>2904.11</alipay_dir_amt>
                </potential_bid_word_v_o>
            </potential_bid_word_v_o_list>
        </potential_bid_word_v_o_top_bulk_data>
    </top_result>
</universalbp_new_potential_bidword_find_response>

{
    "universalbp_new_potential_bidword_find_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "potential_bid_word_v_o_top_bulk_data":{
                "count":10,
                "potential_bid_word_v_o_list":{
                    "potential_bid_word_v_o":[
                        {
                            "bidword_pkg_name":"流量智选词包",
                            "original_word":"香蕉片",
                            "bidword_id":1430453211888,
                            "promotion_name":"【香蕉片250g】进口香蕉干脆片薄片果干休闲零食特产",
                            "adgroup_id":70580701012,
                            "member_id":31536383,
                            "ctr":"0.13103",
                            "charge":"624.75",
                            "ad_pv":"5800.0",
                            "click":"760.0",
                            "roi":"4.64844",
                            "cvr":"0.23289",
                            "ecpc":"0.82204",
                            "col_num":"17.0",
                            "item_col_inshop_num":"13.0",
                            "item_col_inshop_cost":"48.05769",
                            "cart_inshop_num":"251.0",
                            "col_cart_num":"268.0",
                            "potential_index":"100.0",
                            "shop_col_dir_num":"4.0",
                            "alipay_inshop_num":"177.0",
                            "alipay_inshop_amt":"2904.11",
                            "is_black_word":true,
                            "alipay_dir_amt":"2904.11"
                        }
                    ]
                }
            }
        }
    }
}

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>

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

万相台无界API

taobao.universalbp.new.potential.bidword.find (查询潜力关键词列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ