事件上報介面規範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

{
  "comeFrom": "quick_tracking",
  "customerId": "60f40382e6fe630ce7383e0727fa0370cpd",
  "customerIdList": [
    {
      "customerId": "6fc1e5a35b7431dfb32b6f6f98700463c58d30e62af177a45bbbb",
      "idMapping": "oaid"
    },
    {
      "customerId": "60f40382e6fe630ce7383e0727fa0370cpd",
      "idMapping": "EID"
    },
    {
      "customerId": "9282ba6da36342498bff83c1da4dacc5",
      "idMapping": "QT_USERID"
    }
  ],
  "eventChannel": "oc77g0hwtybz8rbzgvkfza94",
  "eventCode": "page_home"
}

@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
     */
    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;
    }
}

entityId擷取方式：組態管理-實體管理介面，開啟控制台可查看query?_=xxxx介面查看entityCode

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對應的編輯按鈕進行查看。