开发接入
接入代运营授权
app_auth_token）方式进行接入。operate_type（操作类型）参数需传入OPERATION_AUTH（授权操作）类型。接入引流转化
接口调用时序图
推广计划状态流转图
第一步：上传图片资料
PUBLIC_UNION_CHANNEL_PIC。请求示例
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayMarketingMaterialImageApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayMarketingMaterialImageApiUpload {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数（全局设置一次）
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayMarketingMaterialImageApi api = new AlipayMarketingMaterialImageApi();
AlipayMarketingMaterialImageUploadModel data = new AlipayMarketingMaterialImageUploadModel();
BelongMerchantInfo belongMerchantInfo = new BelongMerchantInfo();
belongMerchantInfo.setMerchantIdType("SMID");
belongMerchantInfo.setMerchantId("2088202967380463");
belongMerchantInfo.setBusinessType("ISV_FOR_MERCHANT");
data.setBelongMerchantInfo(belongMerchantInfo);
data.setFileKey("PROMO_VOUCHER_IMAGE");
data.setMerchantAccessMode("SELF_MODE");
File fileContent = new File("文件路径");
try {
AlipayMarketingMaterialImageUploadResponseModel response = api.upload(data, fileContent);
} catch (ApiException e) {
AlipayMarketingMaterialImageUploadDefaultResponse errorObject = (AlipayMarketingMaterialImageUploadDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}第二步：创建推广计划
商家/服务商调用 delivery_guide_url（用户领券链接）来控制用户在支付宝领券时，跳转到商家小程序的页面。delivery_guide_url 必须为创建推广对应商家账号下的小程序 URL，且必须符合小程序scheme链接规范。
商家支付宝做推广时，支持两种推广方式：
注意：配置附近发券模式优惠券上必须配置门店。
delivery_id（推广计划 id）查询确认。请求示例
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayMarketingActivityDeliveryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayMarketingActivityDeliveryApiCreate {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数（全局设置一次）
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayMarketingActivityDeliveryApi api = new AlipayMarketingActivityDeliveryApi();
AlipayMarketingActivityDeliveryCreateModel data = new AlipayMarketingActivityDeliveryCreateModel();
data.setDeliveryBoothCode("PUBLIC_UNION");
data.setOutBizNo("20170101000001654bb46ba");
DeliveryPlayConfig deliveryPlayConfig = new DeliveryPlayConfig();
DeliverySingleSendConfig deliverySingleSendConfig = new DeliverySingleSendConfig();
DeliveryContentConfig deliveryContentConfig = new DeliveryContentConfig();
DeliverySendGuide deliverySendGuide = new DeliverySendGuide();
deliverySendGuide.setDeliveryGuideUrl("alipays://platformapi/startapp?appId=xxxx");
deliveryContentConfig.setDeliverySendGuide(deliverySendGuide);
deliverySingleSendConfig.setDeliveryContentConfig(deliveryContentConfig);
DeliveryContentInfo deliveryContentInfo = new DeliveryContentInfo();
DeliveryActivityContentInfo deliveryActivityContent = new DeliveryActivityContentInfo();
deliveryActivityContent.setActivityId("20122131234434557567");
deliveryContentInfo.setDeliveryActivityContent(deliveryActivityContent);
deliveryContentInfo.setDeliveryContentType("ACTIVITY");
deliverySingleSendConfig.setDeliveryContentInfo(deliveryContentInfo);
deliveryPlayConfig.setDeliverySingleSendConfig(deliverySingleSendConfig);
data.setDeliveryPlayConfig(deliveryPlayConfig);
DeliveryBaseInfo deliveryBaseInfo = new DeliveryBaseInfo();
DeliveryMaterial deliveryMaterial = new DeliveryMaterial();
DeliverySingleMaterial deliverySingleMaterial = new DeliverySingleMaterial();
deliverySingleMaterial.setDeliveryImage("A*WXYTAswgww");
deliveryMaterial.setDeliverySingleMaterial(deliverySingleMaterial);
deliveryBaseInfo.setDeliveryMaterial(deliveryMaterial);
deliveryBaseInfo.setDeliveryName("第十期投放计划");
deliveryBaseInfo.setDeliveryBeginTime("2017-01-01 00:00:01");
deliveryBaseInfo.setDeliveryEndTime("2017-01-01 00:00:01");
data.setDeliveryBaseInfo(deliveryBaseInfo);
DeliveryTargetRule deliveryTargetRule = new DeliveryTargetRule();
DeliveryCityCodeRule deliveryCityCodeRule = new DeliveryCityCodeRule();
deliveryCityCodeRule.setAllCity(true);
List<String> cityCodes = new ArrayList<String>();
cityCodes.add("100100");
deliveryCityCodeRule.setCityCodes(cityCodes);
deliveryTargetRule.setDeliveryCityCodeRule(deliveryCityCodeRule);
data.setDeliveryTargetRule(deliveryTargetRule);
data.setMerchantAccessMode("SELF_MODE");
try {
AlipayMarketingActivityDeliveryCreateResponseModel response = api.create(data);
} catch (ApiException e) {
AlipayMarketingActivityDeliveryCreateDefaultResponse errorObject = (AlipayMarketingActivityDeliveryCreateDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}第三步：查询推广计划
请求示例
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayMarketingActivityDeliveryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayMarketingActivityDeliveryApiQuery {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数（全局设置一次）
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayMarketingActivityDeliveryApi api = new AlipayMarketingActivityDeliveryApi();
String deliveryId = "20121231231242353";
AlipayMarketingActivityDeliveryQueryModel data = new AlipayMarketingActivityDeliveryQueryModel();
data.setMerchantAccessMode("AGENCY_MODE");
try {
AlipayMarketingActivityDeliveryQueryResponseModel response = api.query(deliveryId, data);
} catch (ApiException e) {
AlipayMarketingActivityDeliveryQueryDefaultResponse errorObject = (AlipayMarketingActivityDeliveryQueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}第四步：停止推广计划
请求示例
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayMarketingActivityDeliveryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayMarketingActivityDeliveryApiStop {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数（全局设置一次）
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayMarketingActivityDeliveryApi api = new AlipayMarketingActivityDeliveryApi();
String deliveryId = "20121231231242353";
AlipayMarketingActivityDeliveryStopModel data = new AlipayMarketingActivityDeliveryStopModel();
data.setOutBizNo("20170101000001654bb46ba");
data.setMerchantAccessMode("SELF_MODE");
try {
AlipayMarketingActivityDeliveryStopResponseModel response = api.stop(deliveryId, data);
} catch (ApiException e) {
AlipayMarketingActivityDeliveryStopDefaultResponse errorObject = (AlipayMarketingActivityDeliveryStopDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}消息通知
第一步：订阅消息
第二步：验签
第三步：反馈消息接收结果
success表示消息获取成功，支付宝就会停止发送异步通知。如果返回fail或其它值，表示消息获取失败，支付宝会根据投递重试策略重新发送消息到应用网关地址。success，验签失败返回fail，重新接收异步进行处理。| 响应值 | 描述 | 是否重试 |
|---|---|---|
| fail | 消息获取失败 | 重试 |
| success | 消息获取成功 | 不重试 |
变更推广状态通知
消息示例
ISV_GATEWAY_URL?charset=GBK&biz_content=
{
"out_biz_no":"abscd123341",
"event_time":"12342425435232423",
"delivery_id":"20121231231242353",
"delivery_status":"ACTIVE",
"delivery_error_msg":"素材不合格",
"delivery_booth_code":"PAYMENT_RESULT"
&msg_method=alipay.marketing.activity.delivery.changed&utc_timestamp=1516797622752&version=1.1&sign_type=RSA2¬ify_id=d275fec564e62af6bedbcee73f3f05fi5x&app_id=2013121700999429&sign=I+Y/lvqYUEEc10EPdpntRhFIQ==