淘宝开放平台 - 文档中心

请求地址：

环境	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_context	TopContextDto	必须		用户信息
└ product_line_id Number 必须 110101 产品线id └ product_id Number 必须 110101010 产品id
campaign_id	Number	必须	1	计划id
ad_group_query	AdGroupQueryDto	必须		入参
└ adgroup_online_status Number 可选 11 推广组线上状态 └ product_id Number 可选 1 产品id └ group_lv1_id Number 可选 1 1级分组 └ group_lv2_id Number 可选 2 2级分组 └ group_lv3_id Number 可选 3 3级分组 └ cate_lv1_id Number 可选 1 1级类目 └ cate_lv2_id Number 可选 2 2级类目 └ cate_lv3_id Number 可选 3 3级类目 └ campaign_type Number 可选 1 计划类型 └ campaign_status Number 可选 1 计划状态 └ ad_group_id Number 可选 1 推广组id └ ad_group_status Number 可选 1 推广组状态 └ ads_line_id Number 可选 1 产品线id └ ads_id Number 可选 1 产品id └ subject String 可选 1 标题 └ owner_member_id String 可选 1 发品用户id └ order_by String 可选 test 排序字段 └ order String 可选 asc 正序 └ page Number 可选 10 页码 └ size Number 可选 1 每页数量 └ paging Boolean 可选 true 分页

名称	类型	示例值	描述
result	PageResultDTO		返回结果类
result_list AdProductDTO [] [] 返回数据 └ campaign_id Number 1 计划id └ campaign_type Number 1 计划类型 └ campaign_status Number 1 计划状态 └ ad_group_id Number 1 组id └ ad_group_status Number 1 推广组状态 └ ads_line_id Number 1 产品线id └ ads_id Number 1 产品id └ id Number 1 主键id └ gmt_create Date 1970-01-01 00:00:00 创建时间 └ gmt_modified Date 1970-01-01 00:00:00 修改时间 └ product_id Number 1 商品id └ subject String test 商品标题 └ group_lv1_id Number 1 1级分组 └ group_lv2_id Number 2 2级分组 └ group_lv3_id Number 3 3级分组 └ cate_lv1_id Number 1 1级类目 └ cate_lv2_id Number 2 2级类目 └ cate_lv3_id Number 3 3级类目 └ gmt_posting_create Date 1970-01-01 00:00:00 posting创建时间 └ gmt_posting_modified Date 1970-01-01 00:00:00 posting修改时间 effect AdProductEffectDto {} 效果数据 └ impr_cnt Number 1 曝光 └ click_cnt Number 1 点击 └ cost_amt Number 1 消耗(分) └ total_count Number 1 总数量 └ key String 错误信息错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaScbpAdGroupFindAdGroupRequest req = new AlibabaScbpAdGroupFindAdGroupRequest();
AlibabaScbpAdGroupFindAdGroupRequest.TopContextDto obj1 = new AlibabaScbpAdGroupFindAdGroupRequest.TopContextDto();
obj1.setProductLineId(110101L);
obj1.setProductId(110101010L);
req.setTopContext(obj1);
req.setCampaignId(1L);
AlibabaScbpAdGroupFindAdGroupRequest.AdGroupQueryDto obj2 = new AlibabaScbpAdGroupFindAdGroupRequest.AdGroupQueryDto();
obj2.setAdgroupOnlineStatus(11L);
obj2.setProductId(1L);
obj2.setGroupLv1Id(1L);
obj2.setGroupLv2Id(2L);
obj2.setGroupLv3Id(3L);
obj2.setCateLv1Id(1L);
obj2.setCateLv2Id(2L);
obj2.setCateLv3Id(3L);
obj2.setCampaignType(1L);
obj2.setCampaignStatus(1L);
obj2.setAdGroupId(1L);
obj2.setAdGroupStatus(1L);
obj2.setAdsLineId(1L);
obj2.setAdsId(1L);
obj2.setSubject("1");
obj2.setOwnerMemberId("1");
obj2.setOrderBy("test");
obj2.setOrder("asc");
obj2.setPage(10L);
obj2.setSize(1L);
obj2.setPaging(true);
req.setAdGroupQuery(obj2);
AlibabaScbpAdGroupFindAdGroupResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

XML示例
JSON示例

<alibaba_scbp_ad_group_find_ad_group_response>
    <result>
        <result_list>
            <ad_product_d_t_o>
                <campaign_id>1</campaign_id>
                <campaign_type>1</campaign_type>
                <campaign_status>1</campaign_status>
                <ad_group_id>1</ad_group_id>
                <ad_group_status>1</ad_group_status>
                <ads_line_id>1</ads_line_id>
                <ads_id>1</ads_id>
                <id>1</id>
                <gmt_create>1970-01-01 00:00:00</gmt_create>
                <gmt_modified>1970-01-01 00:00:00</gmt_modified>
                <product_id>1</product_id>
                <subject>test</subject>
                <group_lv1_id>1</group_lv1_id>
                <group_lv2_id>2</group_lv2_id>
                <group_lv3_id>3</group_lv3_id>
                <cate_lv1_id>1</cate_lv1_id>
                <cate_lv2_id>2</cate_lv2_id>
                <cate_lv3_id>3</cate_lv3_id>
                <gmt_posting_create>1970-01-01 00:00:00</gmt_posting_create>
                <gmt_posting_modified>1970-01-01 00:00:00</gmt_posting_modified>
                <effect>
                    <impr_cnt>1</impr_cnt>
                    <click_cnt>1</click_cnt>
                    <cost_amt>1</cost_amt>
                </effect>
            </ad_product_d_t_o>
        </result_list>
        <total_count>1</total_count>
        <key>错误信息</key>
    </result>
</alibaba_scbp_ad_group_find_ad_group_response>

{
    "alibaba_scbp_ad_group_find_ad_group_response":{
        "result":{
            "result_list":{
                "ad_product_d_t_o":[
                    {
                        "campaign_id":1,
                        "campaign_type":1,
                        "campaign_status":1,
                        "ad_group_id":1,
                        "ad_group_status":1,
                        "ads_line_id":1,
                        "ads_id":1,
                        "id":1,
                        "gmt_create":"1970-01-01 00:00:00",
                        "gmt_modified":"1970-01-01 00:00:00",
                        "product_id":1,
                        "subject":"test",
                        "group_lv1_id":1,
                        "group_lv2_id":2,
                        "group_lv3_id":3,
                        "cate_lv1_id":1,
                        "cate_lv2_id":2,
                        "cate_lv3_id":3,
                        "gmt_posting_create":"1970-01-01 00:00:00",
                        "gmt_posting_modified":"1970-01-01 00:00:00",
                        "effect":{
                            "impr_cnt":1,
                            "click_cnt":1,
                            "cost_amt":1
                        }
                    }
                ]
            },
            "total_count":1,
            "key":"错误信息"
        }
    }
}

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

alibaba.scbp.ad.group.find.ad.group (查询推广组)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ