イベントレポート
ユーザー行動イベントは、いつ、どの環境で、どのような行動をユーザーが行い、それをどのように行い、なぜ行ったのかといった重要な情報を記録するために使用されます。
ユーザーイベントの報告は、EUIDに基づいて作成する必要があります。
呼び出しアドレス
POST /v1/event/report
呼び出し認証
EngageLab REST APIはHTTP基本認証の認証方法を使用します。HTTPヘッダーにAuthorizationを追加してください:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
このコードブロックはフローティングウィンドウ内に表示されます
上記のbase64_auth_stringの生成アルゴリズムは次の通りです:base64(api_key:api_secret)
- ヘッダー名は「Authorization」で、値はコロンで区切られた「username:password」ペアをbase64変換したものです。
- MA APIのシナリオでは、usernameはAPIKey、passwordはAPISecretです。データソースにAPIタイプのデータソースを追加して、APIKeyとAPISecretを取得してください。
リクエスト例
リクエストヘッダー
> POST /v1/event/report
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/event/report
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
このコードブロックはフローティングウィンドウ内に表示されます
リクエストボディ
{
"app_key": "96441e4d73207a6517abfbbc",// アプリケーションのAppKey、任意
"data": [
{
"euid": 10000091198, // 行動イベントのEUID
"event_name": "sign_up", // イベント名、プロジェクト内でイベントを一意に識別する情報
"itime": 1654076420772, // イベントが発生した具体的なタイムスタンプ
"random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e", // イベント報告ID。任意
"properties": {
"propertyA": "a", // イベントプロパティのフィールド名:プロパティ値
"propertyB": 2
}
},
{
"euid": 10000091199,
"event_name": "login",
"itime": 1654076420235,
"properties": {
"propertyC": "a",
"propertyD": 3,
"propertyJ": "true",
"propertyK": 169,
"propertyL": [
"test1",
"20231025"
]
}
}
]
}
{
"app_key": "96441e4d73207a6517abfbbc",// アプリケーションのAppKey、任意
"data": [
{
"euid": 10000091198, // 行動イベントのEUID
"event_name": "sign_up", // イベント名、プロジェクト内でイベントを一意に識別する情報
"itime": 1654076420772, // イベントが発生した具体的なタイムスタンプ
"random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e", // イベント報告ID。任意
"properties": {
"propertyA": "a", // イベントプロパティのフィールド名:プロパティ値
"propertyB": 2
}
},
{
"euid": 10000091199,
"event_name": "login",
"itime": 1654076420235,
"properties": {
"propertyC": "a",
"propertyD": 3,
"propertyJ": "true",
"propertyK": 169,
"propertyL": [
"test1",
"20231025"
]
}
}
]
}
このコードブロックはフローティングウィンドウ内に表示されます
リクエストパラメータ
フィールド | 型 | 必須 | 説明 |
---|---|---|---|
app_key | String | No | アプリまたはWebアプリケーションのAppKey値。イベントを生成したアプリケーションを示すために使用されます。 |
data | Array | Yes | 行動イベントのリスト |
euid | Long | Yes | 行動イベントを実行したユーザーの一意のユーザーID |
event_name | String | Yes | イベント名 |
itime | Long | Yes | 行動イベントが発生した具体的なタイムスタンプ。13桁のミリ秒単位のタイムスタンプが必要です。 |
random_id | String | No | イベント報告ID。イベントの一意性を確認するために使用されます。このフィールドが入力されていない場合、EngageLabが自動的に生成します。 |
properties | JSON Object | No | イベントプロパティ。キーがプロパティ名、値がプロパティ値です。 キーの合法性要件:小文字の文字、数字、アンダースコアをサポートし、文字で始まる必要があります |
レスポンスパラメータ
フィールド | 型 | 必須 | 説明 |
---|---|---|---|
code | Int | Yes | インターフェース呼び出しが成功したかどうかを示します。0は成功、その他の値はエラーを示します。 |
message | String | Yes | インターフェース呼び出し結果の説明。エラーコードのテキスト説明です。 |
全て成功
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
このコードブロックはフローティングウィンドウ内に表示されます
全て失敗
{
"code": 40050,
"message": ""
}
{
"code": 40050,
"message": ""
}
このコードブロックはフローティングウィンドウ内に表示されます
エラーコード
コード | 説明 | 詳細な説明 |
---|---|---|
40050 | インターフェース認証に失敗しました。 | プロジェクトIDとプロジェクトシークレットキーが正しいか確認してください。 |
40007 | EUIDが空です。 | EUIDの値を確認してください。 |
50031 | プロジェクトIDが無効です。 | APIKeyとAPISecretが正しいか確認してください。 |
50034 | プロジェクトIDが存在しません。 | APIKeyとAPISecretが正しいか、プロジェクトが削除されていないか確認してください。 |
50074 | APIデータソースが存在しません。 | APIKeyとAPISecretが正しいか、APIデータソースが削除されていないか確認してください。 |
55004 | ビジネスパラメータが無効です。 | リクエストパラメータのフィールドが正しいか確認してください。 |
55101 | ユーザー識別子の数が制限を超えています。 | ユーザー識別の値の数が100を超えていないか確認してください。 |
55102 | 無効なユーザー属性名があります。 | 属性名が命名要件を満たしているか、空でないか、予約文字を使用していないか、長さ制限を超えていないか確認してください。 |
55103 | ユーザー属性値は空にできません。 | リクエストボディ内のユーザー属性の値が空でないか確認してください。 |
55105 | ユーザー識別子の値は256文字を超えることはできません。 | ユーザー識別の値が256文字を超えていないか確認してください。 |
55106 | ユーザー識別子の名前がサポート範囲内にありません。 | ユーザー識別の名前がuser_id、anonymous_id、またはregistration_idであるか確認してください。 |
55107 | ユーザー識別子の値が空です。 | リクエストボディ内のユーザー識別の値が空でないか確認してください。 |
55108 | 無効なEUIDです。 | EUIDの値を確認してください。 |
-1 | 内部サーバーエラー。 | EngageLabの技術サポートに連絡してください。 |