從 Amazon Pinpoint 的行銷活動事件資料串流

如果您使用 Amazon Pinpoint 透過管道傳送行銷活動，Amazon Pinpoint 可以串流這些行銷活動的事件資料。設定事件串流後，Amazon Pinpoint 會從您在設定期間指定的目的地擷取您應用程式的電子郵件或SMS訊息的事件資料，供您檢視。如需 Amazon Pinpoint 串流的電子郵件和SMS訊息資料的詳細資訊，請參閱從 Amazon Pinpoint 以電子郵件傳送事件資料串流和 SMS 來自 Amazon Pinpoint 的事件資料串流。如需有關如何設定事件串流的資訊，請參閱設定 Amazon Pinpoint，透過 Amazon Kinesis 或 Amazon Data Firehose 串流應用程式事件資料。

行銷活動事件範例

行銷活動事件的JSON物件包含下列範例中顯示的資料。


{
  "event_type": "_campaign.send",
  "event_timestamp": 1562109497426,
  "arrival_timestamp": 1562109497494,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "d8dcf7c5-e81a-48ae-8313-f540cexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "treatment_id": "0",
    "campaign_activity_id": "5473285727f04865bc673e527example",
    "delivery_type": "GCM",
    "campaign_id": "4f8d6097c2e8400fa3081d875example",
    "campaign_send_status": "SUCCESS"
  },
  "client_context": {
    "custom": {
      "endpoint": "{\"ChannelType\":\"GCM\",\"EndpointStatus\":\"ACTIVE\",
          ↳\"OptOut\":\"NONE\",\"RequestId\":\"ec229696-9d1e-11e9-8bf1-85d0aexample\",
          ↳\"EffectiveDate\":\"2019-07-02T23:12:54.836Z\",\"User\":{}}"
    }
  },
  "awsAccountId": "123456789012"
}

行銷活動事件屬性

本區段定義包含在行銷活動事件串流中的屬性。

屬性	描述
`event_type`	事件的類型。可能值為： _campaign.send – Amazon Pinpoint 執行了該行銷活動。 _campaign.opened_notification – 適用於推播通知行銷活動，此事件類型表示收件人已點選並開啟通知。 _campaign.received_foreground – 適用於推播通知行銷活動，此事件類型表示收件人已收到前景通知訊息。 _campaign.received_background – 適用於推播通知行銷活動，此事件類型表示收件人已收到背景通知訊息。注意只有當您使用 AWS Amplify時，才會傳回 _campaign.opened_notification、_campaign.received_foreground 和 _campaign.received_background。如需將應用程式與整合的詳細資訊 AWS Amplify。請參閱使用 AWS Amplify 將您的前端應用程式連線至 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 用於報告事件的。

Attributes

包含產生事件的行銷活動資訊。

屬性	描述
`treatment_id`	如果訊息曾使用 A/B 測試行銷活動傳送，則此值代表訊息的處理方式號碼。若為標準行銷活動，此值為 `0`。
`campaign_activity_id`	事件發生時，Amazon Pinpoint 產生的唯一 ID。
`delivery_type`	行銷活動的交付方法。請勿將此屬性與 `client_context` 的 `endpoint` 屬性下指定的 `ChannelType` 欄位搞混。`ChannelType` 欄位通常基於訊息傳送的目的地端點而定。對於只支援一種端點類型的管道，`delivery_type` 和 `ChannelType` 欄位的值相同。例如，對於電子郵件通道， `delivery_type`和 `ChannelType` 欄位具有相同的值 EMAIL。但對於支援不同端點類型的管道 (例如自訂頻道) 而言，情況並不總是如此。您可以針對不同的端點使用自訂頻道，例如 EMAIL、CUSTOM、 SMS等。在此情況下，會`delivery_type`識別自訂交付事件， CUSTOM和會`ChannelType`指定行銷活動傳送至的端點類型，例如 EMAIL、CUSTOM、 SMS等。如需建立自訂頻道的詳細資訊，請參閱使用 Webhook 或 Lambda 函數在 Amazon Pinpoint 中建立自訂頻道。可能值為： EMAIL SMS ADM APNS APNS_SANDBOX APNS_VOIP APNS_VOIP_SANDBOX VOICE GCM BAIDU PUSH CUSTOM
`campaign_id`	訊息傳送來源的行銷活動唯一 ID。
`campaign_send_status`	指出目標端點的行銷活動狀態。可能的值包括： SUCCESS – 行銷活動已成功傳送至端點。 FAILURE – 行銷活動未傳送至端點。 DAILY_CAP – 行銷活動未傳送至端點，因為已將每日訊息數目上限傳送至端點。 EXPIRED – 行銷活動未傳送至端點，因為傳送會超過行銷活動的持續時間上限或傳送速率設定。 QUIET_TIME – 由於安靜的時間限制，行銷活動未傳送至端點。 HOLDOUT – 因為端點是保留群組的成員，所以行銷活動未傳送至端點。 DUPLICATE_ADDRESS – 區段中有重複的端點地址。行銷活動已傳送到端點地址一次。 QUIET_TIME – 由於安靜的時間限制，行銷活動未傳送至端點。 CAMPAIGN_CAP – 行銷活動未傳送至端點，因為已從此行銷活動將訊息數目上限傳送至端點。 FAILURE_PERMANENT – 傳送至端點時發生永久失敗。 TRANSIENT_FAILURE – 傳送至端點時發生暫時性失敗。 THROTTLED – 已調節傳送。 UNKNOWN – 未知失敗。 HOOK_FAILURE – 行銷活動掛鉤失敗。 CUSTOM_DELIVERY_FAILURE – 自訂交付失敗。 RECOMMENDATION_FAILURE – 建議程式失敗。 UNSUPPORTED_CHANNEL – 不支援頻道。

用戶端

包含行銷活動鎖定的目標端點資訊。

屬性	描述
`client_id`	行銷活動傳送端點的 ID。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

從 Amazon Pinpoint 的應用程式事件資料串流

來自 Amazon Pinpoint 的旅程事件資料

從 Amazon Pinpoint 的行銷活動事件資料串流

行銷活動事件範例

行銷活動事件屬性

注意

提示

應用程式

Attributes

用戶端