旅程事件 - Amazon Pinpoint

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

旅程事件

如果您发布旅程,Amazon Pinpoint 可以流式传输有关旅程的事件数据。这包括您从旅程中发送的任何电子邮件、短信、推送或自定义消息的事件数据。在查看活动之前,必须先设置活动直播,请参阅设置事件流式传输。在设置事件直播时,您可以指定要保存事件数据的目的地,然后可以使用该目标检索事件数据以供查看。

有关 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

事件类型。对于旅程事件,此属性的值始终为 _journey.send,这表示 Amazon Pinpoint 已执行旅程。

event_timestamp

报告事件的时间,显示为以毫秒为单位的 Unix 时间。

arrival_timestamp

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

event_version

事件 JSON 架构的版本。

提示

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

application

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

client

与事件关联的端点的相关信息。有关更多信息,请参阅客户端 表。

device

报告事件的设备的相关信息。对于历程,此对象为空。

session

有关生成事件的会话的信息。对于历程,此对象为空。

attributes

与生成事件的旅程和旅程活动关联的属性。有关更多信息,请参阅属性表。

client_context 包含一个 custom 对象,其中包含一个 endpoint 属性。endpoint 属性包含与事件关联的端点的端点记录内容。
awsAccountId

用于执行旅程的 AWS 账户的 ID。

应用程序

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

属性 描述
app_id

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

sdk

用于报告该事件的开发工具包。

客户端

包括与事件关联的端点的相关信息。

属性 描述
client_id 端点的 ID。

Attributes

包括有关生成事件的旅程的信息。

属性 描述
journey_run_id

生成事件的旅程的唯一 ID。Amazon Pinpoint 会自动为旅程的每一个新运行生成并分配此 ID。

journey_send_status

指示与事件关联的消息的传输状态。可能的值包括:

  • SUCCESS – 消息已成功发送到端点。

  • FAILURE – 由于出错,消息未发送到端点。

  • CUSTOM_DELIVERY_FAILURE – 自定义交付失败。

  • FAILURE_PERMANENT – 发送到端点时发生永久故障。

    提示

    您可以筛选状态为 FAILURE_PERMAN EN journey_send_status_code T 且设置为 403 的事件,以确定是否存在访问策略和角色违规。对于带语音的出站营销活动,这些例外情况通常是将 Amazon Pinpoint 旅程与 Amazon Connect 活动绑定的 connect 活动执行角色无意中删除以执行机上旅程的情况。

  • THROTTLED – 发送已被限制。

  • UNSUPPORTED_CHANNEL – 不支持渠道。

  • DAILY_CAP – 由于发送消息将超过旅程或项目在 24 小时内可以向单个端点发送的最大消息数,消息未发送到端点。

  • QUIET_TIME – 由于旅程或项目的安静时间限制,未发送消息。

  • QUIET_TIME_MISSING_TIMEZONE – 消息未发送,因为时区估计无法估计端点的时区,并且已启用安静时间。

journey_id

生成事件的旅程的唯一 ID。

journey_activity_id

生成事件的旅程活动的唯一 ID。

journey_activity_type

事件的旅程活动类型。可以是 EMAILSMSPUSHCONTACT_CENTERCUSTOM

注意

VOICE 不是支持的旅程活动类型。

journey_send_status_message

发送事件状态的描述。
journey_send_status_code 请求的 HTTP 状态码。