alipay.open.public.advert.create(生活号广告位添加接口) 在线调试(沙箱环境)

可通过本接口在生活号主页添加广告位,根据业务需求配置不同的图片和跳转链接

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.advert.create
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
advert_items AdvertItem[] 必选 广告位轮播内容列表,数量限制:大于1个,小于5个,广告位轮播内容顺序,根据接口传入的顺序排列
img_url String 必填 128 广告图片url, 尺寸为996*240,最大不超过5M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx
link_url String 必填 1024 跳转链接,点击广告图片跳到的链接url https://www.alipay.com

响应参数

参数 类型 是否必填 最大长度 描述 示例值
advert_id String 必填 20 广告位id 123

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicAdvertCreateRequest request = new AlipayOpenPublicAdvertCreateRequest();
request.setBizContent("{" +
"      \"advert_items\":[{" +
"        \"img_url\":\"https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx\"," +
"\"link_url\":\"https://www.alipay.com\"" +
"        }]" +
"  }");
AlipayOpenPublicAdvertCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_advert_create_response": {
        "code": "10000",
        "msg": "Success",
        "advert_id": "123"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
ILLEGAL_BIZ_PARAMS 无效的业务参数 检查业务参数是否合法
PUBLIC_ADVERT_SIZE_INVALID 轮播广告位数量须为1-3个 请检查广告位个数是否符合
PUBLIC_ADVERT_IMGURL_IS_BLANK 轮播广告位图片URL不能为空 请检查轮播广告位图片URL是否为空
PUBLIC_ADVERT_IMGURL_ILLEGAL 轮播广告位图片URL不合法 请检查图片url格式是否正确,请先调用https://docs.open.alipay.com/api_3/alipay.offline.material.image.upload 图片上传接口获得图片url
PUBLIC_ADVERT_LINKURL_IS_BLANK 跳转链接URL不能为空 跳转链接URL不能为空
PUBLIC_ADVERT_LINKURL_ILLEGAL 跳转链接URL格式不正确 请检查跳转链接URL格式是否正确
PUBLIC_ADVERT_IMGURL_OVERSIZE 图片URL最多包含255个字符 请注意检查图片URL长度是否符合
PUBLIC_ADVERT_LINKURL_OVERSIZE 跳转链接URL最多包含255个字符 请检查跳转URL长度是否符合
LIFE_APP_FILE_TOO_LARGE 生活号图片上传文件过大 生活号图片文件不能大于5M
PUBLIC_IMG_TYPE_INVALID 图片类型不正确, 建议格式: jpg、png 请检查图片类型是否正确, 建议格式: jpg、png
PUBLIC_ADVERT_EXISTS 广告位已经存在,请勿重复添加 广告位已经存在了,请调用更新接口更新
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
BUSINESS_ERROR 系统业务处理错误 请检查输入参数是否正确,或者稍后重试
onlineServer