來自 Amazon Pinpoint 的旅程事件資料 - Amazon Pinpoint

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

來自 Amazon Pinpoint 的旅程事件資料

當您發佈旅程時,Amazon Pinpoint 可以串流您從旅程傳送的電子郵件、SMS、推播和自訂訊息的事件資料。設定事件串流後,Amazon Pinpoint 會從您在設定期間指定的目的地擷取資料,供您檢視。如需 Amazon Pinpoint 串流的電子郵件和SMS訊息資料的詳細資訊,請參閱 從 Amazon Pinpoint 以電子郵件傳送事件資料串流SMS 來自 Amazon Pinpoint 的事件資料串流。如需有關如何設定事件串流的資訊,請參閱 設定 Amazon Pinpoint,透過 Amazon Kinesis 或 Amazon Data Firehose 串流應用程式事件資料

旅程事件範例

旅程事件的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

SDK 用於報告事件的 。

用戶端

包含事件相關聯的端點相關資訊。

屬性 描述
client_id 端點的 ID。

Attributes

包含產生事件的旅程相關資訊。

屬性 描述
journey_run_id

產生事件的旅程執行的唯一 ID。Amazon Pinpoint 會自動產生這個 ID,並指派給每個新的旅程執行。

journey_send_status

表示與事件相關聯的訊息交付狀態。可能的值包括:

  • SUCCESS – 訊息已成功傳送至端點。

  • FAILURE – 訊息未傳送至端點,因為發生錯誤。

  • CUSTOM_DELIVERY_FAILURE – 自訂交付失敗。

  • FAILURE_PERMANENT – 傳送至端點時發生永久失敗。

    提示

    您可以篩選具有 FAILURE_PERMANENT 狀態的事件,並journey_send_status_code設為 403,以判斷是否存在存取政策和角色違規。對於有語音的傳出行銷活動,這些例外通常適用於連線行銷活動執行角色將 Amazon Pinpoint 旅程繫結至 Amazon 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的狀態碼。