文档中心 > API类目 > 物流API

cainiao.pickup.business.advert.get (菜鸟商家寄件获取广告信息（待下线）)

当我们跟外部平台(可能是企业)合作时，如果外部企业给我们一块广告位，我们需要把这些信息展示给外部平台。API用户获取广告信息。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述

响应参数

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回结果
data MarketingSenseEntryInfo {} 返回对象 └ market_entry_display_type String 图片营销展示方式，比如是图片/文字之类的 └ title String 年中大促该营销广告信息的title └ desc String 618当天下单立减5元该营销广告信息的描述 └ benifit_desc String 下单立减该营销信息的利益点描述 └ resource_url String https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg 营销信息可能是通过一个图片或者其它资源来展示，展示需要图片地址，采用该地址进行展示 └ view_detail_url String http://static.kuaidizs.cn/operation/action?_b=75610DF231386CBFF1C6B464C9666763 可能我们的消费者需要点击营销信息查看详情，该地址可以查看。如果该地址为空，说明不能点击 └ success Boolean true 请求是否成功 └ retry Boolean false 是否需要重试

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessAdvertGetRequest req = new CainiaoPickupBusinessAdvertGetRequest();
CainiaoPickupBusinessAdvertGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessAdvertGetRequest req = new CainiaoPickupBusinessAdvertGetRequest();
CainiaoPickupBusinessAdvertGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessAdvertGetRequest;
$resp = $c->execute($req);

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=cainiao.pickup.business.advert.get' \
-d 'partner_id=apidoc' \
-d 'sign=06EE94CDFBD6E7D2E4D9C7AE7C596A6B' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-09-27+12%3A18%3A37' \
-d 'v=2.0'

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

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

try:
	resp= req.getResponse()
	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,"cainiao.pickup.business.advert.get");
pResponse = top_execute(pClient,pRequest,NULL);
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('cainiao.pickup.business.advert.get' {
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<cainiao_pickup_business_advert_get_response>
    <result>
        <data>
            <market_entry_display_type>图片</market_entry_display_type>
            <title>年中大促</title>
            <desc>618当天下单立减5元</desc>
            <benifit_desc>下单立减</benifit_desc>
            <resource_url>https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg</resource_url>
            <view_detail_url>http://static.kuaidizs.cn/operation/action?_b=75610DF231386CBFF1C6B464C9666763</view_detail_url>
        </data>
        <success>true</success>
        <retry>false</retry>
    </result>
</cainiao_pickup_business_advert_get_response>

{
    "cainiao_pickup_business_advert_get_response":{
        "result":{
            "data":{
                "market_entry_display_type":"图片",
                "title":"年中大促",
                "desc":"618当天下单立减5元",
                "benifit_desc":"下单立减",
                "resource_url":"https:\/\/pic1.zhimg.com\/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg",
                "view_detail_url":"http:\/\/static.kuaidizs.cn\/operation\/action?_b=75610DF231386CBFF1C6B464C9666763"
            },
            "success":true,
            "retry":false
        }
    }
}

异常示例

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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

物流API

cainiao.pickup.business.advert.get (菜鸟商家寄件获取广告信息（待下线）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ