Amazon Pinpoint からの E メールイベントデータストリーム

Amazon Pinpoint を使用して E メールを送信する場合、Amazon Pinpoint はそれらの E メールに関するイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からイベントデータを取得して表示します。イベントストリーミングを設定する方法については、「 Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する」を参照してください。Amazon Pinpoint は、E メールメッセージの次のタイプのイベントに関するデータをストリーミングします。

送信数
配信数
バウンス
苦情
開封数
クリック数
拒否数
サブスクリプション解除数
レンダリングの失敗

これらのイベントタイプについては、「E メールイベント属性」で詳しく説明されています。

E メールメッセージの送信に使用する API および設定によっては、追加のイベントタイプや異なるデータが表示される場合があります。例えば、Amazon Simple Email Service (Amazon SES) が提供する設定セットなど、Amazon Kinesis にイベントデータを発行する設定セットを使用してメッセージを送信する場合、データにはテンプレートのレンダリングの失敗に関するイベントが含まれることもあります。データの詳細については、『Amazon Simple Email Service デベロッパーガイド』の「Amazon SES イベント発行を使用したモニタリング」を参照してください。イベントストリーミングを設定する前に、「 Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する」を参照してください。イベントストリーミングを設定するときは、イベントデータを保存する送信先を指定し、送信先を使用してイベントデータを取得して表示できます。

E メールイベントの例

E メール送信

E メール送信イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。


{
  "event_type": "_email.send",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618622025,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "9a311b17-6f8e-4093-be61-4d0bbexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "received"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "send": {}
      }
    }
  }
}

E メール配信済み

E メール配信イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。


{
  "event_type": "_email.delivered",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618622690,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "e9a3000d-daa2-40dc-ac47-1cd34example"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "delivered"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "delivery": {
          "smtp_response": "250 ok:  Message 82080542 accepted",
          "reporting_mta": "a8-53.smtp-out.amazonses.com",
          "recipients": ["recipient@example.com"],
          "processing_time_millis": 1310
        }
      }
    }
  }
}

E メールクリック

E メールクリックイベントの JSON オブジェクトには以下の例に示されているデータが含まれています。


{
  "event_type": "_email.click",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618713751,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "49c1413e-a69c-46dc-b1c4-6470eexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "https://aws.amazon.com/pinpoint/"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }, {
            "name": "Message-ID",
            "value": "null"
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "click": {
          "ip_address": "72.21.198.67",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.2 Safari/605.1.15",
          "link": "https://aws.amazon.com/pinpoint/"
        }
      }
    }
  }
}

E メール開封

E メール開封イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。


{
  "event_type": "_email.open",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618712316,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "8dc1f651-b3ec-46fc-9b67-2a050example"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "opened"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }, {
            "name": "Message-ID",
            "value": "null"
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "open": {
          "ip_address": "72.21.198.67",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko)"
        }
      }
    }
  }
}

E メールイベント属性

このセクションでは、E メールメッセージの送信時に Amazon Pinpoint が生成する前の例のイベントストリームデータに含まれる属性を定義します。

属性	説明
`event_type`	イベントのタイプ。可能な値は以下のとおりです。 _email.send – Amazon Pinpoint はメッセージを受け入れて、受信者に配信しようとしました。 _email.delivered – メッセージが受信者に配信されました。 _email.rejected – Amazon Pinpoint は、メッセージにマルウェアが含まれていると判断し、送信を試みませんでした。 _email.hardbounce – 恒久的な問題により、Amazon Pinpoint がメッセージを配信できませんでした。Amazon Pinpoint は再度メッセージを配信しようとはしません。 _email.softbounce – 一時的な問題により、Amazon Pinpoint はメッセージを配信することができませんでした。Amazon Pinpointは、一定時間、再度配信を試みます。それでも配信できない場合、それ以上の再試行は行いません。このとき、メールの最終的なステータスは SOFTBAUNCE になります。 _email.complaint — 受信者がメッセージを受信し、そのメッセージをスパムとしてメールプロバイダーに報告しました（例えば、メールクライアントの「スパム報告」機能を使用した場合)。 _email.open – 受信者がメッセージを受信して開封しました。 _email.click – 受信者がメッセージを受信し、メッセージ内のリンクをクリックしました。 _email.click – 受信者がメッセージを受信し、メッセージ内のリンクをクリックしました。 email.rendering_failure — レンダリングが失敗したため E メールが送信されませんでした。これは、テンプレートデータが見つからない場合や、テンプレートのパラメータとデータが一致しない場合に発生します。
`event_timestamp`	メッセージが送信された時刻。Unix 時間（ミリ秒単位）として表示されます。この値は通常、メッセージに対して生成されるすべてのイベントで同じです。
`arrival_timestamp`	イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。
`event_version`	イベントの JSON スキーマのバージョン。ヒントイベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。
`application`	イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「アプリケーション」を参照してください。
`client`	イベントをレポートしたデバイスにインストールされているアプリクライアントに関する情報。詳細については、表「クライアント」を参照してください。
`device`	イベントを報告したデバイスに関する情報。詳細については、表「デバイス」を参照してください。 E メールイベントの場合、このオブジェクトは空です。
`session`	E メールイベントの場合、このオブジェクトは空です。
`attributes`	イベントに関連付けられている属性。詳細については、表「属性」を参照してください。アプリケーションの 1 つによって報告されるイベントの場合、このオブジェクトにはアプリケーションによって定義されたカスタム属性を含めることができます。キャンペーンまたはジャーニーからメッセージを送信するときに作成されるイベントの場合、このオブジェクトにはキャンペーンまたはジャーニーに関連付けられた属性が含まれます。トランザクションメッセージを送信するときに生成されるイベントの場合、このオブジェクトにはメッセージ自体に関連する情報が含まれます。
`client_context`	E メールイベントの場合、このオブジェクトには `legacy_identifier` 属性を格納した `custom` オブジェクトが含まれています。`legacy_identifier` 属性の値は、メッセージの送信元のプロジェクトの ID です。
`facets`	E メールヘッダーなど、メッセージに関する追加情報。詳細については、表「ファセット」を参照してください。
`awsAccountId`	メッセージの送信に使用された AWS アカウントの ID。

アプリケーション

イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報が含まれています。

属性	説明
`app_id`	イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。
`sdk`	イベントを報告するために使用された SDK。Amazon Pinpoint API を直接呼び出すか、Amazon Pinpoint コンソールを使用してトランザクション E メールメッセージを送信する場合、このオブジェクトは空です。

属性

イベントを生成したキャンペーンまたはジャーニーに関する情報が含まれています。

Campaign

イベントを生成したキャンペーンに関する情報が含まれています。

属性	説明
`feedback`	`_email.click` イベントの場合、この属性の値は、受取人がイベントを生成するためにメッセージ内でクリックしたリンクの URL です。他のイベントの場合、この値はイベントタイプ (`received`、`opened`、`clicked` など) を表します。
`treatment_id`	メッセージが A/B テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。標準キャンペーンおよびトランザクション E メールメッセージの場合、この値は `0` です。
`campaign_activity_id`	イベントが発生したときに Amazon Pinpoint が生成する一意の ID。
`campaign_id`	メッセージを送信したキャンペーンの一意の ID。

ジャーニー

イベントを生成したジャーニーに関する情報が含まれています。

属性	説明
`journey_run_id`	メッセージを送信したジャーニーの一意の ID。Amazon Pinpoint はジャーニーの新しい実行ごとに自動的にこの ID を生成し、割り当てます。
`feedback`	`_email.click` イベントの場合、この属性の値は、受取人がイベントを生成するためにメッセージ内でクリックしたリンクの URL です。他のイベントの場合、この値はイベントタイプ (`received`、`delivered`、`opened` など) を表します。
`journey_id`	メッセージを送信したジャーニーの一意の ID。
`journey_activity_id`	メッセージを送信したジャーニーアクティビティの一意の ID。

クライアント

キャンペーンまたはジャーニーのターゲットとなったクライアントの一意の識別子。

属性	説明
`client_id`	クライアントの ID。値はキャンペーンとジャーニーのエンドポイント ID で、トランザクション送信の場合は UUID です。

メッセージおよびイベントタイプに関する情報が含まれています。

属性	説明
`email_channel`	`mail_event` オブジェクトが含まれています。このオブジェクトは、2 つのオブジェクト (`mail`、およびイベントタイプに対応するオブジェクト) を格納しています。

Mail

E メールメッセージのコンテンツに関する情報と、メッセージに関するメタデータが含まれています。

属性	説明
`message_id`	メッセージの ID。Amazon Pinpoint は、メッセージを受け入れる際に、このIDを自動的に生成します。
`message_send_timestamp`	メッセージが送信された日付と時刻。RFC 822 で指定された形式で示されます。
`from_address`	メッセージの送信元の E メールアドレス。
`destination`	メッセージの送信先の E メールアドレスを含む配列。
`headers_truncated`	E メールヘッダーが切り捨てられたかどうかを示すブール値。
`headers`	メッセージのヘッダーに対応する複数の名前と値のペアを含むオブジェクト。このオブジェクトには通常、次のヘッダーに関する情報が含まれています。 `From` – 送信者の E メールアドレス。 `To` – 受信者の E メールアドレス。 `Subject` – E メールの件名。ヒントキャンペーンの _email.send イベントには Subject ヘッダーは含まれません。 `MIME-Version` – メッセージが MIME 形式であることを示します。このヘッダーが存在する場合、値は常に `1.0` です。 `Content-Type` – メッセージコンテンツの MIME メディアタイプ。
`common_headers`	E メールメッセージの複数の共通ヘッダーに関する情報が含まれています。情報には、メッセージが送信された日付、メッセージの宛先、送信元、および件名が含まれます。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon Pinpoint からのジャーニーイベントデータ

Amazon Pinpoint からの SMS イベントデータストリーム