Amazon Pinpoint からのキャンペーンイベントデータストリーム
Amazon Pinpoint を使用してチャンネルを介してキャンペーンを送信する場合、Amazon Pinpoint はそれらのキャンペーンに関するイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint は、セットアップ時に指定した送信先から、キャンペーンから送信した E メールまたは SMS メッセージのアプリケーションのイベントデータを取得します。E メールメッセージと SMS メッセージに対して Amazon Pinpoint がストリーミングするデータの詳細については、「Amazon Pinpoint からの E メールイベントデータストリーム」および「Amazon Pinpoint からの SMS イベントデータストリーム」を参照してください。イベントストリーミングを設定する方法については、「 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 |
イベントのタイプ。可能な値は以下のとおりです。
|
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 テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。標準キャンペーンの場合、この値は |
campaign_activity_id |
イベントが発生したときに Amazon Pinpoint が生成する一意の ID。 |
delivery_type |
キャンペーンの配信方法。この属性を、 1 つのエンドポイントタイプのみをサポートするチャネルの場合、 ただし、カスタムチャネルなど、さまざまなエンドポイントタイプをサポートするチャネルでは、この条件は必ずしも当てはまりません。EMAIL、SMS、CUSTOM など、さまざまなエンドポイントに対してカスタムチャネルを使用できます。この場合、 可能な値は以下のとおりです。
|
campaign_id |
メッセージの送信元のキャンペーンの一意の ID。 |
campaign_send_status |
ターゲットエンドポイントのキャンペーンのステータスを示します。可能な値は以下のとおりです:
|
クライアント
キャンペーンの対象となったエンドポイントに関する情報が含まれています。
属性 | 説明 |
---|---|
client_id |
キャンペーンが送信されたエンドポイントのエンドポイント ID。 |