事件管理

安装Java SDK

1. 安装阿里云Java核心库，请参见安装Alibaba Cloud SDK for Java。

   说明

   SDK使用说明，请参见Java示例。

2. 安装QuickAudience Java SDK。打开Aliyun Java SDK QuickAudience Public，下载并安装QuickAudience Java SDK。

3. 在项目目录下的pom.xml文件中，添加Maven依赖。添加依赖后，Maven项目管理工具会自动下载相关JAR包。

   <!--引入阿里云Core 包-->
   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>aliyun-java-sdk-core</artifactId>
     <version>4.5.2</version>
   </dependency>
   
   <!--引入QuickAudience 阿里云SDK-->
   <!-- https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-retailadvqa-public -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>aliyun-java-sdk-retailadvqa-public</artifactId>
       <version>3.3.16</version>
   </dependency>

接口通用入参

• accessId：请使用购买QA的主账号进入订单列表，单击QA（智能用户增长）订单对应的详情，进入订单详情页面获取实例名称。

• organizationId：请通过浏览器的开发者工具，在登录QA时获取,，如下图所示。

OpenAPI Endpoint列表

接口入参

接口出参

接入Demo

import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.retailadvqa_public.model.v20200515.RecieveEventMessageRequest;
import com.aliyuncs.retailadvqa_public.model.v20200515.RecieveEventMessageResponse;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * 上报事件消息
*/
public class RecieveEventMessage {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey 和 AccessKeySecret 保存在环境变量为例说明。
    // 保存环境变量的方法参考如下：
    // Linux和macOS系统配置方法
    // 执行以下命令：
    // export SCA_AK_ENV=<access_key_id>
    // export SCA_SK_ENV=<access_key_secret>
    // <access_key_id>替换为已准备好的AccessKey ID，<access_key_secret>替换为AccessKey Secret。
    static String accessKey = System.getenv("SCA_AK_ENV");
    static String accessSecret = System.getenv("SCA_SK_ENV");
    static String regionId = "cn-shanghai";
    static String product = "retailadvqa-public";
    static String endpointUrl = "quicka-public.cn-shanghai.aliyuncs.com";

    static IAcsClient client = null;
    static {
        DefaultProfile profile =
                DefaultProfile.getProfile(
                        regionId,          // 地域ID
                        accessKey,         // RAM账号的AccessKeyID
                        accessSecret       // RAM账号AccessKeySecret
                );
        try {
            DefaultProfile.addEndpoint(
                    regionId,
                    product,
                    endpointUrl
            );
        } catch (Exception e) { }
        client= new DefaultAcsClient(profile);
    }

    public static void recieveEventMessage() throws ClientException {
        RecieveEventMessageRequest eventMessageRequest = new RecieveEventMessageRequest();
        eventMessageRequest.setAccessId("retailadvqa-xx-xxxxxxxxx");
        eventMessageRequest.setOrganizationId("56621289-820e-433a-9947-xxxxxxxxx");


        EventMessageModel messageModel = new EventMessageModel();
        messageModel.setOrganizationId(eventMessageRequest.getOrganizationId());
        messageModel.setCustomerId("customer001");
        messageModel.setEventSourceCode("eventsource001");
        messageModel.setEventCode("event001");
        messageModel.setEventTime(System.currentTimeMillis());
        Map<String, String> extendAttributes = new HashMap<>();
        extendAttributes.put("key1", "value1");
        extendAttributes.put("key2", "123456");
        messageModel.setExtendAttributes(extendAttributes);

        // 批量上报接口，批量限制100。
        eventMessageRequest.setEventMessageModelListStr(JSONObject.toJSONString(Arrays.asList(messageModel)));
        System.out.println(JSONObject.toJSONString(Arrays.asList(messageModel)));

        RecieveEventMessageResponse recieveEventMessageResponse = client.getAcsResponse(eventMessageRequest);
        System.out.println("result = " + JSONObject.toJSONString(recieveEventMessageResponse));
    }

    public static void main(String... args) throws ClientException {
        recieveEventMessage();
    }

    @Data
    public static class EventMessageModel {

        @ApiModelProperty("组织Id")
        String organizationId;

        @ApiModelProperty(required = true, value = "用户/粉丝Id")
        String customerId;

        @ApiModelProperty("app_key。如果事件消息中没有app_key，自动化营销任务计算将不受渠道限制")
        String eventSourceCode;

        @ApiModelProperty(required = true, value = "事件编码")
        String eventCode;

        @ApiModelProperty(required = true, value = "事件实际发生的时间")
        Long eventTime;

        @ApiModelProperty("事件扩展属性ID和对应的值")
        Map<String, String> extendAttributes = new HashMap<>();

        @ApiModelProperty("事件消息模型版本号")
        Integer v = 1;
    }
}

接口入参

接口出参

接入Demo

import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.retailadvqa_public.model.v20200515.RecieveUserMessageRequest;
import com.aliyuncs.retailadvqa_public.model.v20200515.RecieveUserMessageResponse;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.util.Arrays;
import java.util.List;

/**
 * 上报用户身份标识
 */
public class RecieveCustomerMessage {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey 和 AccessKeySecret 保存在环境变量为例说明。
    // 保存环境变量的方法参考如下：
    // Linux和macOS系统配置方法
    // 执行以下命令：
    // export SCA_AK_ENV=<access_key_id>
    // export SCA_SK_ENV=<access_key_secret>
    // <access_key_id>替换为已准备好的AccessKey ID，<access_key_secret>替换为AccessKey Secret。
    static String accessKey = System.getenv("SCA_AK_ENV");
    static String accessSecret = System.getenv("SCA_SK_ENV");
    static String regionId = "cn-shanghai";
    static String product = "retailadvqa-public";
    static String endpointUrl = "quicka-public.cn-shanghai.aliyuncs.com";

    static IAcsClient client = null;
    static {
        DefaultProfile profile =
                DefaultProfile.getProfile(
                        regionId,          // 地域ID
                        accessKey,         // RAM账号的AccessKeyID
                        accessSecret       // RAM账号AccessKeySecret
                );
        try {
            DefaultProfile.addEndpoint(
                    regionId,
                    product,
                    endpointUrl
            );
        } catch (Exception e) { }
        client= new DefaultAcsClient(profile);
    }

    public static void recieveCustomerMessage() throws ClientException {
        RecieveUserMessageRequest recieveUserMessageRequest = new RecieveUserMessageRequest();
        recieveUserMessageRequest.setAccessId("retailadvqa-xx-xxxxxxxxx");
        recieveUserMessageRequest.setOrganizationId("56621289-820e-433a-9947-xxxxxxxxx");
        CustomerMessageModel customerMessageModel = new CustomerMessageModel();
        customerMessageModel.setOrganizationId(recieveUserMessageRequest.getOrganizationId());
        customerMessageModel.setCustomerId("customer001");
        CustomerIdModel idModel = new CustomerIdModel();
        idModel.setCustomerId("13888888888");
        idModel.setIdMapping("mobile");
        customerMessageModel.setCustomerIdList(Arrays.asList(idModel));

        // 消息上报，批量限制100。
        recieveUserMessageRequest.setCustomerMessageModelListStr(JSONObject.toJSONString(Arrays.asList(customerMessageModel)));
        System.out.println(JSONObject.toJSONString(Arrays.asList(customerMessageModel)));
        RecieveUserMessageResponse recieveUserMessageResponse = client.getAcsResponse(recieveUserMessageRequest);
        System.out.println("result = " + JSONObject.toJSONString(recieveUserMessageResponse));
    }

    public static void main(String... args) throws ClientException {
        recieveCustomerMessage();
    }

    @Data
    public static class CustomerMessageModel {

        @ApiModelProperty("组织Id")
        String organizationId;

        @ApiModelProperty(required = true, value = "用户/粉丝Id")
        String customerId;

        @ApiModelProperty(required = true, value = "用户身份标识ID信息：如 idfa、imei、mobile")
        List<CustomerIdModel> customerIdList;


        @ApiModelProperty("用户身份标识消息模型版本号")
        Integer v = 1;
    }

    @Data
    public static class CustomerIdModel {

        @ApiModelProperty(required = true, value = "用户/粉丝Id")
        String customerId;

        /**
         目前支持如下用户ID类型：
         1）oneid：客户自定义ID类型，不映射数据银行的类型
         2）email：电子邮件
         3）mobile：手机号
         4）taobao_id：淘宝ID
         5）taobao_nick：淘宝昵称
         6）imei：手机IMEI
         7）idfa：手机IDFA
         8）mac_org：设备MAC地址
         9）weibo_id_org：微博ID
         10）alipay_id：支付宝ID
         11）open_id：微信OpenID
         12) union_id：微信UnionID
         */
        @ApiModelProperty(required = true, value = "用户Id类型")
        String idMapping;
    }
}