事件上报接口规范3.0_智能用户增长(Quick Audience)-阿里云帮助中心

Quick Audience 于2024年4月更新事件上报的接口3.0，接口3.0包括接口2.0中的内容外，另外支持多实体事件，且可以灵活授权分配给调用APP。

该接口依托于Quick Audience开放平台API。在使用前，请按照本文档的指引完成Quick Audience开放平台接口的调试。详细操作步骤和要求，请参考Quick Audience开放平台API。

说明

当前仅提供Java语言的SDK。

事件数据上报接口

接口描述	事件实时同步
URL	/openapi/cloud/event/detail/receive
请求方式	post
参数名	数据类型	参数类型	是否必填	说明
1.accessId	string	body form-data	是	组织ID/租户ID，示例值：8f3554ba-a242-4436-8354-90672bfc76ea。
2.eventMessageModelListJson	string		是	详细见下面的事件模型ClientEventMessageModel。
状态码			说明
200			接口请求成功
其他			请求失败
返回属性名	类型		说明
1.traceId	string		请求的唯一ID，用于定位链路上的问题。
2.success	boolean		服务器处理是否成功。
3.errorCode	string		错误码。
4.errorDesc	string		错误描述。
5.data	string		true/false
示例
请求参数	`curl --location --request POST 'http://endpoint/openapi/cloud/event/detail/receive?appId=673198870988276864&timestamp=1708235644862&accessKey=ec22d92d8dd142b8b39b23b39bc8b39c' \ --header 'Authorization: 27316d96901ab5a901ef7dbc0a8a38a5' \ --form 'eventMessageModelListJson="[]"' \ --form 'accessId="480002d3-bdc8-4244-9e20-c2d04c711583"'`
返回值	{ "data": true, "errorCode": null, "errorDesc": null, "success": true, "traceId": "ff0f996e-6c63-412d-a4cd-acf5d00775cd" }

事件模型ClientEventMessageModel

@Data
public class ClientEventMessageModel {

    /**
     * 组织ID，必填
     */
    String organizationId;

    /**
     * 空间ID，选填
     */
    String workspaceId;

    /**
     * 用户在您自有体系中的用户ID，必填
     */
    String customerId;

    /**
     * 实体ID，选填，默认为人实体
   */
    String entityId;

    /**
     * 事件编码，必填
     */
    String eventCode;

    /**
     * 事件发生时间，必填
     */
    Long eventTime;

    /**
     * 事件属性，是否必填取决于事件定义中对属性的设置
     */
    Map<String, String> extendAttributes = new HashMap<>();

    /**
     * Quick Audience空间支持的用户ID，若之前同一个customerId上报过customerIdList，则选填
     */
    List<CustomerIdModel> customerIdList = new ArrayList<>();

    /**
     * 是否是交易数据，0 (不是) / 1 (是)
     */
    String isOrder;
}

@Data
public class CustomerIdModel {
    String customerId;
    String idMapping;
    public CustomerIdModel() {
    }
    public CustomerIdModel(String customerId, String idMapping) {
        this.customerId = customerId;
        this.idMapping = idMapping;
    }
}

CustomerIdModel：

public class CustomerIdModel {
    @ApiModelProperty(required = true, value = "实际用户ID，如手机号类型的139****0000")
    String customerId;
    @ApiModelProperty(required = true, value = "用户ID类型，如手机号，请参见下面的用户ID类型说明")
    String idMapping;
}

用户ID类型说明：

Quick Audience空间支持的用户ID类型包括本空间的ID类型管理页面中所有已启用状态的ID类型，请在代码中使用ID类型编码作为ID类型的名称。

系统预置ID的ID类型编码，请查阅系统预置ID列表。
自定义ID的ID类型编码，请单击ID对应的编辑按钮进行查看。