Amazon Pinpoint からのジャーニーイベントデータ
ジャーニーを発行すると、Amazon Pinpoint は、ジャーニーから送信した E メール、SMS、プッシュ、カスタムメッセージのイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からデータを取得して表示します。E メールメッセージと SMS メッセージに対して Amazon Pinpoint がストリーミングするデータの詳細については、「Amazon Pinpoint からの E メールイベントデータストリーム」および「Amazon Pinpoint からの SMS イベントデータストリーム」を参照してください。イベントストリーミングを設定する方法については、「 Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する 」を参照してください。
ジャーニーイベントの例
ジャーニーイベントの JSON オブジェクトには以下のサンプルに示されているデータが含まれています。
{ "event_type":"_journey.send", "event_timestamp":1572989078843, "arrival_timestamp":1572989078843, "event_version":"3.1", "application":{ "app_id":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "sdk":{ } }, "client":{ "client_id":"d8dcf7c5-e81a-48ae-8313-f540cexample" }, "device":{ "platform":{ } }, "session":{ }, "attributes":{ "journey_run_id":"edc9a0b577164d1daf72ebd15example", "journey_send_status":"SUCCESS", "journey_id":"546401670c5547b08811ac6a9example", "journey_activity_id":"0yKexample", "journey_activity_type": "EMAIL", "journey_send_status_message": "200", "journey_send_status_code": "200" }, "client_context":{ "custom":{ "endpoint":"{\"ChannelType\":\"EMAIL\",\"EndpointStatus\":\"ACTIVE\",\"OptOut\":\"NONE\",\"Demographic\":{\"Timezone\":\"America/Los_Angeles\"}}" } }, "awsAccountId":"123456789012" }
ジャーニーイベントの属性
このセクションでは、Amazon Pinpoint がジャーニーについて生成するイベントストリームデータに含まれる属性を定義します。
属性 | 説明 |
---|---|
event_type |
イベントのタイプ。ジャーニーイベントの場合、この属性の値は常に |
event_timestamp |
イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。 |
arrival_timestamp |
イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。 |
event_version |
イベントの JSON スキーマのバージョン。 ヒントイベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。 |
application |
イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「アプリケーション」を参照してください。 |
client |
イベントに関連付けられているエンドポイントについての情報。詳細については、表「クライアント」を参照してください。 |
device |
イベントを報告したデバイスに関する情報。ジャーニーの場合、このオブジェクトは空です。 |
session |
イベントを生成したセッションに関する情報。ジャーニーの場合、このオブジェクトは空です。 |
attributes |
イベントを生成したジャーニーおよびジャーニーアクティビティに関連付けられている属性。詳細については、表「属性」を参照してください。 |
client_context |
endpoint プロパティを格納した custom オブジェクトが含まれています。endpoint プロパティには、イベントに関連付けられているエンドポイントのエンドポイントレコードの内容が含まれています。 |
awsAccountId |
ジャーニーの実行に使用された AWS アカウントの ID。 |
アプリケーション
イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報が含まれています。
属性 | 説明 |
---|---|
app_id |
イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。 |
sdk |
イベントを報告するために使用された SDK。 |
クライアント
イベントが関連付けられているエンドポイントに関する情報が含まれています。
属性 | 説明 |
---|---|
client_id |
エンドポイントの ID。 |
属性
イベントを生成したジャーニーに関する情報が含まれています。
属性 | 説明 |
---|---|
journey_run_id |
イベントを生成したジャーニーの一意の ID。Amazon Pinpoint はジャーニーの新しい実行ごとに自動的にこの ID を生成し、割り当てます。 |
journey_send_status |
イベントに関連付けられているメッセージの配信ステータスを示します。可能な値は以下のとおりです:
|
journey_id |
イベントを生成したジャーニーの一意の ID。 |
journey_activity_id |
イベントを生成したジャーニーアクティビティの一意の ID。 |
journey_activity_type |
イベントのジャーニーアクティビティタイプです。これは、EMAIL、SMS、PUSH、CONTACT_CENTER、または CUSTOM です。 注記音声は、サポートされているジャーニーアクティビティタイプではありません。 |
|
送信イベントのステータスの説明。 |
journey_send_status_code |
リクエストの HTTP ステータスコード。 |