**サポート終了通知:** 2026 年 10 月 30 日に、 AWS は Amazon Pinpoint のサポートを終了します。2026 年 10 月 30 日を過ぎると、Amazon Pinpoint コンソールまたは Amazon Pinpoint のリソース (エンドポイント、セグメント、キャンペーン、ジャーニー、分析) にアクセスできなくなります。詳細については、「[Amazon Pinpoint のサポート終了](https://docs.aws.amazon.com/console/pinpoint/migration-guide)」を参照してください。**注:** SMS、音声、モバイルプッシュ、OTP、電話番号の検証に関連する APIs は、この変更の影響を受けず、 AWS エンドユーザーメッセージングでサポートされています。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon Pinpoint を使用して Kinesis と Firehose を介してアプリイベントデータをストリーミングする
Amazon Pinpoint では、*イベント*は、ユーザーがアプリケーションの 1 つを操作した場合、お客様がキャンペーンまたはジャーニーからメッセージを送信した場合、お客様がトランザクション SMS または E メールメッセージを送信した場合に発生するアクションです。たとえば、E メールメッセージを送信すると、いくつかのイベントが発生します。
+ メッセージを送信すると、*send* イベントが発生します。
+ メッセージが受信者の受信ボックスに到達すると、*delivered* イベントが発生します。
+ 受信者がメッセージを開くと、*open* イベントが発生します。
イベントに関する情報を Amazon Kinesis に送信するように Amazon Pinpoint を設定できます。Kinesisプラットフォームは、AWS サービスからのデータをリアルタイムに収集、処理、分析するために使用できるサービスを提供します。Amazon Pinpoint は、イベントデータを Firehose に送信し、このデータを Amazon S3 や Amazon Redshift などの AWS データストアにストリーミングすることができます。Amazon Pinpoint は、Kinesis Data Streams にデータを流すこともできます。Kinesis Data Streams は、分析アプリケーションで処理するために複数のデータストリームを取り込み、保存します。
Amazon Pinpoint イベントストリームには、Amazon Pinpoint に接続するアプリケーション (アプリ) のユーザー操作に関する情報が含まれています。また、キャンペーン、任意のチャネル、ジャーニーから送信するすべてのメッセージに関する情報も含まれています。定義した任意のカスタムイベントを含めることができます。最後に、送信するすべてのトランザクション E メールおよび SMS メッセージに関する情報が含まれています。
**注記**
Amazon Pinpoint は、トランザクションプッシュ通知や音声メッセージに関する情報をストリーミングしません。
この章では、イベントデータを Kinesis にストリーミングするための Amazon Pinpoint の設定に関する情報を提供します。また、Amazon Pinpoint がストリーミングするイベントデータの例も含まれています。
**Topics**
+ [Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する](event-streams-setup.md)
+ [Amazon Pinpoint からのアプリケーションイベントデータストリーム](event-streams-data-app.md)
+ [Amazon Pinpoint からのキャンペーンイベントデータストリーム](event-streams-data-campaign.md)
+ [Amazon Pinpoint からのジャーニーイベントデータ](event-streams-data-journey.md)
+ [Amazon Pinpoint からの E メールイベントデータストリーム](event-streams-data-email.md)
+ [Amazon Pinpoint からの SMS イベントデータストリーム](event-streams-data-sms.md)
+ [Amazon Pinpoint からイベントストリームを削除する](event-streams-disable.md)
# Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する
Amazon Pinpoint は、Amazon Kinesis ストリームまたは Amazon Data Firehose 配信ストリームにイベントデータを送信するように設定することができます。Amazon Pinpoint は、キャンペーン、ジャーニー、トランザクション用の Eメールや SMS メッセージのイベントデータを送信することができます。
このセクションには、プログラムによるイベントストリーミングのセットアップに関する情報が含まれています。Amazon Pinpoint コンソールを使用して、イベントストリーミングをセットアップすることもできます。Amazon Pinpoint コンソールを使用したイベントストリーミングのセットアップの詳細については、『*Amazon Pinpoint ユーザーガイド*』の「[イベントストリーム設定](https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-event-streams.html)」を参照してください。
## 前提条件
このセクションの例には、次の入力が必要です。
+ Amazon Pinpoint およびレポートイベントと統合されているアプリケーションのアプリケーション ID。統合する方法については、「[Amazon Pinpoint とアプリケーションを統合する](integrate.md)」を参照してください。
+ AWS アカウントの Kinesis ストリームまたは Firehose 配信ストリームの Amazon リソースネーム (ARN)。これらのリソースの作成については、「Amazon Kinesis Data Streams デベロッパーガイド」の「[ストリームの作成と管理](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html)」、または「Amazon Data Firehose デベロッパーガイド」の「[Amazon Data Firehose 配信ストリームの作成](https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html)」を参照してください。****
+ Amazon Pinpoint がストリームにデータを送信することを許可する AWS Identity and Access Management (IAM) ロールの ARN。ロールの作成の詳細については、「[Kinesis にイベントをストリーミングするための IAM ロール](permissions-streams.md)」を参照してください。
## AWS CLI
次の AWS CLI 例では、[put-event-stream](https://docs.aws.amazon.com/cli/latest/reference/pinpoint/put-event-stream.html) コマンドを使用します。このコマンドは、イベントを Kinesis ストリームに送信するように Amazon Pinpoint を設定します。
```
aws pinpoint put-event-stream \
--application-id projectId \
--write-event-stream DestinationStreamArn=streamArn,RoleArn=roleArn
```
## AWS SDK for Java
次の Java の例では、イベントを Kinesis ストリームに送信するように Amazon Pinpoint を設定します。
```
public PutEventStreamResult createEventStream(AmazonPinpoint pinClient,
String appId, String streamArn, String roleArn) {
WriteEventStream stream = new WriteEventStream()
.withDestinationStreamArn(streamArn)
.withRoleArn(roleArn);
PutEventStreamRequest request = new PutEventStreamRequest()
.withApplicationId(appId)
.withWriteEventStream(stream);
return pinClient.putEventStream(request);
}
```
この例では、Kinesis ストリームの ARN と IAM ロールを保存する `WriteEventStream` オブジェクトを構築します。`WriteEventStream` オブジェクトは、`PutEventStreamRequest` オブジェクトに渡され、特定のアプリケーションのためにイベントをストリーミングするように Amazon Pinpoint を設定します。`PutEventStreamRequest` オブジェクトは Amazon Pinpoint クライアントの `putEventStream` メソッドに渡されます。
Kinesis ストリームは複数のアプリケーションに割り当てることができます。これを行うと、Amazon Pinpoint は各アプリケーションからストリームに base64 でエンコードされたイベントデータを送信するので、データをコレクションとして分析できます。以下の例のメソッドでは、アプリケーション (アプリ) ID のリストを受け取り、前の例のメソッドである `createEventStream` を使用して各アプリにストリームを割り当てます。
```
public List createEventStreamFromAppList(
AmazonPinpoint pinClient, List appIDs,
String streamArn, String roleArn) {
return appIDs.stream()
.map(appId -> createEventStream(pinClient, appId, streamArn,
roleArn))
.collect(Collectors.toList());
}
```
1 つのストリームを複数のアプリケーションに割り当てることができますが、複数のストリームを 1 つのアプリケーションに割り当てることはできません。
# Amazon Pinpoint からのアプリケーションイベントデータストリーム
アプリケーション (アプリ) を Amazon Pinpoint と統合してイベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からアプリケーションのユーザーアクティビティ、カスタムイベント、およびメッセージ配信データを取得して表示します。イベントデータを表示できるようにイベントストリーミングを設定する方法については、「[Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する](event-streams-setup.md)」を参照してください。
## アプリケーションイベントの例
アプリイベントの JSON オブジェクトには以下の例に示されているデータが含まれています。
```
{
"event_type": "_session.stop",
"event_timestamp": 1487973802507,
"arrival_timestamp": 1487973803515,
"event_version": "3.0",
"application": {
"app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"cognito_identity_pool_id": "us-east-1:a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
"package_name": "main.page",
"sdk": {
"name": "aws-sdk-mobile-analytics-js",
"version": "0.9.1:2.4.8"
},
"title": "title",
"version_name": "1.0",
"version_code": "1"
},
"client": {
"client_id": "m3n4o5p6-a1b2-c3d4-e5f6-g7h8i9j0k1l2",
"cognito_id": "us-east-1:i9j0k1l2-m3n4-o5p6-a1b2-c3d4e5f6g7h8"
},
"device": {
"locale": {
"code": "en_US",
"country": "US",
"language": "en"
},
"make": "generic web browser",
"model": "Unknown",
"platform": {
"name": "android",
"version": "10.10"
}
},
"session": {
"session_id": "f549dea9-1090-945d-c3d1-e4967example",
"start_timestamp": 1487973202531,
"stop_timestamp": 1487973802507
},
"attributes": {},
"metrics": {}
}
```
## アプリイベントの属性
このセクションでは、前の例のアプリケーションイベントストリームに含まれる属性を定義します。
| 属性 | 説明 |
| --- | --- |
| event\$1type | イベントのタイプ。可能な値は以下のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-app.html) |
| event\$1timestamp | イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。 |
| arrival\$1timestamp | イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。 |
| event\$1version | イベントの JSON スキーマのバージョン。 イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。 |
| application | イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「[アプリケーション](#event-streams-data-app-attributes-application)」を参照してください。 |
| client | イベントを報告したエンドポイントに関する情報。詳細については、表「[クライアント](#event-streams-data-app-attributes-client)」を参照してください。 |
| device | イベントを報告したデバイスに関する情報。詳細については、表「[デバイス](#event-streams-data-app-attributes-device)」を参照してください。 |
| session | イベントを生成したセッションに関する情報。詳細については、表「[セッション](#event-streams-data-app-attributes-session)」を参照してください。 |
| attributes | イベントに関連付けられている属性。アプリケーションによって報告されるイベントの場合、このオブジェクトにはユーザーが定義したカスタム属性が含まれます。 |
| metrics | イベントに関連するメトリクス。オプションで、カスタムメトリクスを Amazon Pinpoint に送信するようにアプリケーションを設定できます。 |
### アプリケーション
イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| app\$1id | イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。 |
| cognito\$1identity\$1pool\$1id | エンドポイントが関連付けられている Amazon Cognito ID プールの ID。 |
| package\$1name | アプリパッケージの名前 (`com.example.my_app` など)。 |
| sdk | イベントを報告するために使用された SDK に関する情報。詳細については、表「[SDK](#event-streams-data-app-attributes-application-sdk)」を参照してください。 |
| title | アプリケーションの名前。 |
| version\$1name | アプリケーションのバージョンの名前 (`V2.5` など)。 |
| version\$1code | アプリケーションのバージョン番号 (`3` など)。 |
#### SDK
イベントを報告するために使用された SDK に関する情報を含めます。
| 属性 | 説明 |
| --- | --- |
| name | イベントを報告するために使用された SDK の名前。 |
| version | SDK のバージョン。 |
### クライアント
イベントを生成したエンドポイントに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| client\$1id | エンドポイントの ID。 |
| cognito\$1id | エンドポイントに関連付けられている Amazon Cognito ID トークン。 |
### デバイス
イベントを生成したエンドポイントのデバイスに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| locale | エンドポイントのデバイスの言語とリージョンの設定に関する情報。詳細については、表「[ロケール](#event-streams-data-app-attributes-device-locale)」を参照してください。 |
| make | エンドポイントのデバイスの製造元。 |
| model | エンドポイントのデバイスのモデル識別子。 |
| platform | エンドポイントのデバイス上のオペレーティングシステムに関する情報。詳細については、表「[プラットフォーム](#event-streams-data-app-attributes-device-platform)」を参照してください。 |
#### 国
エンドポイントのデバイスの言語とリージョンの設定に関する情報を含めます。
| 属性 | 説明 |
| --- | --- |
| code | デバイスに関連付けられているロケール識別子。 |
| country | デバイスのロケールに関連付けられている国またはリージョン。 |
| language | デバイスのロケールに関連付けられている言語。 |
#### プラットフォーム
エンドポイントのデバイス上のオペレーティングシステムに関する情報を含めます。
| 属性 | 説明 |
| --- | --- |
| name | デバイス上のオペレーティングシステムの名前。 |
| version | デバイス上のオペレーティングシステムのバージョン。 |
### セッション
イベントを生成したセッションに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| session\$1id | セッションを識別する一意の ID。 |
| start\$1timestamp | セッションが開始された日時。Unix 時間 (ミリ秒単位) として表示されます。 |
| stop\$1timestamp | セッションが終了した日時。Unix 時間 (ミリ秒単位) として表示されます。 |
# Amazon Pinpoint からのキャンペーンイベントデータストリーム
Amazon Pinpoint を使用してチャンネルを介してキャンペーンを送信する場合、Amazon Pinpoint はそれらのキャンペーンに関するイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint は、セットアップ時に指定した送信先から、キャンペーンから送信した E メールまたは SMS メッセージのアプリケーションのイベントデータを取得して表示します。E メールメッセージと SMS メッセージに対して Amazon Pinpoint がストリーミングするデータの詳細については、「[Amazon Pinpoint からの E メールイベントデータストリーム](event-streams-data-email.md)」および「[Amazon Pinpoint からの SMS イベントデータストリーム](event-streams-data-sms.md)」を参照してください。イベントストリーミングを設定する方法については、「[Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する](event-streams-setup.md)」を参照してください。
## キャンペーンイベントの例
キャンペーンイベントの 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\$1type | イベントのタイプ。可能な値は以下のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-campaign.html) |
| event\$1timestamp | イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。 |
| arrival\$1timestamp | イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。 |
| event\$1version | イベントの JSON スキーマのバージョン。 イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。 |
| application | イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「[アプリケーション](#event-streams-data-campaign-attributes-application)」を参照してください。 |
| client | イベントが関連付けられているエンドポイントに関する情報。詳細については、表「[クライアント](#event-streams-data-campaign-attributes-client)」を参照してください。 |
| device | イベントを報告したデバイスに関する情報。キャンペーンメッセージとトランザクションメッセージの場合、このオブジェクトは空です。 |
| session | イベントを生成したセッションに関する情報。キャンペーンの場合、このオブジェクトは空です。 |
| attributes | イベントに関連付けられている属性。アプリケーションの 1 つによって報告されるイベントの場合、このオブジェクトにはアプリケーションによって定義されたカスタム属性を含めることができます。キャンペーンを送信したときに作成されたイベントの場合、このオブジェクトにはキャンペーンに関連付けられた属性が含まれています。トランザクションメッセージを送信するときに生成されるイベントの場合、このオブジェクトにはメッセージ自体に関連する情報が含まれます。 詳細については、表「[属性](#event-streams-data-campaign-attributes-attrs)」を参照してください。 |
| client\$1context | endpoint プロパティを格納した custom オブジェクトが含まれています。endpoint プロパティには、キャンペーンが送信されたエンドポイントのエンドポイントレコードの内容が含まれています。 |
| awsAccountId | メッセージの送信に使用された AWS アカウントの ID。 |
### アプリケーション
イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| app\$1id | イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。 |
| sdk | イベントを報告するために使用された SDK。 |
### 属性
イベントを生成したキャンペーンに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| treatment\$1id | メッセージが A/B テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。標準キャンペーンの場合、この値は `0` です。 |
| campaign\$1activity\$1id | イベントが発生したときに Amazon Pinpoint が生成する一意の ID。 |
| delivery\$1type | キャンペーンの配信方法。この属性を、`client_context` の `endpoint` プロパティで指定された `ChannelType` フィールドと混同しないでください。`ChannelType` フィールドは通常、メッセージの送信先のエンドポイントに基づいています。 1 つのエンドポイントタイプのみをサポートするチャネルの場合、`delivery_type` および `ChannelType` フィールドの値は同じになります。例えば、E メールチャネルの場合、`delivery_type` および `ChannelType` フィールドの値は同じ EMAIL になります。 ただし、カスタムチャネルなど、さまざまなエンドポイントタイプをサポートするチャネルでは、この条件は必ずしも当てはまりません。EMAIL、SMS、CUSTOM など、さまざまなエンドポイントに対してカスタムチャネルを使用できます。この場合、`delivery_type` はカスタム配信イベントの CUSTOM を特定し、`ChannelType` はキャンペーンの送信先のエンドポイントのタイプ (EMAIL、SMS、CUSTOM など) を指定します。カスタムチャンネルの作成の詳細については、「[ウェブフックまたは Lambda 関数を使用して Amazon Pinpoint でカスタムチャネルを作成する](channels-custom.md)」を参照してください。 可能な値は以下のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-campaign.html) |
| campaign\$1id | メッセージの送信元のキャンペーンの一意の ID。 |
| campaign\$1send\$1status | ターゲットエンドポイントのキャンペーンのステータスを示します。可能な値は以下のとおりです:[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-campaign.html) |
### クライアント
キャンペーンの対象となったエンドポイントに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| client\$1id | キャンペーンが送信されたエンドポイントのエンドポイント ID。 |
# Amazon Pinpoint からのジャーニーイベントデータ
ジャーニーを発行すると、Amazon Pinpoint は、ジャーニーから送信した E メール、SMS、プッシュ、カスタムメッセージのイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からデータを取得して表示します。E メールメッセージと SMS メッセージに対して Amazon Pinpoint がストリーミングするデータの詳細については、「[Amazon Pinpoint からの E メールイベントデータストリーム](event-streams-data-email.md)」および「[Amazon Pinpoint からの SMS イベントデータストリーム](event-streams-data-sms.md)」を参照してください。イベントストリーミングを設定する方法については、「[Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する](event-streams-setup.md)」を参照してください。
## ジャーニーイベントの例
ジャーニーイベントの 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\$1type | イベントのタイプ。ジャーニーイベントの場合、この属性の値は常に `_journey.send` であり、Amazon Pinpoint がジャーニーを実行したことを示します。 |
| event\$1timestamp | イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。 |
| arrival\$1timestamp | イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。 |
| event\$1version | イベントの JSON スキーマのバージョン。 イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。 |
| application | イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「[アプリケーション](#event-streams-data-journey-attributes-application)」を参照してください。 |
| client | イベントに関連付けられているエンドポイントについての情報。詳細については、表「[クライアント](#event-streams-data-journey-attributes-client)」を参照してください。 |
| device | イベントを報告したデバイスに関する情報。ジャーニーの場合、このオブジェクトは空です。 |
| session | イベントを生成したセッションに関する情報。ジャーニーの場合、このオブジェクトは空です。 |
| attributes | イベントを生成したジャーニーおよびジャーニーアクティビティに関連付けられている属性。詳細については、表「[属性](#event-streams-data-journey-attributes-attrs)」を参照してください。 |
| client\$1context | endpoint プロパティを格納した custom オブジェクトが含まれています。endpoint プロパティには、イベントに関連付けられているエンドポイントのエンドポイントレコードの内容が含まれています。 |
| awsAccountId | ジャーニーの実行に使用された AWS アカウントの ID。 |
### アプリケーション
イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| app\$1id | イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。 |
| sdk | イベントを報告するために使用された SDK。 |
### クライアント
イベントが関連付けられているエンドポイントに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| client\$1id | エンドポイントの ID。 |
### 属性
イベントを生成したジャーニーに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| journey\$1run\$1id | イベントを生成したジャーニーの一意の ID。Amazon Pinpoint はジャーニーの新しい実行ごとに自動的にこの ID を生成し、割り当てます。 |
| journey\$1send\$1status | イベントに関連付けられているメッセージの配信ステータスを示します。可能な値は以下のとおりです: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-journey.html) |
| journey\$1id | イベントを生成したジャーニーの一意の ID。 |
| journey\$1activity\$1id | イベントを生成したジャーニーアクティビティの一意の ID。 |
| journey\$1activity\$1type | イベントのジャーニーアクティビティタイプです。これは、**EMAIL**、**SMS**、**PUSH**、**CONTACT\$1CENTER**、または **CUSTOM** です。 **音声**は、サポートされているジャーニーアクティビティタイプではありません。 `journey_send_status` が **QUIET\$1TIME\$1WAIT\$1FINISHED** に設定されている場合、`journey_activity_type` フィールドは存在しません。 |
| `journey_send_status_message` | 送信イベントのステータスの説明。 |
| journey\$1send\$1status\$1code | リクエストの HTTP ステータスコード。 |
# Amazon Pinpoint からの E メールイベントデータストリーム
Amazon Pinpoint を使用して E メールを送信する場合、Amazon Pinpoint はそれらの E メールに関するイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からイベントデータを取得して表示します。イベントストリーミングを設定する方法については、「[Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する](event-streams-setup.md)」を参照してください。Amazon Pinpoint は、E メールメッセージの次のタイプのイベントに関するデータをストリーミングします。
+ 送信数
+ 配信数
+ バウンス
+ 苦情
+ 開封数
+ クリック数
+ 拒否数
+ サブスクリプション解除数
+ レンダリングの失敗
これらのイベントタイプについては、「[E メールイベント属性](#event-streams-data-email-attributes)」で詳しく説明されています。
E メールメッセージの送信に使用する API および設定によっては、追加のイベントタイプや異なるデータが表示される場合があります。例えば、Amazon Simple Email Service (Amazon SES) が提供する設定セットなど、Amazon Kinesis にイベントデータを発行する設定セットを使用してメッセージを送信する場合、データにはテンプレートのレンダリングの失敗に関するイベントが含まれることもあります。データの詳細については、『*Amazon Simple Email Service デベロッパーガイド*』の「[Amazon SES イベント発行を使用したモニタリング](https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html)」を参照してください。イベントストリーミングを設定する前に、「[Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する](event-streams-setup.md)」を参照してください。イベントストリーミングを設定するときは、イベントデータを保存する送信先を指定し、その送信先を使用してイベントデータを取得して表示できます。
## E メールイベントの例
**E メール送信**
*E メール送信*イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。
```
{
"event_type": "_email.send",
"event_timestamp": 1564618621380,
"arrival_timestamp": 1564618622025,
"event_version": "3.1",
"application": {
"app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"sdk": {}
},
"client": {
"client_id": "9a311b17-6f8e-4093-be61-4d0bbexample"
},
"device": {
"platform": {}
},
"session": {},
"attributes": {
"feedback": "received"
},
"awsAccountId": "123456789012",
"facets": {
"email_channel": {
"mail_event": {
"mail": {
"message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
"message_send_timestamp": 1564618621380,
"from_address": "sender@example.com",
"destination": ["recipient@example.com"],
"headers_truncated": false,
"headers": [{
"name": "From",
"value": "sender@example.com"
}, {
"name": "To",
"value": "recipient@example.com"
}, {
"name": "Subject",
"value": "Amazon Pinpoint Test"
}, {
"name": "MIME-Version",
"value": "1.0"
}, {
"name": "Content-Type",
"value": "multipart/alternative; boundary=\"----=_Part_314159_271828\""
}],
"common_headers": {
"from": "sender@example.com",
"to": ["recipient@example.com"],
"subject": "Amazon Pinpoint Test"
}
},
"send": {}
}
}
}
}
```
**E メール配信済み**
*E メール配信*イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。
```
{
"event_type": "_email.delivered",
"event_timestamp": 1564618621380,
"arrival_timestamp": 1564618622690,
"event_version": "3.1",
"application": {
"app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"sdk": {}
},
"client": {
"client_id": "e9a3000d-daa2-40dc-ac47-1cd34example"
},
"device": {
"platform": {}
},
"session": {},
"attributes": {
"feedback": "delivered"
},
"awsAccountId": "123456789012",
"facets": {
"email_channel": {
"mail_event": {
"mail": {
"message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
"message_send_timestamp": 1564618621380,
"from_address": "sender@example.com",
"destination": ["recipient@example.com"],
"headers_truncated": false,
"headers": [{
"name": "From",
"value": "sender@example.com"
}, {
"name": "To",
"value": "recipient@example.com"
}, {
"name": "Subject",
"value": "Amazon Pinpoint Test"
}, {
"name": "MIME-Version",
"value": "1.0"
}, {
"name": "Content-Type",
"value": "multipart/alternative; boundary=\"----=_Part_314159_271828\""
}],
"common_headers": {
"from": "sender@example.com",
"to": ["recipient@example.com"],
"subject": "Amazon Pinpoint Test"
}
},
"delivery": {
"smtp_response": "250 ok: Message 82080542 accepted",
"reporting_mta": "a8-53.smtp-out.amazonses.com",
"recipients": ["recipient@example.com"],
"processing_time_millis": 1310
}
}
}
}
}
```
**E メールクリック**
*E メールクリック*イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。
```
{
"event_type": "_email.click",
"event_timestamp": 1564618621380,
"arrival_timestamp": 1564618713751,
"event_version": "3.1",
"application": {
"app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"sdk": {}
},
"client": {
"client_id": "49c1413e-a69c-46dc-b1c4-6470eexample"
},
"device": {
"platform": {}
},
"session": {},
"attributes": {
"feedback": "https://aws.amazon.com/pinpoint/"
},
"awsAccountId": "123456789012",
"facets": {
"email_channel": {
"mail_event": {
"mail": {
"message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
"message_send_timestamp": 1564618621380,
"from_address": "sender@example.com",
"destination": ["recipient@example.com"],
"headers_truncated": false,
"headers": [{
"name": "From",
"value": "sender@example.com"
}, {
"name": "To",
"value": "recipient@example.com"
}, {
"name": "Subject",
"value": "Amazon Pinpoint Test"
}, {
"name": "MIME-Version",
"value": "1.0"
}, {
"name": "Content-Type",
"value": "multipart/alternative; boundary=\"----=_Part_314159_271828\""
}, {
"name": "Message-ID",
"value": "null"
}],
"common_headers": {
"from": "sender@example.com",
"to": ["recipient@example.com"],
"subject": "Amazon Pinpoint Test"
}
},
"click": {
"ip_address": "72.21.198.67",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.2 Safari/605.1.15",
"link": "https://aws.amazon.com/pinpoint/"
}
}
}
}
}
```
**E メール開封**
*E メール開封*イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。
```
{
"event_type": "_email.open",
"event_timestamp": 1564618621380,
"arrival_timestamp": 1564618712316,
"event_version": "3.1",
"application": {
"app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"sdk": {}
},
"client": {
"client_id": "8dc1f651-b3ec-46fc-9b67-2a050example"
},
"device": {
"platform": {}
},
"session": {},
"attributes": {
"feedback": "opened"
},
"awsAccountId": "123456789012",
"facets": {
"email_channel": {
"mail_event": {
"mail": {
"message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
"message_send_timestamp": 1564618621380,
"from_address": "sender@example.com",
"destination": ["recipient@example.com"],
"headers_truncated": false,
"headers": [{
"name": "From",
"value": "sender@example.com"
}, {
"name": "To",
"value": "recipient@example.com"
}, {
"name": "Subject",
"value": "Amazon Pinpoint Test"
}, {
"name": "MIME-Version",
"value": "1.0"
}, {
"name": "Content-Type",
"value": "multipart/alternative; boundary=\"----=_Part_314159_271828\""
}, {
"name": "Message-ID",
"value": "null"
}],
"common_headers": {
"from": "sender@example.com",
"to": ["recipient@example.com"],
"subject": "Amazon Pinpoint Test"
}
},
"open": {
"ip_address": "72.21.198.67",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko)"
}
}
}
}
}
```
## E メールイベント属性
このセクションでは、E メールメッセージの送信時に Amazon Pinpoint が生成する前の例のイベントストリームデータに含まれる属性を定義します。
| 属性 | 説明 |
| --- | --- |
| event\$1type | イベントのタイプ。可能な値は以下のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-email.html) |
| event\$1timestamp | メッセージが送信された時刻。Unix 時間（ミリ秒単位）として表示されます。この値は通常、メッセージに対して生成されるすべてのイベントで同じです。 |
| arrival\$1timestamp | イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。 |
| event\$1version | イベントの JSON スキーマのバージョン。 イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。 |
| application | イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「*アプリケーション*」を参照してください。 |
| client | イベントをレポートしたデバイスにインストールされているアプリクライアントに関する情報。詳細については、表「*クライアント*」を参照してください。 |
| device | イベントを報告したデバイスに関する情報。詳細については、表「*デバイス*」を参照してください。 E メールイベントの場合、このオブジェクトは空です。 |
| session | E メールイベントの場合、このオブジェクトは空です。 |
| attributes | イベントに関連付けられている属性。詳細については、表「*属性*」を参照してください。 アプリケーションの 1 つによって報告されるイベントの場合、このオブジェクトにはアプリケーションによって定義されたカスタム属性を含めることができます。キャンペーンまたはジャーニーからメッセージを送信するときに作成されるイベントの場合、このオブジェクトにはキャンペーンまたはジャーニーに関連付けられた属性が含まれます。トランザクションメッセージを送信するときに生成されるイベントの場合、このオブジェクトにはメッセージ自体に関連する情報が含まれます。 |
| client\$1context | E メールイベントの場合、このオブジェクトには custom 属性を格納した legacy\$1identifier オブジェクトが含まれています。legacy\$1identifier 属性の値は、メッセージの送信元のプロジェクトの ID です。 |
| facets | E メールヘッダーなど、メッセージに関する追加情報。詳細については、表「*ファセット*」を参照してください。 |
| awsAccountId | メッセージの送信に使用された AWS アカウントの ID。 |
### アプリケーション
イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| app\$1id | イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。 |
| sdk | イベントを報告するために使用された SDK。Amazon Pinpoint API を直接呼び出すか、Amazon Pinpoint コンソールを使用してトランザクション E メールメッセージを送信する場合、このオブジェクトは空です。 |
### 属性
イベントを生成したキャンペーンまたはジャーニーに関する情報が含まれています。
#### キャンペーン
イベントを生成したキャンペーンに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| feedback | `_email.click` イベントの場合、この属性の値は、受取人がイベントを生成するためにメッセージ内でクリックしたリンクの URL です。他のイベントの場合、この値はイベントタイプ (`received`、`opened`、`clicked` など) を表します。 |
| treatment\$1id | メッセージが A/B テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。標準キャンペーンおよびトランザクション E メールメッセージの場合、この値は `0` です。 |
| campaign\$1activity\$1id | イベントが発生したときに Amazon Pinpoint が生成する一意の ID。 |
| campaign\$1id | メッセージを送信したキャンペーンの一意の ID。 |
#### ジャーニー
イベントを生成したジャーニーに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| journey\$1run\$1id | メッセージを送信したジャーニーの一意の ID。Amazon Pinpoint はジャーニーの新しい実行ごとに自動的にこの ID を生成し、割り当てます。 |
| feedback | `_email.click` イベントの場合、この属性の値は、受取人がイベントを生成するためにメッセージ内でクリックしたリンクの URL です。他のイベントの場合、この値はイベントタイプ (`received`、`delivered`、`opened` など) を表します。 |
| journey\$1id | メッセージを送信したジャーニーの一意の ID。 |
| journey\$1activity\$1id | メッセージを送信したジャーニーアクティビティの一意の ID。 |
### クライアント
キャンペーンまたはジャーニーのターゲットとなったクライアントの一意の識別子。
| 属性 | 説明 |
| --- | --- |
| client\$1id | クライアントの ID。値はキャンペーンとジャーニーのエンドポイント ID で、トランザクション送信の場合は UUID です。 |
### ファセット
メッセージおよびイベントタイプに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| email\$1channel | `mail_event` オブジェクトが含まれています。このオブジェクトは、2 つのオブジェクト (`mail`、およびイベントタイプに対応するオブジェクト) を格納しています。 |
### Mail
E メールメッセージのコンテンツに関する情報と、メッセージに関するメタデータが含まれています。
| 属性 | 説明 |
| --- | --- |
| message\$1id | メッセージの ID。Amazon Pinpoint は、メッセージを受け入れる際に、このIDを自動的に生成します。 |
| message\$1send\$1timestamp | メッセージが送信された日付と時刻。[RFC 822](https://datatracker.ietf.org/doc/html/rfc822) で指定された形式で示されます。 |
| from\$1address | メッセージの送信元の E メールアドレス。 |
| destination | メッセージの送信先の E メールアドレスを含む配列。 |
| headers\$1truncated | E メールヘッダーが切り捨てられたかどうかを示すブール値。 |
| headers | メッセージのヘッダーに対応する複数の名前と値のペアを含むオブジェクト。このオブジェクトには通常、次のヘッダーに関する情報が含まれています。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-email.html) |
| common\$1headers | E メールメッセージの複数の共通ヘッダーに関する情報が含まれています。情報には、メッセージが送信された日付、メッセージの宛先、送信元、および件名が含まれます。 |
# Amazon Pinpoint からの SMS イベントデータストリーム
SMS チャンネルがプロジェクトに対して有効になっている場合、Amazon Pinpoint はプロジェクトの SMS メッセージ配信に関するイベントデータをストリーミングできます。イベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からイベントデータを取得して表示します。イベントストリーミングを設定する方法については、「[Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する](event-streams-setup.md)」を参照してください。
**注記**
通信事業者が生成した SMS イベントは、受信されるまでに最大 72 時間かかることがあるため、送信メッセージの配信に遅延があるかどうかを判断するのには使用しないでください。72 時間が経過しても、Amazon Pinpoint が通信事業者から最終イベントを受信していない場合、そのメッセージに何が起こったのか Amazon Pinpoint ではわからないため、サービスは自動的に UNKNOWN の record\$1status を返します。
## SMS イベントの例
SMS イベントの JSON オブジェクトには以下の例に示されているデータが含まれています。
```
{
"event_type": "_SMS.SUCCESS",
"event_timestamp": 1553104954322,
"arrival_timestamp": 1553104954064,
"event_version": "3.1",
"application": {
"app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"sdk": {}
},
"client": {
"client_id": "123456789012"
},
"device": {
"platform": {}
},
"session": {},
"attributes": {
"sender_request_id": "565d4425-4b3a-11e9-b0a5-example",
"campaign_activity_id": "cbcfc3c5e3bd48a8ae2b9cb41example",
"origination_phone_number": "+12065550142",
"destination_phone_number": "+14255550199",
"record_status": "DELIVERED",
"iso_country_code": "US",
"treatment_id": "0",
"number_of_message_parts": "1",
"message_id": "1111-2222-3333",
"message_type": "Transactional",
"campaign_id": "52dc44b35c4742c98c5935269example"
"customer_context": "{\"userId\":\"user-id-4\"}"
},
"metrics": {
"price_in_millicents_usd": 645.0
},
"awsAccountId": "123456789012"
}
```
## SMS イベントの属性
このセクションでは、SMS メッセージの送信時に Amazon Pinpoint が生成する前の例のイベントストリームデータに含まれる属性を定義します。
**イベント**
| 属性 | 説明 |
| --- | --- |
| event\$1type | イベントのタイプ。可能な値は以下のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-sms.html) |
| event\$1timestamp | イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。 |
| arrival\$1timestamp | イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。 |
| event\$1version | イベントの JSON スキーマのバージョン。 イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。 |
| application | イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「[アプリケーション](#event-streams-data-sms-attributes-application)」を参照してください。 |
| client | イベントをレポートしたデバイスにインストールされているアプリクライアントに関する情報。詳細については、表「[クライアント](#event-streams-data-sms-attributes-client)」を参照してください。 |
| device | イベントを報告したデバイスに関する情報。詳細については、表「[デバイス](#event-streams-data-sms-attributes-device)」を参照してください。 SMS イベントの場合、このオブジェクトは空です。 |
| session | SMS イベントの場合、このオブジェクトは空です。 |
| attributes | イベントに関連付けられている属性。アプリケーションの 1 つによって報告されるイベントの場合、このオブジェクトにはアプリケーションによって定義されたカスタム属性を含めることができます。キャンペーンを送信したときに作成されたイベントの場合、このオブジェクトにはキャンペーンに関連付けられた属性が含まれています。トランザクションメッセージを送信するときに生成されるイベントの場合、このオブジェクトにはメッセージ自体に関連する情報が含まれます。 詳細については、表「[属性](#event-streams-data-sms-attributes-attrs)」を参照してください。 |
| metrics | イベントに関連付けられている追加のメトリクス。詳細については、表「[メトリクス](#event-streams-data-sms-attributes-metrics)」を参照してください。 |
| awsAccountId | メッセージの送信に使用された AWS アカウントの ID。 |
### アプリケーション
イベントが関連付けられている Amazon Pinpoint プロジェクトと、イベントを報告するために使用された SDK（該当する場合）に関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| app\$1id | イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。 |
| sdk | イベントを報告するために使用された SDK。Amazon Pinpoint API を直接呼び出すか、Amazon Pinpoint コンソールを使用してトランザクション SMS メッセージを送信する場合、このオブジェクトは空です。 |
### 属性
イベントに関連付けられている属性に関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| sender\$1request\$1id | SMS メッセージを送信するリクエストに関連付けられている一意の ID。 |
| campaign\$1activity\$1id | キャンペーン内のアクティビティの一意の ID。 |
| origination\$1phone\$1number | メッセージの送信元の電話番号。 |
| destination\$1phone\$1number | メッセージを送信しようとした電話番号。 |
| record\$1status | メッセージのステータスに関する追加情報。可能な値は以下のとおりです: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/event-streams-data-sms.html) |
| iso\$1country\$1code | 受信者の電話番号に関連付けられている国 (ISO 3166-1 alpha-2 形式で表示)。 |
| treatment\$1id | メッセージが A/B キャンペーンで送信された場合のメッセージ処理の ID。 |
| treatment\$1id | メッセージが A/B テストキャンペーンを使用して送信された場合、この値はメッセージの処理番号を表します。トランザクション SMS メッセージの場合、この値は 0 です。 |
| number\$1of\$1message\$1parts | メッセージを送信するために Amazon Pinpoint が作成したメッセージパートの数。 通常、SMS メッセージには GSM-7 文字 160 文字または非 GSM 文字 67 文字のみを含めることができますが、これらの制限は国によって異なる場合があります。これらの制限を超えるメッセージを送信すると、Amazon Pinpoint は自動的にメッセージを小さなパートに分割します。送信したメッセージパートの数に基づいて請求されます。 |
| message\$1id | メッセージを受け入れるときに Amazon Pinpoint が生成する一意の ID。 |
| message\$1type | メッセージのタイプ。指定できる値は、**Promotional** および **Transactional**です。この値は、キャンペーンの作成時、または Amazon Pinpoint API の [SendMessages](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#SendMessages) オペレーションを使用してトランザクションメッセージを送信する際に指定します。 |
| campaign\$1id | メッセージを送信した Amazon Pinpoint キャンペーンの一意の ID。 |
| customer\$1context | Amazon Pinpoint [SendMessages](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#SendMessages) オペレーションで送信された `Context` マップの内容の JSON 文字列。 |
### クライアント
イベントをレポートしたデバイスにインストールされているアプリクライアントに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| client\$1id | アプリによって生成されたイベントの場合、この値はデバイスにインストールされたアプリクライアントの一意の ID です。この ID は、AWS Mobile SDK for iOS および AWS Mobile SDK for Android で自動的に生成されます。 キャンペーンやトランザクションメッセージの送信時に生成されるイベントの場合、この値はメッセージの送信先のエンドポイントの ID と同じです。 |
| cognito\$1id | アプリケーションが使用する Amazon Cognito ID プールのアプリクライアントに割り当てられた一意の ID。 |
### デバイス
イベントを報告したデバイスに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| locale | デバイスロケール。 |
| make | デバイスのメーカー (Apple、Samsung など)。 |
| model | デバイスモデル (iPhone など)。 |
| platform | デバイスのプラットフォーム (ios、android など)。 |
### メトリクス
イベントに関連付けられているメトリクスに関する情報が含まれています。
| 属性 | 説明 |
| --- | --- |
| price\$1in\$1millicents\$1usd | メッセージの送信に課金された金額。この価格は、米ドルセントの 1000 分の 1 で示されます。例えば、この属性の値が `645` の場合、メッセージの送信に 0.645¢ が課金されます (645 / 1000 = 0.645¢ = \$10.00645)。 このプロパティは、`event_type` が **\$1SMS.BUFFERED** のメッセージには表示されません。 |
# Amazon Pinpoint からイベントストリームを削除する
Kinesis ストリームをアプリケーションに割り当てた場合、そのアプリケーションのイベントストリーミングを無効にできます。Amazon Pinpoint は Kinesis へのイベントのストリーミングを停止しますが、Amazon Pinpoint コンソールを使用することでイベント分析を表示することができます。
## AWS CLI
[https://docs.aws.amazon.com/cli/latest/reference/pinpoint/delete-event-stream.html](https://docs.aws.amazon.com/cli/latest/reference/pinpoint/delete-event-stream.html)コマンドを使用します。
```
aws pinpoint delete-event-stream --application-id application-id
```
## AWS SDK for Java
Amazon Pinpoint クライアントの [https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/pinpoint/model/DeleteEventStreamRequest.html](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/pinpoint/model/DeleteEventStreamRequest.html) メソッドを使用します。
```
pinClient.deleteEventStream(new DeleteEventStreamRequest().withApplicationId(appId));
```