Quick Audience:イベントレポート API 仕様 3.0

この操作は、Quick Audience オープン プラットフォーム API に基づいています。使用する前に、このドキュメントの指示に従って Quick Audience オープン プラットフォーム API のデバッグを完了してください。手順と要件の詳細については、「Quick Audience オープン プラットフォーム API」をご参照ください。

イベントデータレポート インターフェイス

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"'

イベントモデル 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 が以前に報告されている場合、このパラメーターはオプションです。
    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 の取得方法：構成管理 - エンティティ管理 API コンソールを開いて entityCode を表示するクエリ ?_=xxxx API を表示します

CustomerIdModel:

public class CustomerIdModel {
    // 実際のユーザー ID （例：139****0000）
    @ ApiModelProperty(required = true, value = "Actual user ID, such as 139****0000")
    String customerId;
    // ユーザー ID タイプ（例：携帯電話番号、ユーザー ID タイプの以下の説明を参照）
    @ ApiModelProperty(required = true, value = "User ID type, such as mobile phone number, see the following description of user ID type")
    String idMapping;
}

ユーザー ID タイプの説明：

Quick Audience は、ワークスペースの ID タイプ管理 ページで有効になっているすべてのユーザー ID タイプをサポートしています。コードでは、ID タイプコードを ID タイプ名として使用する必要があります。

• プリセット システム ID の ID タイプコード。詳細については、「プリセット システム ID リスト」をご参照ください。

• 次に、エンドポイントのリクエストを処理するコールバック関数を定義します。この関数は、リクエストデータを含む WP_REST_Request オブジェクトを受け取り、レスポンスデータを返す必要があります。