alipay.marketing.cdp.advertise.query (查询广告接口)

开发者可查询广告内容和状态。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.cdp.advertise.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
ad_id String 必须 20 广告Id,唯一标识一条广告 100

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
ad_code String 必填 32 广告位标识码,目前广告位只支持在支付宝钱包中显示,口碑app暂不支持。传值:CDP_OPEN_MERCHANT CDP_OPEN_MERCHANT
content_type String 必填 32 广告内容类型,目前包括HTML5和图片,分别传入:URL和PIC URL或者PIC
content String 必填 2048 广告内容。如果广告类型是HTML5,则传入H5链接地址,建议为https协议。最大尺寸不得超过1242px*242px,小屏幕将按分辨率宽度同比例放大缩小;如果类型是图片,则传入图片ID标识,如何获取图片ID参考图片上传接口:alipay.offline.material.image.upload。图片尺寸为1242px*290px。图片大小不能超过50kb。 https://m.alipay.com/J/dfdf
action_url String 选填 2048 用户点击广告后,跳转URL地址, 协议必须为HTTPS。广告类型为PIC时,需要设置该值。对于类型为URL不生效 https://m.alipay.com/J/dfdf
ad_rules String 必填 2048 该规则用于商家设置对用户是否展示广告的校验条件,目前支持设置商家店铺规则。按业务要求应用对应规则即可 {"shop_id":["2015090800077000000002549828"]}
height String 选填 20 当广告类型是H5时,必须传入内容高度。对于广告位CDP_OPEN_MERCHANT的内容高度不能高于钱包要求的展位高度242px。当广告类型是图片时,不需要传入内容高度(height),系统会检查用户上传的图片尺寸是否符合要求,对于广告位CDP_OPEN_MERCHANT的图片尺寸要求:宽1242px, 高290px,大小50kb,实际上传图片与图片标准宽高必须一致,图片大小不能超过50kb。 100
status String 必填 10 在线:ONLINE , 下线:OFFLINE ONLINE
start_time Date 必填 32 投放广告开始时间,使用标准时间格式:yyyy-MM-dd HH:mm:ss,如果不设置,默认投放时间一个月 2016-02-24 12:12:12
end_time Date 必填 32 投放广告结束时间,使用标准时间格式:yyyy-MM-dd HH:mm:ss,如果不设置,默认投放时间一个月 2017-02-24 12:12:12

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCdpAdvertiseQueryRequest request = new AlipayMarketingCdpAdvertiseQueryRequest();
request.setBizContent("{" +
"\"ad_id\":\"100\"" +
"  }");
AlipayMarketingCdpAdvertiseQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_marketing_cdp_advertise_query_response":{
		"msg":"Success",
		"action_url":"https://m.alipay.com/J/dfdf",
		"ad_rules":"{\"shop_id\":[\"2015090800077000000002549828\"]}",
		"start_time":"2016-02-24 12:12:12",
		"code":"10000",
		"ad_code":"CDP_OPEN_MERCHANT",
		"content_type":"URL或者PIC",
		"end_time":"2017-02-24 12:12:12",
		"content":"https://m.alipay.com/J/dfdf",
		"height":"100",
		"status":"ONLINE"
	}
}

异常示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_marketing_cdp_advertise_query_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

业务错误码

错误码 错误描述 解决方案
AD_ID_NOT_BANK 广告ID为空 检查参数
AD_OBJECT_NOT_EXIST 广告内容不存在 正常返回
AD_PID_NOT_MATCH 非法操作,PID不匹配 检查参数

公共错误码

返回
顶部