创建推广计划接口 -凯发app官方网站

产品地图

支付产品

私域产品

公域产品

经营推广

产品介绍

权限集列表

引流转化

接入指南

api 列表

推广计划

创建推广计划接口

图片素材

商品卖货

营销产品

资金产品

会员产品

信用产品

安全产品

广告产品

支持第三方代理调用

更新时间：2024-07-03 14:36:28

订阅更新

我的文档

设置

接入检测（

即可查看检测结果）

若有未通过的接入检测项，接口将无法调通

日常推广-优惠券

支持将已配好的商家券一键投放到支付宝多个渠道，通过流量推荐，快速拉新获客。

公共请求参数

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

业务请求参数

delivery_booth_code｜展位编码必选string[1,32]

【描述】推广的展位编码。
public_union：日常推广。

【示例值】public_union

out_biz_no｜外部业务单号必选string[1,64]

【描述】外部业务单号，用作幂等控制。幂等作用：请求返回与上一次相同的结果。外部接入方需保证业务单号唯一。

【示例值】20170101000001654bb46ba

delivery_base_info｜投放计划基础信息必选deliverybaseinfo

【描述】推广计划基础信息。

delivery_name｜投放计划名称必选string[1,20]

【描述】推广计划名称。
推广计划名称不会对用户进行表达，只用于商户管理使用。长度需要大于等于3，小于等于20。

【示例值】第十期投放计划

delivery_begin_time｜投放计划开始时间必选date

【描述】推广计划开始时间。格式为：yyyy-mm-dd hh:mm:ss。

【示例值】2017-01-01 00:00:01

delivery_end_time｜投放计划结束时间必选date

【描述】推广计划结束时间。格式为：yyyy-mm-dd hh:mm:ss。

【示例值】2017-01-01 00:00:01

delivery_material｜投放素材信息必选deliverymaterial

【描述】推广计划素材信息。

delivery_single_material｜单素材对象必选deliverysinglematerial

【描述】单素材对象

delivery_image｜投放计划图片素材必选string[1,128]

【描述】推广计划图片素材。通过接口alipay.marketing.material.image.upload上传图片返回的resource_id。接口需指定file_key为public_union_channel_pic。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过200kb。上传图片更多要求参考文档：
https://render.alipay.com/p/c/18tpirlg12e8?operatefrom=balipay。

【示例值】a*wxytaswgww

delivery_play_config｜投放计划玩法配置必选deliveryplayconfig

【描述】推广计划发放配置。

delivery_single_send_config｜投放内容必选deliverysinglesendconfig

【描述】通用推广内容配置。

delivery_content_info｜投放内容必选deliverycontentinfo

【描述】推广展位的推广内容。

delivery_content_type｜运营内容类型必选string[1,16]

【描述】运营内容类型。

【枚举值】

活动枚举类型: activity

小程序枚举类型: mini_app

【示例值】activity

delivery_activity_content｜活动内容信息必选deliveryactivitycontentinfo

【描述】活动对象

activity_id｜活动id可选string[1,128]

【描述】活动id。目前支持商家支付券、商家券、。
注意：折扣力度-商家支付券、商家券类型，单品券大于等于 9 折，全场券大于等于 95 折；商家兑换券类型，需大于等于8折。

【注意事项】说明：通过 alipay.marketing.activity.voucher.create 创建的支付券活动。通过alipay.marketing.activity.ordervoucher.create 创建的导码模式的商家券活动。

【示例值】20122131234434557567

delivery_content_config｜推广内容配置可选deliverycontentconfig

【描述】推广内容配置

delivery_send_guide｜投放引导信息可选deliverysendguide

【描述】推广引导信息

delivery_guide_url｜链接必选string[1,256]

【描述】用户领券链接。
注意:
领券链接必须为创建推广对应商家账号下的小程序url，且必须符合小程序scheme链接规范：https://opendocs.alipay.com/support/01rb18

【示例值】alipays://platformapi/startapp?appid=xxxx

merchant_access_mode｜商户接入模式必选string[1,32]

【描述】商户接入模式

【枚举值】

商户自接入模式: self_mode

服务商代接入模式: agency_mode

【注意事项】选择服务商代接入模式需配合 app_auth_token 代调用使用

【示例值】self_mode

delivery_target_rule｜投放计划定向规则可选deliverytargetrule

【描述】推广计划定向规则。

delivery_city_code_rule｜推广城市规则可选deliverycitycoderule

【描述】推广城市规则。

以下参数二选一传入必选

city_codes｜城市编码array[1,8400]

【描述】城市编码。与all_city二选一。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。（参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）

【注意事项】若all_city，city_codes都填写，优先使用all_city

【示例值】["100100"]

all_city｜是否全国boolean

【描述】是否全国。与city_codes二选一。只允许填true，否则不填。

【注意事项】若all_city，city_codes都填写，优先使用all_city

【示例值】true

参数	类型	是否必选	长度/取值	描述	示例值
delivery_booth_code	string	必选	长度范围：[1,32]	推广的展位编码。 public_union：日常推广。	public_union
out_biz_no	string	必选	长度范围：[1,64]	外部业务单号，用作幂等控制。幂等作用：请求返回与上一次相同的结果。外部接入方需保证业务单号唯一。	20170101000001654bb46ba
delivery_base_info	deliverybaseinfo	必选	-	推广计划基础信息。
delivery_play_config	deliveryplayconfig	必选	-	推广计划发放配置。
delivery_target_rule	deliverytargetrule	可选	-	推广计划定向规则。
merchant_access_mode	string	必选	长度范围：[1,32]	商户接入模式枚举值商户自接入模式: self_mode 服务商代接入模式: agency_mode 注意事项选择服务商代接入模式需配合 app_auth_token 代调用使用	self_mode

常见请求示例

默认示例

curljavac#php

curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.activity.delivery.create&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={
	"delivery_base_info":{
		"delivery_material":{
			"delivery_single_material":{
				"delivery_image":"a*wxytaswgww"
			}
		},
		"delivery_end_time":"2017-01-01 00:00:01",
		"delivery_name":"第十期投放计划",
		"delivery_begin_time":"2017-01-01 00:00:01"
	},
	"delivery_play_config":{
		"delivery_single_send_config":{
			"delivery_content_config":{
				"delivery_send_guide":{
					"delivery_guide_url":"alipays://platformapi/startapp?appid=xxxx"
				}
			},
			"delivery_content_info":{
				"delivery_content_type":"activity",
				"delivery_activity_content":{
					"activity_id":"20122131234434557567"
				}
			}
		}
	},
	"out_biz_no":"20170101000001654bb46ba",
	"delivery_booth_code":"public_union",
	"delivery_target_rule":{
		"delivery_city_code_rule":{
			"city_codes":[
				"100100"
			],
			"all_city":true
		}
	},
	"merchant_access_mode":"self_mode"
}'

说明：本示例仅供参考。

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
code	string	必选	-	网关返回码,	40004
msg	string	必选	-	网关返回码描述,	business failed
sub_code	string	可选	-	业务返回码，参见具体的api接口文档	acq.trade_has_success
sub_msg	string	可选	-	业务返回码描述，参见具体的api接口文档	交易已被支付
sign	string	必选	-	签名,	dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

delivery_id｜投放计划id必选string(128)

【描述】推广计划id。

【示例值】20121231231242353

delivery_guide_preview_url｜预览链接可选string(1200)

【描述】预览链接。
可用于预览用户在承接页面领券的流程。

【示例值】alipays://platformapi/startapp?appid=xxxx

参数	类型	是否必选	最大长度	描述	示例值
delivery_id	string	必选	128	推广计划id。	20121231231242353
delivery_guide_preview_url	string	可选	1200	预览链接。可用于预览用户在承接页面领券的流程。	alipays://platformapi/startapp?appid=xxxx

响应示例

正常示例

异常示例

{
    "alipay_marketing_activity_delivery_create_response": {
        "code": "10000",
        "msg": "success",
        "delivery_id": "20121231231242353",
        "delivery_guide_preview_url": "alipays://platformapi/startapp?appid=xxxx"
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}