Event Management (Old Version 1.0)

Install Cloud Phone SDK for Java

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

   Note

   For more information about how to use the SDK, see Java Example.

2. Install the QuickAudience Java SDK. Open the Aliyun Java SDK QuickAudience Public, download and install the QuickAudience Java SDK.

3. Add Maven dependencies to the pom.xml file in the project directory. After the dependencies are added, Maven automatically downloads the relevant JAR packages.

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

Common input parameters of an API

• accessId: Enter the ID of your primary Alibaba Cloud account to go to the Order List page. Find the Quick Audience order and click Details in the Actions column.

• organizationId: You can obtain the value when you log on to QA by using the developer tool of your browser, as shown in the following figure.

OpenAPI Endpoint List

Interface input parameters

API output parameters

Access 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 {
    // The AccessKey pair of an Alibaba Cloud account has permissions to call all API operations. We recommend that you use the AccessKey pair of a RAM user to call API operations or perform routine O&M. 
    // We recommend that you do not include your AccessKey pair (AccessKey ID and AccessKey secret) in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources within your account may be compromised. 
    // In this example, the AccessKey pair and AccessKeySecret are stored in environment variables. 
    // The method for saving environment variables is as follows:
    // Configure the Linux and macOS systems.
    // Run the following command:
    // export SCA_AK_ENV=<access_key_id>
    // export SCA_SK_ENV=<access_key_secret>
    // Replace <access_key_id> with the AccessKey ID and <access_key_secret> with the 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, // The region ID.
                        accessKey, // The AccessKey ID of the RAM user.
                        accessSecret // The AccessKeySecret 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);

        // The batch reporting operation. The batch reporting operation 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("app_key. If there is no app_key in the event message, the automatic marketing task calculation will not be limited by the channel ")
        String eventSourceCode;

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

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

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

        @ ApiModelProperty("Event message model version number")
        Integer v = 1;
    }
}

API input parameters

Output parameters

Access 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 the user identity.
 */
public class RecieveCustomerMessage {
    // The AccessKey pair of an Alibaba Cloud account has permissions to call all API operations. We recommend that you use the AccessKey pair of a RAM user to call API operations or perform routine O&M. 
    // We recommend that you do not include your AccessKey pair (AccessKey ID and AccessKey secret) in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources within your account may be compromised. 
    // In this example, the AccessKey pair and AccessKeySecret are stored in environment variables. 
    // The method for saving environment variables is as follows:
    // Configure the Linux and macOS systems.
    // Run the following command:
    // export SCA_AK_ENV=<access_key_id>
    // export SCA_SK_ENV=<access_key_secret>
    // Replace <access_key_id> with the AccessKey ID and <access_key_secret> with the 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, // The region ID.
                        accessKey, // The AccessKey ID of the RAM user.
                        accessSecret // The AccessKeySecret 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));

        // The number of messages to be reported 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 ID information: such as idfa, imei, mobile")
        List<CustomerIdModel> customerIdList;


        @ ApiModelProperty("User identity message model version number")
        Integer v = 1;
    }

    @Data
    public static class CustomerIdModel {

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

        /**
         Currently, the following user ID types are supported:
         1)oneid
         2)email: E-mail
         3)mobile: mobile phone number
         4)taobao_id: Taobao ID
         5)taobao_nick: Taobao nickname
         6)imei: mobile phone IMEI
         7)idfa: mobile IDFA
         8)mac_org:MAC address
         9)weibo_id_org: Weibo ID
         10)alipay_id: the ID of Alipay.
         11)open_id: WeChat OpenID
         12) union_id: WeChat UnionID
         */
        @ ApiModelProperty(required = true, value = "User Id type")
        String idMapping;
    }
}