Event Management

Install the Java SDK

1. Install the Alibaba Cloud SDK for Java core library. For more information, see Install Alibaba Cloud SDK for Java.

   Note

   For instructions on how to use the SDK, see Java examples.

2. Install the Quick Audience Java SDK. Open Aliyun Java SDK QuickAudience Public to download and install the Quick Audience Java SDK.

3. In the pom.xml file in your project directory, add the Maven dependency. After you add the dependency, the Maven project management tool automatically downloads the relevant JAR packages.

   <!--Import the Alibaba Cloud Core package-->
   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>aliyun-java-sdk-core</artifactId>
     <version>4.5.2</version>
   </dependency>
   
   <!--Import the Quick Audience Alibaba Cloud 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>

Common request parameters

• accessId: Use the Alibaba Cloud account that you used to purchase Quick Audience to go to the Orders page. Click Details for the Quick Audience order to go to the order details page and obtain the instance name.

• organizationId: Use your browser's developer tools to obtain the organization ID when you log on to Quick Audience, as shown in the following figure.

OpenAPI Endpoint list

Request parameters

Response parameters

Integrating the 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;

/**
 * Report event messages
*/
public class RecieveEventMessage {
    // An AccessKey of an Alibaba Cloud account has full permissions on all APIs. We recommend that you use a RAM user to make API calls or perform O&M.
    // We strongly recommend that you do not save your AccessKey ID and AccessKey secret in your project code. This can lead to an AccessKey leak and threaten the security of all resources in your account.
    // This example shows how to save the AccessKey ID and AccessKey secret in environment variables.
    // To save the environment variables, follow these steps:
    // For Linux and macOS systems
    // Run the following commands:
    // export SCA_AK_ENV=<access_key_id>
    // export SCA_SK_ENV=<access_key_secret>
    // Replace <access_key_id> with your AccessKey ID and <access_key_secret> with your 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,          // Region ID
                        accessKey,         // AccessKey ID of the RAM user
                        accessSecret       // AccessKey secret of the RAM user
                );
        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);

        // This is a batch reporting API. The batch size limit is 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("Organization ID")
        String organizationId;

        @ApiModelProperty(required = true, value = "User/Fan ID")
        String customerId;

        @ApiModelProperty("The app_key. If the event message does not contain an app_key, the automated marketing task calculation is not restricted by the channel.")
        String eventSourceCode;

        @ApiModelProperty(required = true, value = "Event code")
        String eventCode;

        @ApiModelProperty(required = true, value = "The actual time the event occurred")
        Long eventTime;

        @ApiModelProperty("The event extension property ID and its value")
        Map<String, String> extendAttributes = new HashMap<>();

        @ApiModelProperty("The version number of the event message model")
        Integer v = 1;
    }
}

Request parameters

Response parameters

Integration 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;

/**
 * Report user identities
 */
public class RecieveCustomerMessage {
    // An AccessKey of an Alibaba Cloud account has full permissions on all APIs. We recommend that you use a RAM user to make API calls or perform O&M.
    // We strongly recommend that you do not save your AccessKey ID and AccessKey secret in your project code. This can lead to an AccessKey leak and threaten the security of all resources in your account.
    // This example shows how to save the AccessKey ID and AccessKey secret in environment variables.
    // To save the environment variables, follow these steps:
    // For Linux and macOS systems
    // Run the following commands:
    // export SCA_AK_ENV=<access_key_id>
    // export SCA_SK_ENV=<access_key_secret>
    // Replace <access_key_id> with your AccessKey ID and <access_key_secret> with your 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,          // Region ID
                        accessKey,         // AccessKey ID of the RAM user
                        accessSecret       // AccessKey secret of the RAM user
                );
        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));

        // This is a message reporting API. The batch size limit is 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("Organization ID")
        String organizationId;

        @ApiModelProperty(required = true, value = "User/Fan ID")
        String customerId;

        @ApiModelProperty(required = true, value = "User identity ID information, such as IDFA, IMEI, or mobile")
        List<CustomerIdModel> customerIdList;


        @ApiModelProperty("The version number of the user identity message model")
        Integer v = 1;
    }

    @Data
    public static class CustomerIdModel {

        @ApiModelProperty(required = true, value = "User/Fan ID")
        String customerId;

        /**
         The following user ID types are currently supported:
         1) oneid: A custom ID type that does not map to Data Bank types.
         2) email: Email address
         3) mobile: Mobile phone number
         4) taobao_id: Taobao ID
         5) taobao_nick: Taobao nickname
         6) imei: Mobile phone IMEI
         7) idfa: Mobile phone IDFA
         8) mac_org: Device MAC address
         9) weibo_id_org: Weibo ID
         10) alipay_id: Alipay ID
         11) open_id: WeChat OpenID
         12) union_id: WeChat UnionID
         */
        @ApiModelProperty(required = true, value = "User ID type")
        String idMapping;
    }
}