ジャーニーイベント - Amazon Pinpoint

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ジャーニーイベント

ジャーニーを発行する場合、Amazon Pinpoint はジャーニーのイベントデータをストリーミングできます。これには、ジャーニーから送信する E メール、SMS、プッシュ、カスタムメッセージのイベントデータも含まれます。

Amazon Pinpoint がストリーミングするデータについては、以下を参照してください。

  • E メールメッセージについては、「E メールイベント」を参照してください。

  • SMS メッセージについては、「SMS イベント」を参照してください。

イベント例

ジャーニーイベントの 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

イベントのタイプ。ジャーニーイベントの場合、この属性の値は常に _journey.send であり、Amazon Pinpoint がジャーニーを実行したことを示します。

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

イベントに関連付けられているメッセージの配信ステータスを示します。可能な値は以下のとおりです:

  • SUCCESS – メッセージはエンドポイントに正常に送信されました。

  • FAILURE – エラーが発生したため、メッセージはエンドポイントに送信されませんでした。

  • CUSTOM_DELIVERY_FAILURE – カスタム配信が失敗しました。

  • FAILURE_PERMANENT – エンドポイントへの送信時に永続的な障害が発生しました。

    ヒント

    FAILURE_PERMANENT ステータスのイベントをフィルタリングし、 を 403 journey_send_status_codeに設定して、アクセスポリシーとロール違反があるかどうかを判断できます。音声によるアウトバウンドキャンペーンの場合、これらの例外は、Amazon Connect キャンペーンへの Amazon Pinpoint ジャーニーをバインドする接続キャンペーン実行ロールが、処理中のジャーニー実行のために誤って削除された場合に発生するのが一般的です。

  • THROTTLED – 送信がスロットリングされました。

  • UNSUPPORTED_CHANNEL – チャネルはサポートされていません。

  • DAILY_CAP – 24 時間内にジャーニーまたはプロジェクトが 1 つのエンドポイントに送信できるメッセージの最大数を超えるため、メッセージはエンドポイントに送信されませんでした。

  • QUIET_TIME – ジャーニーまたはプロジェクトのクワイエットタイム制限のため、メッセージは送信されませんでした。

  • QUIET_TIME_MISSING_TIMEZONE – タイムゾーンの推定ではエンドポイントのタイムゾーンを推定できず、クワイエットタイムが有効になっているため、メッセージは送信されませんでした。

journey_id

イベントを生成したジャーニーの一意の ID。

journey_activity_id

イベントを生成したジャーニーアクティビティの一意の ID。

journey_activity_type

イベントのジャーニーアクティビティタイプです。これは、EMAILSMSPUSHCONTACT_CENTER、または CUSTOM です。

注記

音声は、サポートされているジャーニーアクティビティタイプではありません。

journey_send_status_message

送信イベントのステータスの説明。
journey_send_status_code リクエストの HTTP ステータスコード。