alipay.open.public.personalized.extension.create(个性化扩展区创建接口) 在线调试(沙箱环境)

开发者可使用该接口创建一套个性化扩展区,符合该扩展区规则的用户进入生活号主页后会看到该个性化扩展区

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
areas ExtensionArea[] 必选 扩展区列表,最大条数为3
name String 必填 12 扩展区名字 扩展区1号
type String 必填 10 扩展区类型,支持两个值,h5:h5类型,image:图片类型。 h5
url String 必填 1200 扩展区url,传入图片url或者h5页面url,必须是https开头的链接,如果要传入图片链接,请先调用 图片上传接口获得图片url https://www.example.com
goto_url String 可选 1200 跳转链接,当content_type为"image"时必传,必须是https或alipays开头的url链接 https://www.alipay.com
height Number 可选 12 扩展区高度,当content_type值为"h5"时必填,取值范围为200-500的整数 200
label_rule LabelRule[] 必选 标签规则,目前限定只能传入1条,在扩展区上线后,满足该标签规则的用户进入生活号首页,将看到该套扩展区。
label_id String 必填 32 标签id 10000
operator String 必填 10 目前支持EQ(等于)、BETWEEN(范围)、IN(包含)三种操作符;每个标签支持的运算符可以通过查询接口获得。该字段允许为空,默认运算符为IN EQ
label_value String 必填 120 标签值,当有多个取值时用英文","分隔,不允许传入下划线"_"、竖线"|"或者空格" "和方括号"["、"]" 山东,浙江

响应参数

参数 类型 是否必填 最大长度 描述 示例值
extension_key String 必填 32 扩展区套id,创建个性化扩展区成功后,支付宝会将该字段返回,后续扩展区上下线或者扩展区删除都会用到这个值。 10000

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicPersonalizedExtensionCreateRequest request = new AlipayOpenPublicPersonalizedExtensionCreateRequest();
request.setBizContent("{" +
"      \"areas\":[{" +
"        \"name\":\"扩展区1号\"," +
"\"type\":\"h5\"," +
"\"url\":\"https://www.example.com\"," +
"\"goto_url\":\"https://www.alipay.com\"," +
"\"height\":200" +
"        }]," +
"      \"label_rule\":[{" +
"        \"label_id\":\"10000\"," +
"\"operator\":\"EQ\"," +
"\"label_value\":\"山东,浙江\"" +
"        }]" +
"  }");
AlipayOpenPublicPersonalizedExtensionCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_personalized_extension_create_response": {
        "code": "10000",
        "msg": "Success",
        "extension_key": "10000"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
EXTENSION_AREAS_IS_EMPTY 扩展区数据不能为空 扩展区数据不能为空
AREA_COUNT_INVALID 扩展区数据条数超限 扩展区条数最大为3
LABEL_RULES_IS_EMPTY 标签规则不能为空 标签规则不能为空
RULE_COUNT_INVALID 标签规则条数超限 标签规则条数超限
ILLEGAL_BIZ_PARAMS 扩展区入参非法 检查扩展区入参,content、contentType是否已传入
EXTENSION_PARAM_URL_ERROR url错误 检查传入的content,是否都是https开头的链接
EXTENSION_PARAM_TYPE_ERROR 扩展区类型有误 扩展区类型只支持h5或者image
AREA_HEIGHT_IS_INVALID 扩展区高度不合法 当类型为"h5"时,扩展区高度不能为空,高度的取值范围是200-500
GOTO_URL_IS_INVALID goto_url不合法 当类型为image时,goto_url不能为空,且必须以https或者alipays开头
LABEL_ID_IS_EMPTY 标签id不能为空 标签id不能为空
LABEL_VALUE_IS_EMPTY 标签值不能为空 标签值不能为空
LABEL_VALUE_INVALID 标签值不合法 标签值不合法
LABEL_NOT_EXISTS 应用没有这个标签 更换标签id值
RULE_CONTENT_INVALID 标签规则内容不合法 标签规则内容不合法
onlineServer