来自 Amazon Pinpoint 的电子邮件事件数据流 - Amazon Pinpoint
电子邮件事件示例电子邮件事件属性

来自 Amazon Pinpoint 的电子邮件事件数据流

如果您使用 Amazon Pinpoint 发送电子邮件，Amazon Pinpoint 可以流式传输有关这些电子邮件的事件数据。设置事件流式传输后，Amazon Pinpoint 会从您在设置期间指定的目的地中检索事件数据供您查看。有关如何设置事件流式传输的信息，请参阅 设置 Amazon Pinpoint 以通过 Amazon Kinesis 或 Amazon Data Firehose 流式传输应用程序事件数据 。Amazon Pinpoint 为电子邮件消息流式传输有关以下类型事件的数据：

  • 发送

  • 已传送数

  • 退回数

  • 投诉

  • 打开

  • 点击

  • 拒绝数

  • 取消订阅数

  • 呈现失败数

电子邮件事件属性中对这些事件类型进行了详细说明。

根据您用于发送电子邮件的 API 和设置，您可能会看到其他事件类型或不同的数据。例如，如果您使用将事件数据发布到 Amazon Kinesis 的配置集（如 Amazon Simple Email Service (Amazon SES) 提供的配置集）发送消息，则这些数据还可能包括模板渲染失败的事件。有关该数据的信息，请参阅《Amazon Simple Email Service 开发人员指南》中的使用 Amazon SES 事件发布进行监控。查看事件之前，必须先设置事件流式传输，请参阅 设置 Amazon Pinpoint 以通过 Amazon Kinesis 或 Amazon Data Firehose 流式传输应用程序事件数据 。设置事件流式传输时，您指定要保存事件数据的目的地，然后可以使用该目的地来检索事件数据以供查看。

电子邮件事件示例

电子邮件发送

email send 事件的 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": {}
      }
    }
  }
}
电子邮件送达

email delivered 事件的 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
        }
      }
    }
  }
}
电子邮件点击

email click 事件的 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/"
        }
      }
    }
  }
}
电子邮件打开

email open 事件的 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)"
        }
      }
    }
  }
}

电子邮件事件属性

本节定义了在您发送电子邮件消息时 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 将经过一定时间后尝试再次传送邮件。如果仍无法传送邮件，则不会再尝试重试。电子邮件的最终状态将是 SOFTBOUNCE。

  • _email.complaint – 收件人收到了邮件，然后向其电子邮件提供商举报该邮件为垃圾邮件（例如，使用电子邮件客户端的“报告垃圾邮件”功能）。

  • _email.open – 收件人收到并打开了邮件。

  • _email.click – 收件人已收到邮件并点击了邮件中的链接。

  • _email.unsubscribe – 收件人已收到邮件并点击了邮件中的取消订阅链接。

  • _email.rendering_failure – 由于渲染失败，邮件未发送。当模板数据丢失或模板参数与数据不匹配时，可能会发生此事件类型。
event_timestamp

发送邮件的时间，显示为以毫秒为单位的 Unix 时间。对于为一条邮件生成的所有事件，该值通常都相同。
arrival_timestamp

Amazon Pinpoint 收到事件的时间，显示为以毫秒为单位的 Unix 时间。
event_version

事件 JSON 架构的版本。

提示

在事件处理应用程序中检查此版本，以便知道何时更新应用程序以响应架构更新。
application

与事件关联的 Amazon Pinpoint 项目的相关信息。有关更多信息，请参阅应用程序 表。
client

包括安装在设备上用于报告事件的应用程序客户端的相关信息。有关更多信息，请参阅客户端 表。
device

报告事件的设备的相关信息。有关更多信息，请参阅设备 表。

对于电子邮件事件，此对象为空。
session 对于电子邮件事件，此对象为空。
attributes

与事件关联的属性。有关更多信息，请参阅属性 表。

对于您的应用程序之一报告的事件，此对象包含由应用程序定义的自定义属性。对于在您从活动或旅程发送电子邮件时创建的事件，此对象包含与活动或旅程关联的属性。对于在您发送事务性电子邮件时生成的事件，此对象包含与电子邮件本身相关的信息。
client_context 对于电子邮件事件，此对象包含名为 custom 的对象，该对象包含 legacy_identifier 属性。legacy_identifier 属性的值是发送电子邮件的项目的 ID。
facets

有关电子邮件的其他信息，例如电子邮件标题，请参阅分面 表。
awsAccountId

已用于发送电子邮件的 AWS 账户的 ID。

应用程序

包括与事件关联的 Amazon Pinpoint 项目的相关信息。

属性 描述
app_id

报告事件的 Amazon Pinpoint 项目的唯一 ID。
sdk

用于报告该事件的开发工具包。如果您通过直接调用 Amazon Pinpoint API 或者使用 Amazon Pinpoint 控制台来发送事务性电子邮件，则此对象为空。

Attributes

包含有关生成事件的活动或旅程的信息。

活动

包含有关生成事件的活动的信息。

属性 描述
feedback

对于 _email.click 事件，此属性的值是收件人点击邮件以生成事件的链接的 URL。对于其他事件，此值表示事件类型（例如 received、opened 或 clicked）。
treatment_id

如果使用 A/B 测试活动发送了消息，则此值表示消息的处理编号。对于标准活动和事务性电子邮件，该值为 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 对象，其中包含两个对象：mail 以及一个与事件类型对应的对象。

邮件

包含有关电子邮件内容的信息，以及与邮件本身相关的元数据。

属性 描述
message_id

邮件的 ID。Amazon Pinpoint 在接受邮件时会自动生成此编号。
message_send_timestamp

发送邮件的日期和时间，按 RFC 822 中指定的格式显示。
from_address

发送邮件的电子邮件地址。
destination

包含邮件发送到的电子邮件地址的数组。
headers_truncated

一个布尔值，用于指示是否截断电子邮件标头。
headers

一个对象，其中包含与电子邮件中标头对应的多个名称/值对。此对象通常包含有关以下标头的信息：

  • From – 发件人的电子邮件地址。

  • To – 收件人的电子邮件地址。

  • Subject – 电子邮件的主题行。

    提示

    campaign _email.send 事件不包含主题标题。

  • MIME-Version – 指示邮件为 MIME 格式。如果此标头存在，则值始终为 1.0。

  • Content-Type – 邮件内容的 MIME 媒体类型。
common_headers

包含有关电子邮件的几个常用标头的信息。这些信息可以包括邮件的发送日期，以及邮件的收件人、发件人和主题行。