通用场景
修改搜索直达活动配置
公共请求参数
业务请求参数
box_activity_id｜搜索直达活动id必选string[1,32]
【描述】搜索直达活动id
【示例值】20211223000000100000
title｜活动标题必选string[1,12]
【描述】活动标题
【示例值】活动标题
material_type｜素材类型必选string[1,8]
【描述】image-图片/video-视频
【枚举值】
图片: image
视频: video
直播: live
【示例值】image
target_appid｜目标小程序id必选string[0,18]
【描述】跳转应用id
【示例值】2021001191699651
target_appname｜目标小程序名必选string[1,24]
【描述】目标小程序名称
【示例值】目标小程序名
target_regions｜投放目标区域列表必选array
【描述】投放目标区域列表
region_code｜区域编码可选string[1,12]
【描述】区域编码，参考
【示例值】110100
region_type｜区域类型可选string[1,1]
【描述】区域类型，1代表全国，2代表省级区域，3代表市级区域，参考
【枚举值】
全部: 1
省级区域: 2
市级区域: 3
【示例值】3
region_name｜区域编码可选string[1,12]
【描述】区域名，参考
【示例值】北京市
start_time｜活动开始时间必选string[1,24]
【描述】活动开始时间，开始时间和结束时间之间不能超过90天
【示例值】2022-02-10 08:00:00
end_time｜活动结束时间必选string[1,24]
【描述】活动结束时间，开始时间和结束时间之间不能超过90天
【示例值】2022-09-30 23:59:59
action_url｜活动链接必选string[1,128]
【描述】活动链接，必须为关联的小程序的页面链接（链接以 alipays 开头），可参考 小程序scheme链接介绍
【示例值】alipays://platformapi/startapp?appid=2021001198637195&pages/kaq_maid/kaq_maid
material_id｜素材id可选string[1,128]
【描述】当material_type="image"时，为图片id；当material_type="video"时，为视频id。图片id可以通过调用接口alipay.open.file.upload上传图片，获取图片id(bizcode：search_box_banner)。规范详情可查看 。
【示例值】20211206ob020010034807196034
video_info｜活动视频信息可选searchboxactivityvideoinfo
【描述】活动视频信息
video_title｜视频主标题可选string[2,10]
【描述】视频主标题，2-10个汉字
【示例值】xx美容套组0元领
video_sub_title｜视频副标题可选string[2,16]
【描述】视频副标题，2-16个汉字
【示例值】洁面 电动洁面仪=免费试用
video_btn_text｜视频按钮文案可选string[0,4]
【描述】视频按钮文案，2-4个汉字
【示例值】去领取
video_coverimg_id｜视频封面图片id可选string[0,128]
【描述】视频封面图片id，图片id可以通过调用接口alipay.open.file.upload上传图片，获取图片id。图片规范：https://opendocs.alipay.com/mini/operation/atmospheredesign
【示例值】a*ozqmt4xtbpuaaaaaaaaaaaaaaqaaaq
background_word｜搜索底纹推广词可选string[0,20]
【描述】创建banner活动时，可添加底纹推广词，有机会在凯发k8官方网娱乐官方首页搜索框内展示，提升banner活动曝光机会
【示例值】搜索底纹推广词
oriented_rule｜投放终端可选deliveryorientedruleinfo
【描述】投放终端
client_platform｜客户端可选string[3,10]
【描述】客户端
【枚举值】
全部: all
ios: ios
安卓: android
【示例值】android
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.search.boxactivity.modify&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"box_activity_id":"20211223000000100000",
"title":"活动标题",
"material_type":"image",
"material_id":"20211206ob020010034807196034",
"target_appid":"2021001191699651",
"target_appname":"目标小程序名",
"target_regions":[
{
"region_type":"3",
"region_name":"北京市",
"region_code":"110100"
}
],
"start_time":"2022-02-10 08:00:00",
"end_time":"2022-09-30 23:59:59",
"video_info":{
"video_sub_title":"洁面 电动洁面仪=免费试用",
"video_title":"xx美容套组0元领",
"video_btn_text":"去领取",
"video_coverimg_id":"a*ozqmt4xtbpuaaaaaaaaaaaaaaqaaaq"
},
"action_url":"alipays://platformapi/startapp?appid=2021001198637195&pages/kaq_maid/kaq_maid",
"background_word":"搜索底纹推广词",
"oriented_rule":{
"client_platform":"android"
}
}' 说明：本示例仅供参考。
公共响应参数
业务响应参数
无业务响应参数
响应示例
正常示例
异常示例
{
"alipay_open_search_boxactivity_modify_response": {
"code": "10000",
"msg": "success"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| delivery_time_overlapping | 投放时间与其他活动时间存在冲突 | 请重新选择投放时间 |
| input_argument_illegal | 参数有误输入参数非法 | 请参考接口文档检查参数是否正确 |
| input_argument_illegal | 活动参数不符合业务规则 | 活动参数不符合业务规则 |
| input_argument_null | 输入参数为空 | 请参考接口文档检查参数是否正确 |
| isv_not_auth | 服务商未被商家授权 | 请找对应商家授权 |
| no_permission | 权限校验失败 | 请确认是否具备对应操作权限 |
| over_act_max_limit | 业务异常当前品牌直达下的生效活动最多不可超过3个 | 请检查已生效活动配置 |
| status_not_allowed_operate | 当前状态不允许进行此操作 | 请检查当前状态 |