Amazon Pinpoint からのキャンペーンイベントデータストリーム - Amazon Pinpoint

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon Pinpoint からのキャンペーンイベントデータストリーム

Amazon Pinpoint を使用してチャネル経由でキャンペーンを送信する場合、Amazon Pinpoint はそれらのキャンペーンに関するイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint は、セットアップ時に指定した送信先からキャンペーンから送信した E メールまたはSMSメッセージのアプリケーションのイベントデータを取得します。Amazon Pinpoint が E メールとSMSメッセージ用にストリーミングするデータの詳細については、Amazon Pinpoint からのイベントデータストリームの E メール送信「」および「」を参照してくださいSMS Amazon Pinpoint からのイベントデータストリーム。イベントストリーミングの設定方法については、「」を参照してください Amazon Kinesis または Amazon Data Firehose を介してアプリケーションイベントデータをストリーミングするように Amazon Pinpoint を設定する

キャンペーンイベントの例

キャンペーンイベントの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 – プッシュ通知キャンペーンの場合、このイベントタイプは受信者がメッセージをバックグラウンド通知として受け取ったことを示します。

    注記

    _campaign.opened_notification_campaign.received_foreground_campaign.received_background は AWS Amplifyを使用した場合のみ返されます。アプリと の統合の詳細については、「」を参照してください AWS Amplify。「Amplify を使用して AWS フロントエンドアプリケーションを Amazon Pinpoint に接続する」を参照してください。

event_timestamp

イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。

arrival_timestamp

イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。

event_version

イベントJSONスキーマのバージョン。

ヒント

イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。

application

イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「アプリケーション」を参照してください。

client

イベントが関連付けられているエンドポイントに関する情報。詳細については、表「クライアント」を参照してください。

device

イベントを報告したデバイスに関する情報。キャンペーンメッセージとトランザクションメッセージの場合、このオブジェクトは空です。

session

イベントを生成したセッションに関する情報。キャンペーンの場合、このオブジェクトは空です。

attributes

イベントに関連付けられている属性。アプリケーションの 1 つによって報告されるイベントの場合、このオブジェクトにはアプリケーションによって定義されたカスタム属性を含めることができます。キャンペーンを送信したときに作成されたイベントの場合、このオブジェクトにはキャンペーンに関連付けられた属性が含まれています。トランザクションメッセージを送信するときに生成されるイベントの場合、このオブジェクトにはメッセージ自体に関連する情報が含まれます。

詳細については、表「属性」を参照してください。

client_context endpoint プロパティを格納した custom オブジェクトが含まれています。endpoint プロパティには、キャンペーンが送信されたエンドポイントのエンドポイントレコードの内容が含まれています。
awsAccountId

メッセージの送信に使用された AWS アカウントの ID。

アプリケーション

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

属性 説明
app_id

イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。

sdk

イベントの報告にSDK使用された 。

属性

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

属性 説明
treatment_id

メッセージが A/B テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。標準キャンペーンの場合、この値は 0 です。

campaign_activity_id イベントが発生したときに Amazon Pinpoint が生成する一意の ID。
delivery_type

キャンペーンの配信方法。この属性を、client_contextendpoint プロパティで指定された ChannelType フィールドと混同しないでください。ChannelType フィールドは通常、メッセージの送信先のエンドポイントに基づいています。

1 つのエンドポイントタイプのみをサポートするチャネルの場合、delivery_type および ChannelType フィールドの値は同じになります。例えば、E メールチャネルの場合、 フィールドdelivery_typeChannelTypeフィールドの値は同じですEMAIL。

ただし、カスタムチャネルなど、さまざまなエンドポイントタイプをサポートするチャネルでは、この条件は必ずしも当てはまりません。カスタムチャネルは、、、 などEMAILSMS、さまざまなエンドポイントに使用できますCUSTOM。この場合、 はカスタム配信イベント delivery_type を識別し、 はCUSTOM、キャンペーンが送信されたエンドポイントのタイプChannelTypeを指定します。例えば、EMAIL、 SMS CUSTOMなどです。カスタムチャンネルの作成の詳細については、「ウェブフックまたは 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 – 1 日あたりの最大メッセージ数が既にエンドポイントに送信されているため、キャンペーンはエンドポイントに送信されませんでした。

  • EXPIRED – 送信がキャンペーンの最大期間または送信レート設定を超えるため、キャンペーンはエンドポイントに送信されませんでした。

  • QUIET_TIME – クワイエットタイム制限のため、キャンペーンはエンドポイントに送信されませんでした。

  • HOLDOUT – エンドポイントがホールドアウトグループのメンバーであったため、キャンペーンはエンドポイントに送信されませんでした。

  • DUPLICATE_ADDRESS – セグメント内に重複するエンドポイントアドレスがあります。キャンペーンはエンドポイントアドレスに 1 回送信されました。

  • QUIET_TIME – クワイエットタイム制限のため、キャンペーンはエンドポイントに送信されませんでした。

  • CAMPAIGN_CAP – このキャンペーンからエンドポイントに送信されたメッセージの最大数がすでにあるため、キャンペーンはエンドポイントに送信されませんでした。

  • FAILURE_PERMANENT – エンドポイントへの送信時に永続的な障害が発生しました。

  • TRANSIENT_FAILURE – エンドポイントへの送信時に一時的な障害が発生しました。

  • THROTTLED – 送信がスロットリングされました。

  • UNKNOWN – 不明な障害。

  • HOOK_FAILURE – キャンペーンフックが失敗しました。

  • CUSTOM_DELIVERY_FAILURE – カスタム配信に失敗しました。

  • RECOMMENDATION_FAILURE – レコメンダーに失敗しました。

  • UNSUPPORTED_CHANNEL – チャネルはサポートされていません。

クライアント

キャンペーンの対象となったエンドポイントに関する情報が含まれています。

属性 説明
client_id キャンペーンが送信されたエンドポイントのエンドポイント ID。