**サポート終了通知:** 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 分析データをクエリする Amazon Pinpoint コンソールの分析ページの使用に加えて、 Analytics API を使用して、ユーザーエンゲージメント、キャンペーンアウトリーチなどに関連する傾向についてのインサイトを提供する、標準メトリクスのサブセットの分析データをクエリします。*重要業績評価指標 (KPI)* とも呼ばれるこれらのメトリクスは、プロジェクト、キャンペーン、およびジャーニーのパフォーマンスを監視および評価する際に役立つ測定可能な値です。 API を使用して分析データのクエリを実行する場合、お客様が選択したレポート作成ツールを使用してデータを分析することができます。その場合、Amazon Pinpoint コンソールにサインインしたり、Amazon Kinesis Streams などのソースからの未加工のイベントデータを分析したりすることが不要になります。例えば、毎週のキャンペーン結果の表示またはキャンペーンの配信率に関する詳細分析を提供する、カスタムダッシュボードを作成することができます。 Amazon Pinpoint REST API、 AWS Command Line Interface (AWS CLI)、または AWS SDK を使用してデータをクエリできます。データのクエリは、Amazon Pinpoint API にリクエストを送信し、サポートされているパラメータを使用して、必要なデータと適用したいフィルターを指定します。クエリを送信すると、Amazon Pinpoint はクエリ結果を JSON レスポンスで返します。その後、結果を別のサービスまたはアプリケーションに渡して、より詳細な分析、保存、またはレポートを作成できます。 Amazon Pinpoint は、お客様のすべてのプロジェクト、キャンペーン、およびジャーニーにおいてサポートされているすべてのメトリクスのデータを、自動的に収集して集計します。さらに、データは継続的に更新されるため、データのレイテンシー期間は、約 2 時間に制限されています。ただし、特定のメトリクスに対して追加のデータレイテンシーが発生する場合があることに注意してください。これは、一部のメトリクスのデータが、受取人の E メールプロバイダーから受け取った情報に基づいているためです。プロバイダーによっては、この情報を直ちに当社に送信するものもあれば、あまり頻繁には送信しないものもあります。 Amazon Pinpoint は 90 日間データを保存します。90 日を超えたデータの保存や、未加工の分析データへのリアルタイムのアクセスは、イベントデータを Amazon Kinesis Data Streams または Amazon Data Firehose にストリーミングするように、Amazon Pinpoint プロジェクトを設定することで可能となります。イベントストリームの設定方法については、「[Amazon Pinpoint を使用して Kinesis と Firehose を介してアプリイベントデータをストリーミングする](event-streams.md)」を参照してください。 ## Amazon Pinpoint のメトリクスのコンポーネントとパラメータをクエリする メトリクスのデータのクエリを実行するには、Amazon Pinpoint API の適切なメトリクスリソースに `get` リクエストを送信します。リクエストでは、次のクエリコンポーネントでサポートされているパラメータを使用して、クエリを定義します。 + **Project** – `application-id` パラメータの値としてプロジェクト ID を入力して、プロジェクトを指定します。このパラメータは、すべてのメトリクスに必須です。 + **Campaign** – `campaign-id` パラメータの値としてキャンペーン ID を入力して、キャンペーンを指定します。このパラメータは、キャンペーンメトリクスにのみ必要です。 + **Journey** – `journey-id` パラメータの値としてジャーニー ID を指定して、ジャーニーを指定します。このパラメータは、ジャーニーのエンゲージメントと実行メトリクス、およびジャーニーアクティビティ実行メトリクスにのみ必要です。 + **Journey activity** – `journey-activity-id` パラメータの値としてジャーニーアクティビティ ID を指定して、ジャーニーアクティビティを指定します。このパラメータは、ジャーニーアクティビティ実行メトリクスにのみ必要です。 + **Date range** – データを日付範囲でフィルタリングするには、サポートされている開始時刻と終了時刻パラメータを使用して、日付範囲の最初と最後の日時を指定します。値は拡張 ISO 8601 形式で、協定世界時（UTC）を使用する必要があります (例：`2019-07-19T20:00:00Z` は、2019年7月19日午後8時 (UTC) )。 日付範囲は包括的であり、31 日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを返します。日付範囲パラメータは、ジャーニー実行メトリクスおよびジャーニーアクティビティ実行メトリクスを除くすべてのメトリクスでサポートされます。 + **Metric** – `kpi-name` パラメータの値としてメトリクス名を提供することで、メトリクスを指定します。この値は、関連するメトリクスを記述し、ハイフンで区切られた小文字の英数字で構成される 2 つ以上の用語で構成されます。例は、`email-open-rate` および `successful-delivery-rate` です。このパラメータは、ジャーニー実行メトリクスおよびジャーニーアクティビティ実行メトリクスを除くすべてのメトリクスに必要です。サポートされているすべてのメトリクスと各メトリクスに使用する `kpi-name` 値については、「[プロジェクト、キャンペーン、ジャーニーの標準メトリクス](analytics-standard-metrics.md)」を参照してください。 クエリを送信すると、Amazon Pinpoint はクエリ結果を JSON レスポンスで返します。レスポンスにおける結果の構造は、クエリしたメトリクスによって異なります。 一部のメトリクスでは、例えばキャンペーンによって配信されたメッセージ数など、1 つの値 — のみが提供されます。その他のメトリクスは、関連するフィールド — によってグループ化された複数の値を提供します。例えば、キャンペーンの実行ごとに配信されたメッセージ数で、キャンペーンの実行ごとグループ化されたものなどが含まれます。メトリクスが複数の値を提供し、グループ化する場合、JSON レスポンスにはデータのグループ化に使用されたフィールドを示すためのフィールドが含まれます。クエリ結果の構造の詳細については、「[JSON クエリ結果を使用する](analytics-query-results.md)」を参照してください。 # Amazon Pinpoint 分析データのクエリ実行用の IAM ポリシー Amazon Pinpoint API を使用して、標準メトリクスのサブセットの分析データをクエリできます。*重要業績評価指標標 (KPI)* Amazon Pinpoint プロジェクト、キャンペーン、およびジャーニーに適用されます。標準メトリクスは、プロジェクト、キャンペーン、およびジャーニーのパフォーマンスを監視および評価する際に役立ちます。 このデータへのアクセスを管理するには、データへのアクセスが許可されている IAM ロールまたはユーザーのアクセス許可を定義する AWS Identity and Access Management (IAM) ポリシーを作成できます。データアクセス時の管理をきめ細かくサポートできるように、Amazon Pinpoint には、IAM ポリシーで指定できる個別のアクションが提供されています。Amazon Pinpoint コンソールで分析データを表示するための特定のアクションが Amazon Pinpoint コンソール (`mobiletargeting:GetReports`) に提供されています。Amazon Pinpoint API を使用して、プログラムにより分析データにアクセスするためのアクションも提供されています。 分析データへのアクセスを管理する IAM ポリシーを作成するには、 AWS マネジメントコンソール、 AWS CLI、または IAM API を使用できます。なお、 AWS マネジメントコンソール の [**Visual editor**] タブには、現在 Amazon Pinpoint の分析データを表示したり、問い合わせたりするためのアクションは含まれていません。ただし、コンソールの [**JSON**] タブを使用して、必要なアクションを IAM ポリシーに手動で追加できます。 たとえば、次のポリシーでは、すべての AWS リージョンのすべてのプロジェクト、キャンペーン、ジャーニーのすべての分析データへのプログラムによるアクセスを許可します。 ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "QueryAllAnalytics", "Effect": "Allow", "Action": [ "mobiletargeting:GetApplicationDateRangeKpi", "mobiletargeting:GetCampaignDateRangeKpi", "mobiletargeting:GetJourneyDateRangeKpi", "mobiletargeting:GetJourneyExecutionMetrics", "mobiletargeting:GetJourneyExecutionActivityMetrics" ], "Resource": [ "arn:aws:mobiletargeting:*:111122223333:apps/*/kpis/*", "arn:aws:mobiletargeting:*:111122223333:apps/*/campaigns/*/kpis/*", "arn:aws:mobiletargeting:*:111122223333:apps/*/journeys/*/kpis/*", "arn:aws:mobiletargeting:*:111122223333:apps/*/journeys/*/execution-metrics", "arn:aws:mobiletargeting:*:111122223333:apps/*/journeys/*/activities/*/execution-metrics" ] } ] } ``` ------ *accountId* は AWS アカウント ID です。 ただしベストプラクティスとして、*最小特権*の原則に準拠したポリシーを作成してください。別の言い方をすると、特定タスクの実行にのみ必要とされる権限のみが含まれたポリシーを作成してください。このプラクティスをサポートし、より詳細な制御を実装するために、特定の AWS リージョン内の特定のプロジェクトのみの分析データへのプログラムによるアクセスを制限できます。次に例を示します。 ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "QueryProjectAnalytics", "Effect": "Allow", "Action": [ "mobiletargeting:GetApplicationDateRangeKpi", "mobiletargeting:GetCampaignDateRangeKpi", "mobiletargeting:GetJourneyDateRangeKpi", "mobiletargeting:GetJourneyExecutionMetrics", "mobiletargeting:GetJourneyExecutionActivityMetrics" ], "Resource": [ "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/kpis/*", "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/campaigns/*/kpis/*", "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/*/kpis/*", "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/*/execution-metrics", "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/*/activities/*/execution-metrics" ] } ] } ``` ------ コードの説明は以下のとおりです。 + *region* は、プロジェクトをホストする AWS リージョンの名前です。 + *accountId* は AWS アカウント ID です。 + *projectId* は、アクセス権限を提供したいプロジェクトの識別子です。 同様に、次のポリシーの例は、特定のキャンペーンの分析データにのみ、プログラムによるアクセスを許可します。 ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "QueryCampaignAnalytics", "Effect": "Allow", "Action": "mobiletargeting:GetCampaignDateRangeKpi", "Resource": "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/campaigns/campaignId/kpis/*" } ] } ``` ------ コードの説明は以下のとおりです。 + *region* は、プロジェクトをホストする AWS リージョンの名前です。 + *accountId* は AWS アカウント ID です。 + *projectId* は、キャンペーンに関連付けられているプロジェクトの識別子です。 + *campaignId* は、アクセス権限を提供したいキャンペーンの識別子です。 また、次のポリシー例では、特定のジャーニーとそのジャーニーを構成するアクティビティについて、エンゲージメントデータと実行データの両方のすべての分析データへのプログラムによるアクセスを許可します。 ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "QueryJourneyAnalytics", "Effect": "Allow", "Action": [ "mobiletargeting:GetJourneyDateRangeKpi", "mobiletargeting:GetJourneyExecutionMetrics", "mobiletargeting:GetJourneyExecutionActivityMetrics" ], "Resource": [ "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/journeyId/kpis/*", "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/journeyId/execution-metrics", "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/journeyId/activities/*/execution-metrics" ] } ] } ``` ------ コードの説明は以下のとおりです。 + *region* は、プロジェクトをホストする AWS リージョンの名前です。 + *accountId* は AWS アカウント ID です。 + *projectId* は、ジャーニーに関連付けられているプロジェクトの識別子です。 + *journeyId* は、アクセス権限を提供したいジャーニーの識別子です。 IAM ポリシーで使用できる Amazon Pinpoint API アクションの全リストについては、[IAM ポリシーの Amazon Pinpointアクション](permissions-actions.md) をご参照ください。IAM ポリシーの作成と管理の詳細については、『[IAM ユーザーガイド](https://docs.aws.amazon.com/IAM/latest/UserGuide/)』をご参照ください。 # Amazon Pinpoint プロジェクト、キャンペーン、ジャーニーに適用される標準メトリクス Amazon Pinpoint Analytics API を使用して、Amazon Pinpoint プロジェクト、キャンペーン、およびジャーニーに適用される標準メトリクスのサブセットの分析データをクエリできます。これらのメトリクスは、*主要業績評価指標 (KPI)* とも呼ばれ、プロジェクト、キャンペーン、およびジャーニーの成果を監視および評価するのに役立つ測定可能な値です。 Amazon Pinpoint では、次の数種類の標準メトリクスの分析データに、プログラムによりアクセスすることができます。 + **アプリケーションメトリクス** – これらのメトリクスは、*アプリケーション*とも呼ばれる、プロジェクトと関連付けられているすべてのキャンペーンおよびトランザクションメッセージの傾向についてのインサイトを提供します。例えば、アプリケーションメトリクスを使用して、プロジェクトに関連付けられている各キャンペーンについて受信者によって開かれたメッセージの数の内訳を入手できます。 + **キャンペーンメトリクス** – これらのメトリクスは、個々のキャンペーンのパフォーマンスについてのインサイトを提供します。例えば、キャンペーンメトリクスを使用して、キャンペーンメッセージが送信されたエンドポイントの数、またはエンドポイントに配信されたメッセージの数を特定できます。 + **ジャーニーエンゲージメントメトリクス** – これらのメトリクスは、個々のジャーニーのパフォーマンスに関するインサイトを提供します。例えば、ジャーニーのエンゲージメントメトリクスを使用して、ジャーニーの各アクティビティで参加者が開封したメッセージ数の内訳を取得できます。 + **ジャーニー実行メトリクス** – これらのメトリクスは、個々のジャーニーの参加傾向に関するインサイトを提供します。例えば、ジャーニー実行メトリクスを使用して、ジャーニーを開始した参加者の数を判断できます。 + **ジャーニーアクティビティ実行メトリクス** – これらのメトリクスは、ジャーニーにおける個々のアクティビティの参加傾向についてのインサイトを提供します。例えば、ジャーニーアクティビティ実行メトリクスを使用して、アクティビティを開始した参加者数と、アクティビティの各パスを完了した参加者数を判断できます。 このセクションのトピックでは、メトリクスのタイプごとにクエリを実行できる個々のメトリクスをリストし、説明します。 **Topics** + [キャンペーンの Amazon Pinpoint アプリケーションメトリクス](application-metrics-campaigns.md) + [トランザクション E メールメッセージの Amazon Pinpoint アプリケーションメトリクス](application-metrics-txn-email.md) + [トランザクション SMS メッセージの Amazon Pinpoint アプリケーションメトリクス](application-metrics-txn-sms.md) + [Amazon Pinpoint キャンペーンメトリクス](campaign-metrics.md) + [Amazon Pinpoint ジャーニーエンゲージメントメトリクス](journey-metrics-engagement-email.md) + [Amazon Pinpoint ジャーニー実行メトリクス](journey-metrics-execution.md) + [Amazon Pinpoint ジャーニーアクティビティ実行メトリクス](journey-metrics-activity-execution.md) + [Amazon Pinpoint ジャーニーおよびキャンペーンの実行メトリクス](journey-run-metrics-activity-execution.md) # キャンペーンの Amazon Pinpoint アプリケーションメトリクス 次の表に、Amazon Pinpoint プロジェクトに関連付けられているすべてのキャンペーンのパフォーマンスを評価するためにクエリできる標準アプリケーションメトリクスのリストと説明を示します。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[アプリケーションメトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html)リソースを使用します。表の **kpi-name** 列は、クエリの `kpi-name` パラメータに使用する値を示しています。 | メトリクス | Kpi-name | 説明 | | --- | --- | --- | | 配信率 | `successful-delivery-rate` | プロジェクトに関連付けられているすべてのキャンペーンで、受信者に配信されたメッセージの割合。 このメトリクスは、プロジェクトのすべてのキャンペーンによって送信され、受信者に配信されたメッセージ数を、それらすべてのキャンペーンによって送信されたメッセージ数で割ったものとして計算されます。 | | 日付別にグループ化された配信率 | `successful-delivery-rate-grouped-by-date` | プロジェクトに関連付けられているすべてのキャンペーンについて、指定された日付範囲内で毎日、受信者に配信されたメッセージの割合。 このメトリクスは、プロジェクトのすべてのキャンペーンによって送信され、受信者に配信されたメッセージの数を、指定された日付範囲内の日ごとのそれらのすべてのキャンペーンによって送信されたメッセージの数で割ったものとして計算されます。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | E メールのオープン率 | `email-open-rate` | プロジェクトに関連付けられているすべてのキャンペーンについて、受信者によって開かれた E メールメッセージの割合。 このメトリクスは、プロジェクトのすべてのキャンペーンによって送信され、受信者に配信された E メールメッセージの数を、それらすべてのキャンペーンによって送信された E メールメッセージの数で割ったものとして計算されます。 | | キャンペーンでグループ化された E メールのオープン率 | `email-open-rate-grouped-by-campaign` | プロジェクトに関連付けられている各キャンペーンについて、受信者によって開かれた E メールメッセージの割合。 このメトリクスは、プロジェクトのすべてのキャンペーンによって送信され、受信者によって開かれた E メールメッセージの数を、キャンペーンによって送信され、受信者に配信された E メールメッセージの数で割ったものとして計算されます。 このメトリクスのクエリ結果はキャンペーン ID (`CampaignId`) でグループ化されますが、これはキャンペーンを一意に識別する文字列です。 | | エンドポイントの配信 | `unique-deliveries` | プロジェクトに関連付けられているすべてのキャンペーンについて、メッセージが配信された一意のエンドポイントの数。 | | キャンペーンでグループ化された配信エンドポイント | `unique-deliveries-grouped-by-campaign` | プロジェクトに関連付けられている各キャンペーンについて、メッセージが配信された一意のエンドポイントの数 このメトリクスのクエリ結果はキャンペーン ID (`CampaignId`) でグループ化されますが、これはキャンペーンを一意に識別する文字列です。 | | 日付別にグループ化されたされた配信エンドポイント | `unique-deliveries-grouped-by-date` | プロジェクトに関連付けられているすべてのキャンペーンについて、指定された日付範囲の各日にメッセージが配信された一意のエンドポイントの数。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | キャンペーンでグループ化された配信されたメッセージ | `successful-deliveries-grouped-by-campaign` | プロジェクトに関連付けられている各キャンペーンについて、受信者受信者に配信されたメッセージの数。 このメトリクスは、キャンペーンによって送信されたメッセージの数から、キャンペーンによって送信され、ハードバウンスのために受信者に配信できなかったメッセージの数を引いたものとして計算されます。 このメトリクスのクエリ結果はキャンペーン ID (`CampaignId`) でグループ化されますが、これはキャンペーンを一意に識別する文字列です。 | | プッシュオープン率 | `push-open-rate` | プロジェクトに関連付けられているすべてのキャンペーンについて、受信者によって開かれたプッシュ通知の割合です。 このメトリクスは、プロジェクトのすべてのキャンペーンによって送信され、受信者によって開かれたプッシュ通知の数を、それらすべてのキャンペーンによって送信され、受信者に配信されたプッシュ通知の数で割ったものとして計算されます。 | | キャンペーンでグループ化されたプッシュオープン率 | `push-open-rate-grouped-by-campaign` | プロジェクトに関連付けられている各キャンペーンについて、受信者によって開かれたプッシュ通知の割合です。 このメトリクスは、キャンペーンによって送信され、受信者によって開かれたプッシュ通知の数を、キャンペーンによって送信され、受信者に配信されたプッシュ通知の数で割ったものとして計算されます。 このメトリクスのクエリ結果はキャンペーン ID (`CampaignId`) でグループ化されますが、これはキャンペーンを一意に識別する文字列です。 | # トランザクション E メールメッセージの Amazon Pinpoint アプリケーションメトリクス 次の表に、Amazon Pinpoint プロジェクトに関連付けられているすべてのトランザクション E メールメッセージの傾向をモニタリングするためにクエリできる標準アプリケーションメトリクスのリストと説明を示します。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[アプリケーションメトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html)リソースを使用します。表の **kpi-name** 列は、クエリの `kpi-name` パラメータに使用する値を示しています。 これらのメトリクスは、キャンペーンによって送信された E メールメッセージに関するデータを提供しないことに注意してください。トランザクション E メールメッセージに関するデータのみを提供します。1 つ以上のキャンペーンによって送信されたメッセージのデータをクエリするには、キャンペーンの[キャンペーンメトリクス](campaign-metrics.md)または[アプリケーションメトリクス](application-metrics-campaigns.md)を使用します。 | メトリクス | Kpi-name | 説明 | | --- | --- | --- | | クリック数 | `txn-emails-clicked` | 受信者がメッセージのリンクをクリックした回数。1 人の受信者がメッセージ内の複数のリンクをクリックするか、同じリンクを複数回クリックした場合は、それぞれのクリックはカウントされます。 | | 日付別にグループ化されたクリック数 | `txn-emails-clicked-grouped-by-date` | 指定された日付範囲の各日に受信者がメッセージのリンクをクリックした回数。1 人の受信者がメッセージ内の複数のリンクをクリックするか、同じリンクを複数回クリックした場合は、それぞれのクリックはカウントされます。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | Complaint rate | `txn-emails-complaint-rate` | 受信者によって未承諾または不要な E メールとして報告されたメッセージの割合。 このメトリクスは、受信者によって未承諾または不要な E メールとして報告されたメッセージの数を、送信されたメッセージ数で除算して計算されます。 | | 日付別にグループ化された苦情率 | `txn-emails-complaint-rate-grouped-by-date` | 指定された日付範囲の各日に受信者によって未承諾または不要な E メールとして報告されたメッセージの割合。 このメトリクスは、指定された日付範囲の各日に受信者によって未承諾または不要な E メールとして報告されたメッセージの数を、送信されたメッセージ数で除算して計算されます。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 苦情 | `txn-emails-with-complaints` | 受信者によって未承諾または不要な E メールとして報告されたメッセージの数。 | | 日付別にグループ化された苦情 | `txn-emails-with-complaints-grouped-by-date` | 受信者によって未承諾または不要な E メールとして報告されたメッセージのうち、指定した日付範囲の各日の数。このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 配信数 | `txn-emails-delivered` | 受信者に配信されたメッセージの数。 このメトリクスは、送信されたメッセージ数から、ソフトバウンス、ハードバウンス、または拒否されたために配信できなかったメッセージの数を引いた数として計算されます。Amazon Pinpoint がメッセージにマルウェアが含まれていると判断した場合、メッセージは拒否されます。Amazon Pinpoint は、拒否されたメッセージを送信しません。 | | 日付別にグループ化された配信数 | `txn-emails-delivered-grouped-by-date` | 指定された日付範囲の各日に受信者に配信されたメッセージの数。 このメトリクスは、指定された日付範囲の各日に、送信されたメッセージの数から、ソフトバウンス、ハードバウンス、または拒否されたために配信できなかったメッセージの数を引いた数として計算されます。Amazon Pinpoint がメッセージにマルウェアが含まれていると判断した場合、メッセージは拒否されます。Amazon Pinpoint は、拒否されたメッセージを送信しません。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 配信率 | `txn-emails-delivery-rate` | 受信者に配信されたメッセージの割合。 このメトリクスは、受信者に配信されたメッセージの数を、送信されたメッセージの数で割ったものとして計算されます。 | | 日付別にグループ化された配信率 | `txn-emails-delivery-rate-grouped-by-date` | 指定された日付範囲の各日に受信者に配信されたメッセージの割合。 このメトリクスは、受信者に配信されたメッセージの数を、送信されたメッセージの数で割ったものとして計算されます。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | ハードバウンス | `txn-emails-hard-bounced` | ハードバウンスのために受信者に配信できなかったメッセージの数。ハードバウンスは、永続的な問題によってメッセージが配信されない場合に発生します。例えば、受信者の E メールアドレスが存在しない場合などに発生します。 | | 日付別にグループ化されたハードバウンス | `txn-emails-hard-bounced-grouped-by-date` | 指定された日付範囲の各日に、ハードバウンスのために受信者に配信できなかったメッセージの数。ハードバウンスは、永続的な問題によってメッセージが配信されない場合に発生します。例えば、受信者の E メールアドレスが存在しない場合などに発生します。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 開封数 | `txn-emails-opened` | 受信者によって開封されたメッセージの数。 | | 日付別にグループ化された開封数 | `txn-emails-opened-grouped-by-date` | 指定された日付範囲の各日に、受信者によって開封されたメッセージの数。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 送信数 | `txn-emails-sent` | 送信されたメッセージの数。 | | 日付別にグループ化された送信数 | `txn-emails-sent-grouped-by-date` | 指定された日付範囲の各日に送信されたメッセージの数。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | ソフトバウンス | `txn-emails-soft-bounced` | ソフトバウンスのために受信者に配信できなかったメッセージの数。ソフトバウンスは、一時的な問題によってメッセージが配信されない場合に発生します。例えば、受信者の受信トレイが満杯である場合や受信サーバーが一時的に使用できない場合などに発生します。 | | 日付別にグループ化されたソフトバウンス | `txn-emails-soft-bounced-grouped-by-date` | 指定された日付範囲の各日に、ソフトバウンスのために受信者に配信できなかったメッセージの数。ソフトバウンスは、一時的な問題によってメッセージが配信されない場合に発生します。例えば、受信者の受信トレイが満杯である場合や受信サーバーが一時的に使用できない場合などに発生します。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 一意のユーザークリックイベント | `txn-emails-unique-clicks` | メッセージ内のリンクをクリックした一意の受信者 (エンドポイント) の数。 [**クリック数**] メトリクスとは異なり、このメトリクスは発生したクリックイベントの数ではなく、リンクをクリックした一意の受信者の数を報告します。例えば、1 人の受信者が同じメッセージ内の複数のリンクをクリックした場合や、同じリンクを複数回クリックした場合、このメトリクスはその受信者に対して 1 つのクリックイベントのみを報告します。 | | 日付別にグループ化された一意のユーザークリックイベント | `txn-emails-unique-clicks-grouped-by-date` | 指定した日付範囲の各日にメッセージ内のリンクをクリックした一意の受信者 (エンドポイント) の数。 [**日付別にグループ化されたクリック数**] とは異なり、このメトリクスは、発生したクリックイベントの数ではなく、リンクをクリックした一意の受信者の数を報告します。例えば、1 人の受信者が同じメッセージ内の複数のリンクをクリックした場合や、同じリンクを複数回クリックした場合、このメトリクスはその受信者に対して 1 つのクリックイベントのみを報告します。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 一意のユーザー開封イベント | `txn-emails-unique-opens` | メッセージを開いた一意の受信者 (エンドポイント) の数。 [**開封**] メトリクスとは異なり、このメトリクスは発生した開封イベントの数ではなく、メッセージを開封した一意の受信者の数を報告します。例えば、1 人の受信者が同じメッセージを複数回開封した場合、このメトリクスはその受信者の開封イベントを 1 つだけ報告します。 | | 日付別にグループ化された一意のユーザー開封イベント | `txn-emails-unique-opens-grouped-by-date` | 指定した日付範囲の各日にメッセージを開封した一意の受信者 (エンドポイント) の数。 [**日付別にグループ化された開封**] メトリクスとは異なり、このメトリクスは発生した開封イベントの数ではなく、メッセージを開封した一意の受信者の数を報告します。例えば、1 人の受信者が同じメッセージを複数回開封した場合、このメトリクスはその受信者の開封イベントを 1 つだけ報告します。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | # トランザクション SMS メッセージの Amazon Pinpoint アプリケーションメトリクス 次の表に、Amazon Pinpoint プロジェクトに関連付けられているすべてのトランザクション SMS メッセージの傾向をモニタリングするためにクエリできる標準アプリケーションメトリクスのリストと説明を示します。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[アプリケーションメトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html)リソースを使用します。表の **kpi-name** 列は、クエリの `kpi-name` パラメータに使用する値を示しています。 これらのメトリクスは、キャンペーンによって送信された SMS メッセージに関するデータは提供しないことに注意してください。トランザクション SMS メッセージに関するデータのみを提供します。1 つ以上のキャンペーンによって送信されたメッセージのデータをクエリするには、キャンペーンの[キャンペーンメトリクス](campaign-metrics.md)または[アプリケーションメトリクス](application-metrics-campaigns.md)を使用します。 | メトリクス | Kpi-name | 説明 | | --- | --- | --- | | 国別にグループ化された平均価格 | `txn-sms-average-price-grouped-by-country` | 各メッセージの送信先の国または地域ごとのメッセージ送信の平均コスト。価格は、米国セントの 1000 分の 1 で示されます。例えば、この属性の値が 645 の場合、メッセージの送信に 0.645¢ が課金されます (645 / 1000 = 0.645¢ = 0.00645 USD)。 このメトリクスは、各国または地域の受信者に送信されたすべてのメッセージの合計コストを、それぞれの国および地域の受信者に送信されたメッセージ数で割って計算されます。 このメトリクスのクエリ結果は、国または地域ごとに ISO 3166-1 alpha-2 形式でグループ化されます。 | | 国別にグループ化されたメッセージパートあたりの平均価格 | `txn-sms-average-price-by-parts-grouped-by-country` | 各メッセージの送信先の国または地域ごとのメッセージパート送信の平均コスト。メッセージ部分は SMS メッセージの一部です。価格は、米国セントの 1000 分の 1 で示されます。例えば、この属性の値が 645 の場合、メッセージの送信に 0.645¢ が課金されます (645 / 1000 = 0.645¢ = 0.00645 USD)。 このメトリクスは、各国または地域の受信者に送信されたすべてのメッセージパートの合計コストを、それぞれの国および地域の受信者に送信されたメッセージ数で割って計算されます。 このメトリクスのクエリ結果は、国または地域ごとに ISO 3166-1 alpha-2 形式でグループ化されます。 | | 配信数 | `txn-sms-delivered` | 受信者に配信されたメッセージの数。 | | 国別にグループ化された配信数 | `txn-sms-delivered-grouped-by-country` | メッセージの送信先の国または地域ごとに、受信者に配信されたメッセージの数。 このメトリクスのクエリ結果は、国または地域ごとに ISO 3166-1 alpha-2 形式でグループ化されます。 | | 日付別にグループ化された配信数 | `txn-sms-delivered-grouped-by-date` | 指定された日付範囲の各日に受信者に配信されたメッセージの数。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 配信エラー数 | `txn-sms-error-distribution` | 発生したエラーのタイプごとに、メッセージの配信中にエラーが発生した回数。 このメトリクスのクエリ結果は、発生したエラーのタイプごとにエラーコードごとにグループ化されます。 | | 配信率 | `txn-sms-delivery-rate` | 受信者に配信されたメッセージの割合。 このメトリクスは、受信者に配信されたメッセージの数を、送信されたメッセージの数で割ったものとして計算されます。 | | 日付別にグループ化された配信率 | `txn-sms-delivery-rate-grouped-by-date` | 指定された日付範囲の各日に受信者に配信されたメッセージの割合。 このメトリクスは、受信者に配信されたメッセージの数を、送信されたメッセージの数で割ったものとして計算されます。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 配信されたメッセージパート | `txn-sms-delivered-by-parts` | 参加者に配信されたメッセージパートの数。*メッセージパート*は、SMS メッセージの一部です。SMS のメッセージに使われている文字数が SMS プロトコルで許可されている文字数を超える場合、Amazon Pinpoint は送信可能な文字数でメッセージを分割し、受信者にメッセージを送信します。 | | 国別にグループ化された配信されたメッセージパート | `txn-sms-delivered-by-parts-grouped-by-country` | メッセージの送信先の国または地域ごとに、受信者に配信されたメッセージパートの数。*メッセージパート*は、SMS メッセージの一部です。 このメトリクスのクエリ結果は、国または地域ごとに ISO 3166-1 alpha-2 形式でグループ化されます。 | | 送信されたメッセージパート | `txn-sms-sent-by-parts` | 送信されたメッセージパートの数。*メッセージパート*は、SMS メッセージの一部です。SMS のメッセージに使われている文字数が SMS プロトコルで許可されている文字数を超える場合、Amazon Pinpoint は送信可能な文字数でメッセージを分割し、受信者にメッセージを送信します。 | | 国別にグループ化された送信済みメッセージパート | `txn-sms-sent-by-parts-grouped-by-country` | メッセージの送信先の国または地域ごとに、送信されたメッセージパートの数。*メッセージパート*は、SMS メッセージの一部です。 このメトリクスのクエリ結果は、国または地域ごとに ISO 3166-1 alpha-2 形式でグループ化されます。 | | 送信されたメッセージ | `txn-sms-sent` | 送信されたメッセージの数。 | | 国別にグループ化された送信済みメッセージ | `txn-sms-sent-grouped-by-country` | メッセージの送信先の国または地域ごとに、送信されたメッセージの数。 このメトリクスのクエリ結果は、国または地域ごとに ISO 3166-1 alpha-2 形式でグループ化されます。 | | 日付別にグループ化された送信済みメッセージ | `txn-sms-sent-grouped-by-date` | 指定された日付範囲の各日に送信されたメッセージの数。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | 国別にグループ化された合計価格 | `txn-sms-total-price-grouped-by-country` | メッセージの送信先の国または地域ごとのメッセージ送信の合計コスト。価格は、米国セントの 1000 分の 1 で示されます。例えば、この属性の値が 645 の場合、メッセージの送信に 0.645¢ が課金されます (645 / 1000 = 0.645¢ = 0.00645 USD)。 このメトリクスのクエリ結果は、国または地域ごとに ISO 3166-1 alpha-2 形式でグループ化されます。 | # Amazon Pinpoint キャンペーンメトリクス 次の表に、個々のキャンペーンのパフォーマンスを評価するためにクエリできる標準的なキャンペーンメトリクスのリストと説明を示します。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[キャンペーンメトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html)のリソースを使用います。表の **kpi-name** 列は、クエリの `kpi-name` パラメータに使用する値を示しています。 | メトリクス | Kpi-name | 説明 | | --- | --- | --- | | バウンス率 | `hard-bounce-rate` | すべてのキャンペーンの実行において、受信者に配信できなかった E メールメッセージの割合。このメトリクスでは、ハードバウンスのみ計測されます。つまり、受信者の E メールアドレスに、メッセージを配信できない永続的な問題があるメッセージを指します。 このメトリクスは、すべてのキャンペーンの実行によって送信され、バウンスされた E メールメッセージの数を、それらすべてのキャンペーンの実行によって送信された E メールメッセージの数で割ったものとして計算されます。 | | キャンペーンの実行によってグループ化されたバウンス率 | `hard-bounce-rate-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者に配信できなかった E メールメッセージの割合。このメトリクスでは、ハードバウンスのみ計測されます。つまり、受信者の E メールアドレスに、メッセージを配信できない永続的な問題があるメッセージを指します。 このメトリクスは、キャンペーンの実行によって送信され、バウンスされた E メールメッセージの数を、キャンペーンの実行によって送信された E メールメッセージの数で割ったものとして計算されます。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | 配信率 | `successful-delivery-rate` | すべてのキャンペーンの実行において、受信者に配信されたメッセージの割合。 このメトリクスは、すべてのキャンペーンの実行によって送信され、受信者に配信されたメッセージの数を、それらすべてのキャンペーンの実行によって送信されたメッセージの数で割ったものとして計算されます。 | | キャンペーンの実行によってグループ化された配信率 | `successful-delivery-rate-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者に配信されたメッセージの割合。 このメトリクスは、キャンペーンの実行によって送信され、受信者に配信されたメッセージの数を、それらすべてのキャンペーンの実行によって送信されたメッセージの数で割ったものとして計算されます。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | 日付別にグループ化された配信率 | `successful-delivery-rate-grouped-by-date` | すべてのキャンペーンの実行について、指定された日付範囲の各日中に受信者に配信されたメッセージの割合。 このメトリクスは、すべてのキャンペーンの実行によって送信され、受信者に配信されたメッセージの数を、指定された日付範囲の日ごとのそれらのすべてのキャンペーンによって送信されたメッセージの数で割ったものとして計算されます。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | E メールのオープン率 | `email-open-rate` | すべてのキャンペーンの実行において、受信者によって開かれた E メールメッセージの割合。このメトリクスは、すべてのキャンペーンの実行によって送信され、受信者によって開かれた E メールメッセージの数を、それらすべてのキャンペーンの実行によって送信され、受信者に配信された E メールメッセージの数で割ったものとして計算されます。 | | キャンペーンの実行によってグループ化された E メールのオープン率 | `email-open-rate-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者によって開かれた E メールメッセージの割合。 このメトリクスは、キャンペーンの実行によって送信され、受信者によって開かれた E メールメッセージの数を、キャンペーンの実行によって送信され、受信者に配信された E メールメッセージの数で割ったものとして計算されます。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | キャンペーンの実行によってグループ化され、開かれた E メール | `direct-email-opens-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者によって開かれた E メールメッセージの数 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | エンドポイントの配信 | `unique-deliveries` | すべてのキャンペーンの実行において、メッセージが配信された一意のエンドポイントの数。 | | キャンペーンの実行によってグループ化されたエンドポイント配信 | `unique-deliveries-grouped-by-campaign-activity` | 各キャンペーンの実行において、メッセージが配信された一意のエンドポイントの数。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | 日付別にグループ化されたされた配信エンドポイント | `unique-deliveries-grouped-by-date` | すべてのキャンペーンの実行について、指定された日付範囲の各日にメッセージが配信された一意のエンドポイントの数。 このメトリクスのクエリの結果は、拡張 ISO 8601 形式で、暦日ごとにグループ化されています。 | | キャンペーンの実行によってグループ化され、クリックされたリンク | `clicks-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者がE メールメッセージ内のリンクをクリックした回数。1 人の受信者がメッセージ内の複数のリンクをクリックするか、同じリンクを複数回クリックした場合は、それぞれのクリックはカウントされます。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | キャンペーンの実行によってグループ化され、配信されたメッセージ | `successful-deliveries-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者に配信されたメッセージの数。 このメトリクスは、キャンペーンによって送信されたメッセージの数を、キャンペーンの実行によって送信されたメッセージの数から、キャンペーンによって送信され、ハードバウンスのために実行の受信者に配信できなかったメッセージの数を引いたものとして計算されます。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | キャンペーンの実行によってグループ化され、送信されたメッセージ | `attempted-deliveries-grouped-by-campaign-activity` | 各キャンペーンの実行において、送信されたメッセージの数。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | プッシュオープン率 | `push-open-rate` | すべてのキャンペーンの実行において、受信者によって開かれたプッシュ通知の割合。 このメトリクスは、すべてのキャンペーンの実行によって送信され、受信者によって開かれたプッシュ通知の数を、それらすべてのキャンペーンの実行によって送信され、受信者に配信されたプッシュ通知の数で割ったものとして計算されます。 | | キャンペーンの実行によってグループ化されたプッシュオープン率 | `push-open-rate-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者によって開かれたプッシュ通知の割合。 このメトリクスは、キャンペーンの実行によって送信され、受信者によって開かれたプッシュ通知の数を、キャンペーンの実行によって送信され、受信者に配信されたプッシュ通知の数で割ったものとして計算されます。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | キャンペーンの実行によってグループ化され、開かれたプッシュの合計 | `direct-push-opens-grouped-by-campaign-activity` | 各キャンペーンの実行において、受信者によって開かれたプッシュ通知の数。 このメトリクスのクエリ結果はキャンペーン アクティビティ ID (`CampaignActivityId`) でグループ化されますが、これはキャンペーンの実行を一意に識別する文字列です。 | | SMS 使用量の合計 | sms-spend | すべてのキャンペーンで送信された SMS の合計金額 (ミリセント)。 | # Amazon Pinpoint ジャーニーエンゲージメントメトリクス 次の表は、ジャーニーによって送信されたすべての E メールメッセージの傾向を監視するためにクエリを実行できる標準的な Amazon Pinpoint ジャーニーのエンゲージメントメトリクスの一覧と説明です。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[ジャーニーエンゲージメントメトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-kpis-daterange-kpi-name.html)のリソースを使用います。表の **kpi-name** 列は、クエリの `kpi-name` パラメータに使用する値を示しています。 | メトリクス | Kpi-name | 説明 | | --- | --- | --- | | クリック数 | `journey-emails-clicked` | 参加者がメッセージのリンクをクリックした回数。1 人の参加者がメッセージ内の複数のリンクをクリックするか、同じリンクを複数回クリックした場合は、それぞれのクリックはカウントされます。 | | アクティビティ別にグループ化されたクリック数 | `emails-clicked-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、参加者がメッセージ内のリンクをクリックした回数。1 人の参加者がメッセージ内の複数のリンクをクリックするか、同じリンクを複数回クリックした場合は、それぞれのクリックはカウントされます。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | 苦情 | `journey-emails-complained` | 参加者によって未承諾または不要な E メールとして報告されたメッセージの数。 | | アクティビティ別にグループ化された苦情 | `emails-complained-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、参加者が未承諾または不要なメールとして報告されたメッセージの数。このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | 配信数 | `journey-emails-delivered` | 参加者に配信されたメッセージの数。 このメトリクスは、送信されたメッセージ数から、ソフトバウンス、ハードバウンス、または拒否されたために配信できなかったメッセージの数を引いた数として計算されます。 | | アクティビティ別にグループ化された配信数 | `emails-delivered-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、参加者に配信されたメッセージの数。 このメトリクスは、ジャーニーの各アクティビティに、送信されたメッセージの数から、ソフトバウンス、ハードバウンス、または拒否されたために配信できなかったメッセージの数を引いた数として計算されます。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | ハードバウンス | `journey-emails-hardbounced` | ハードバウンスのために参加者に配信できなかったメッセージの数。ハードバウンスは、永続的な問題によってメッセージが配信されない場合に発生します。例えば、参加者の E メールアドレスが存在しない場合などに発生します。 | | アクティビティ別にグループ化されたハードバウンス数 | `emails-hardbounced-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、ハードバウンスのために参加者に配信できなかったメッセージの数。ハードバウンスは、永続的な問題によってメッセージが配信されない場合に発生します。例えば、参加者の E メールアドレスが存在しない場合などに発生します。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | 開封数 | `journey-emails-opened` | 参加者によって開封されたメッセージの数。 | | アクティビティ別にグループ化された開封数 | `emails-opened-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、参加者によって開封されたメッセージの数。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | 拒否数 | `journey-emails-rejected` | 参加者が拒否されたために参加者に送信されなかったメッセージの数。Amazon Pinpoint がメッセージにマルウェアが含まれていると判断した場合、メッセージは拒否されます。Amazon Pinpoint は、拒否されたメッセージを送信しません。 | | アクティビティ別にグループ化された拒否数 | `emails-rejected-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、拒否されたために参加者に送信されなかったメッセージの数。Amazon Pinpoint がメッセージにマルウェアが含まれていると判断した場合、メッセージは拒否されます。Amazon Pinpoint は、拒否されたメッセージを送信しません。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | 送信数 | `journey-emails-sent` | 送信されたメッセージの数。 | | アクティビティ別にグループ化された送信数 | `emails-sent-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、送信されたメッセージの数。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | ソフトバウンス | `journey-emails-softbounced` | ソフトバウンスのために参加者に配信できなかったメッセージの数。ソフトバウンスは、一時的な問題によってメッセージが配信されない場合に発生します。例えば、参加者の受信トレイが満杯である場合や受信サーバーが一時的に使用できない場合などに発生します。 | | アクティビティ別にグループ化されたソフトバウンス数 | `emails-softbounced-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、ソフトバウンスのために参加者に配信できなかったメッセージの数。ソフトバウンスは、一時的な問題によってメッセージが配信されない場合に発生します。例えば、参加者の受信トレイが満杯である場合や受信サーバーが一時的に使用できない場合などに発生します。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | | サブスクリプション解除数 | `journey-emails-unsubscribed` | 参加者がメッセージ内のサブスクリプション解除リンクをクリックした回数。1 人の参加者が同じサブスクリプション解除リンクを複数回クリックした場合、各クリックはカウントに含まれます。 | | アクティビティ別にグループ化されたサブスクリプション解除数 | `emails-unsubscribed-grouped-by-journey-activity` | ジャーニーの各アクティビティについて、参加者がメッセージ内のサブスクリプション解除リンクをクリックした回数。1 人の参加者が同じサブスクリプション解除リンクを複数回クリックした場合、各クリックはカウントに含まれます。 このメトリクスのクエリ結果は、アクティビティ ID (`JourneyActivityId`) でグループ化されますが、これはアクティビティを一意に識別する文字列です。 | # Amazon Pinpoint ジャーニー実行メトリクス 次の表に、Amazon Pinpoint ジャーニー参加者のステータスを評価するためにクエリできる標準的な実行メトリクスのリストと説明を示します。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[ジャーニー実行メトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-execution-metrics.html)のリソースを使用います。テーブルの [**フィールド**] 列には、各メトリクスのクエリ結果に表示されるフィールドの名前が表示されます。 | メトリクス | フィールド | 説明 | | --- | --- | --- | | アクティブな参加者 | `ENDPOINT_ACTIVE` | ジャーニーのアクティビティを積極的に進めている参加者の数。 このメトリクスは、ジャーニーを開始した参加者数から、ジャーニーを離れた参加者数およびジャーニーから削除された参加者数を引いたものとして計算されます。 | | 参加者のキャンセル | `CANCELLED` | ジャーニーがキャンセルされたためにジャーニーを完了しなかった参加者の数。 | | 参加者の出発 | `ENDPOINT_LEFT` | ジャーニーを離れた参加者の数。 | | 参加者のエントリ | `ENDPOINT_ENTERED` | ジャーニーを開始した参加者の数。 | | 参加者の例外、再エントリ制限 | `REENTRY_CAP_EXCEEDED` | 1 人の参加者がジャーニーに再エントリすることができる最大回数を超えたため、ジャーニーを完了しなかった参加者の数。 | | 参加者の例外、拒否 | `ACTIVE_ENDPOINT_REJECTED` | ジャーニーのすでにアクティブな参加者であるため、そのジャーニーを開始できない参加者の数。 参加者がジャーニーを開始し、その後、お客様がセグメント（セグメント条件に基づく）またはジャーニー（アクティビティ条件に基づく）に参加者を含めるように、参加者のエンドポイント定義を更新した場合、参加者は拒否されます。 | # Amazon Pinpoint ジャーニーアクティビティ実行メトリクス 次の表に、Amazon Pinpoint ジャーニーの個々のアクティビティのタイプごとの参加者のステータスを評価するためにクエリできる標準的な実行メトリクスのリストと説明を示します。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[ジャーニーアクティビティ実行メトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-activities-journey-activity-id-execution-metrics.html)のリソースを使用います。表の**メトリクス**列には、アクティビティのタイプごとにクエリ結果に表示されるフィールドが一覧表示されます。また、各フィールドの簡単な説明も示します。 | アクティビティタイプ | メトリクス | | --- | --- | | はい/いいえ分割 (`CONDITIONAL_SPLIT`) | メトリクスは次のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) パスごとにアクティビティに追加のメトリクスを使用できます。これらのメトリクスについては、このテーブルのそのタイプのアクティビティの行を参照してください。 | | ホールドアウト (`HOLDOUT`) | メトリクスは次のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) | | E メール (`MESSAGE`) | メトリクスは次のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) | | 多変量分割 (`MULTI_CONDITIONAL_SPLIT`) | アクティビティのパス別に、そのパスのアクティビティに進んだ参加者の数。 このメトリクスのクエリ結果は、パス `Branch_#` でグループ化されます。*\$1* はパスの数値識別子です。例えば、アクティビティの最初のパスは `Branch_1` です。 パスごとにアクティビティに追加のメトリクスを使用できます。これらのメトリクスについては、このテーブルのそのタイプのアクティビティの行を参照してください。 | | ランダム分割 (`RANDOM_SPLIT`) | アクティビティのパス別に、そのパスのアクティビティに進んだ参加者の数。 このメトリクスのクエリ結果は、パス `Branch_#` でグループ化されます。*\$1* はパスの数値識別子です。例えば、アクティビティの最初のパスは `Branch_1` です。 パスごとにアクティビティに追加のメトリクスを使用できます。これらのメトリクスについては、このテーブルのそのタイプのアクティビティの行を参照してください。 | | 待機 (`WAIT`) | メトリクスは次のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) | | コンタクトセンター (`CONTACT_CENTER`) | メトリクスは次のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) | # Amazon Pinpoint ジャーニーおよびキャンペーンの実行メトリクス Amazon Pinpoint ジャーニーまたはキャンペーンの個々のアクティビティのタイプごとに参加者のステータスを評価するために、標準的な実行メトリクスをクエリできます。これらのメトリクスのデータをクエリするには、Amazon Pinpoint API の[ジャーニーアクティビティの実行メトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-runs-run-id-activities-journey-activity-id-execution-metrics.html)または[キャンペーンメトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html)のリソースを使用します。次の表は、アクティビティのタイプごとにクエリ結果に表示されるフィールドを示しています。 **** | メトリクス名 | ジャーニー、キャンペーン、またはその両方に適用 | 説明 | | --- | --- | --- | | ENDPOINT\$1PRODUCED | [Both] (両方) | フィルタリング前にセグメントまたはイベントから最初に生成されたエンドポイントの数。 | | ENDPOINTS\$1FROM\$1USER | [Both] (両方) | カスタマーがユーザー ID のみのセグメントを持っている場合は、そのユーザーのすべてのエンドポイントが追加されます。このメトリクスでは、この方法で追加されたエンドポイントの数が測定されます。 | | ENDPOINT\$1OPT\$1OUT | [Both] (両方) | エンドポイントはオプトアウトされており、キャンペーンやジャーニーにエントリしませんでした。 | | ENDPOINT\$1INACTIVE | [Both] (両方) | エンドポイントは非アクティブになっており、キャンペーンやジャーニーにエントリしませんでした。 | | FILTERED\$1OUT\$1BY\$1SEGMENT | [Both] (両方) | エンドポイントはセグメントフィルターに一致しておらず、キャンペーンやジャーニーにエントリしませんでした。 | | ENDPOINT\$1MISSING\$1ADDRESS | [Both] (両方) | エンドポイントに住所が見当たらず、キャンペーンやジャーニーにエントリしませんでした。 | | ENDPOINT\$1MISSING\$1CHANNEL | [Both] (両方) | エンドポイントにチャネルが見当たらず、キャンペーンやジャーニーにエントリしませんでした。 | | ENDPOINT\$1MISSING\$1TIMEZONE | [Both] (両方) | エンドポイントにタイムゾーンの値が見当たらず、除外されました。これはタイムゾーンの値が必要な場合にのみ発生します。 | | ENDPOINT\$1TIMEZONE\$1MISMATCH | [Both] (両方) | エンドポイントは、その時点で実行対象に含まれていなかったタイムゾーンにありました。 | | ENDPOINT\$1CHANNEL\$1MISMATCH | キャンペーン | キャンペーンには、このエンドポイントのチャネルタイプ用のメッセージが設定されていません。 | | DUPLICATE\$1ENDPOINT | [Both] (両方) | 重複するエンドポイントが見つかり、重複除外されました。 | | DUPLICATE\$1USER | [Both] (両方) | 重複するユーザーが見つかり、ユーザー ID のみのセグメントから重複除外されました。ユーザー ID が同じ場合、メトリクス 1 が出力されます。 | | PAUSED | Journeys | ジャーニーが一時停止されたため、実行対象から削除されました。 | | ENDED | Journeys | ジャーニーが終了したため、実行対象から削除されました。 | | TREATMENT\$1HOLDOUT | キャンペーン | これは、コホートが現在の処理と一致しないエンドポイントについて、A/B キャンペーンで出力されます。例えば、A/B を 50/50 に分割した場合、エンドポイントの 50% が各処理でこのメトリクスを出力します。 | | ENDPOINT\$1ESTIMATED\$1TIMEZONE | Journeys | タイムゾーン推定により、エンドポイントのタイムゾーンを推定できました。 | # Amazon Pinpoint 分析キャンペーンデータをクエリする Amazon Pinpoint コンソールの分析ページを使用することに加えて、Amazon Pinpoint 分析 API を使用して、キャンペーンの配信とエンゲージメントの傾向についてのインサイトを提供する標準メトリクスのサブセットについて分析データをクエリできます。 これらの各メトリクスは測定可能な値で、*重要業績評価指標 (KPI)* とも呼ばれ、1 つ以上のキャンペーンのパフォーマンスを監視および評価するのに役立ちます。例えば、メトリクスを使用して、キャンペーンメッセージが送信されたエンドポイントの数、または目的のエンドポイントに配信されたメッセージの数を確認できます。 Amazon Pinpoint は、すべてのキャンペーンでこのデータを自動的に収集し、集計します。これは、90 日間データを保存します。 AWS Mobile SDK を使用してモバイルアプリを Amazon Pinpoint と統合した場合、Amazon Pinpoint はこのサポートを拡張して、受信者によって開かれたプッシュ通知の割合などの追加のメトリクスを含めます。モバイルアプリケーションの統合については、「[Amazon Pinpoint とアプリケーションを統合する](integrate.md)」を参照してください Amazon Pinpoint 分析 API を使用してデータをクエリする場合、クエリの範囲、データ、グループ化、フィルターを定義するさまざまなオプションを選択できます。これを行うには、適用する日付ベースのフィルターに加えて、クエリするプロジェクト、キャンペーン、メトリクスを指定するパラメータを使用します。 このトピックでは、これらのオプションを選択し、1 つ以上のキャンペーンのデータをクエリする方法の例を説明します。 ## 前提条件 1 つ以上のキャンペーンの分析データをクエリする前に、クエリの定義に使用する、次の情報を収集すると役立ちます。 + **Project ID** – 1 つまたは複数のキャンペーンに関連付けられたプロジェクトの一意な ID。Amazon Pinpoint API では、この値は `application-id` プロパティに保存されます。Amazon Pinpoint コンソールでは、この値は**プロジェクト ID** で**すべてのプロジェクト**ページで表示されます。 + **Campaign ID** – キャンペーンの一意の識別子（1 つのキャンペーンのデータのみをクエリする場合）。Amazon Pinpoint API では、この値は `campaign-id` プロパティに保存されます。この値は、コンソールには表示されません。 + **Date range** – オプションで、データを問い合せる日付範囲の最初と最後の日付と時刻。日付範囲は包括的であり、31日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを自動的にクエリします。 + **Metric type** – クエリするメトリクスのタイプ。*アプリケーションメトリクス*と*キャンペーンメトリクス* の 2 つのタイプがあります。*アプリケーションメトリクス*は、プロジェクトに関連付けられているすべてのキャンペーンのデータを提供し、*アプリケーション*とも呼ばれます。*キャンペーンメトリクス*は、1 つのキャンペーンのみのデータを提供します。 + **Metric** – クエリするメトリクスの名前。具体的には、メトリクスの `kpi-name` 値。サポートされているメトリクスの完全なリストと各メトリクスの `kpi-name` 値については、「[プロジェクト、キャンペーン、ジャーニーの標準メトリクス](analytics-standard-metrics.md)」を参照してください。 また、関連するフィールドでデータをグループ化するかどうかを決定することもできます。する場合、データを自動的にグループ化するように設計されたメトリクスを選択することで、分析とレポート作成を簡素化できます。例えば、Amazon Pinpoint には、キャンペーンの受信者に配信されたメッセージの割合を報告する標準メトリクスがいくつか用意されています。これらのメトリクスの 1 つは、データを日付ごとに自動的にグループ化します (`successful-delivery-rate-grouped-by-date`)。別のメトリクスでは、データがキャンペーンの実行ごとに自動的にグループ化されます (`successful-delivery-rate-grouped-by-campaign-activity`)。3 番目のメトリクスは、すべてのキャンペーンの実行によって受信者に配信されたメッセージの割合 (%) を返します (`successful-delivery-rate`)。 必要な方法でデータをグループ化する標準メトリクスが見つからない場合は、必要なデータを返す一連のクエリを開発できます。その後、クエリ結果を手動で分類したり、デザインするカスタムグループに結合できます。 最後に、クエリするデータにアクセスする権限があることを確認することが重要です。詳細については、「[Amazon Pinpoint 分析データのクエリ実行用の IAM ポリシー](analytics-permissions.md)」を参照してください。 # 1 つのキャンペーンの Amazon Pinpoint データをクエリする 1 つのキャンペーンのデータをクエリするには、[Campaign Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html) API を使用して、次の必須パラメータに値を指定します。 + **application-id** – キャンペーンに関連付けられているプロジェクトの一意の識別子であるプロジェクト ID。Amazon Pinpoint では、*プロジェクト*と*アプリケーション*という用語は同じ意味です。 + **campaign-id** – キャンペーンの一意の識別子。 + **kpi-name** – クエリするメトリクスの名前。この値は、関連するメトリクスを記述し、ハイフンで区切られた小文字の英数字で構成される 2 つ以上の用語で構成されます。サポートされているメトリクスの完全なリストと各メトリクスの `kpi-name` 値については、「[プロジェクト、キャンペーン、ジャーニーの標準メトリクス](analytics-standard-metrics.md)」を参照してください。 また、特定の日付範囲のデータをクエリするフィルターを適用することもできます。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを返します。異なる日付でデータをフィルタリングするには、サポートされている日付範囲パラメータを使用して、日付範囲の最初と最後の日時を指定します。値は拡張 ISO 8601 形式で、協定世界時（UTC）を使用する必要があります (例: `2019-07-19T20:00:00Z` は、2019年7月19日午後8時 (UTC) )。日付範囲は包括的であり、31 日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。 次の例は、Amazon Pinpoint REST API、、および を使用して AWS CLIキャンペーンの分析データをクエリする方法を示しています AWS SDK for Java。サポートされている AWS SDK を使用して、キャンペーンの分析データをクエリできます。 AWS CLI 例は Microsoft Windows 用にフォーマットされています。Unix、Linux、macOS の場合は、キャレット (^) 行継続文字をバックスラッシュ (\$1) に置き換えます。 ------ #### [ REST API ] Amazon Pinpoint REST API を使用してキャンペーンの分析データをクエリするには、HTTP (S) GET リクエストを [Campaign Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html) URI に送信します。URI で、必要なパスパラメータに次の適切な値を指定します。 ``` https://endpoint/v1/apps/application-id/campaigns/campaign-id/kpis/daterange/kpi-name ``` 各パラメータの意味は次のとおりです。 + *endpoint* は、キャンペーンに関連付けられたプロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + *application-id* は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + *campaign-id* は、キャンペーンの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 すべてのパラメータは、URL エンコードする必要があります。 特定の日付範囲のデータをクエリするフィルターを適用するには、URI に `start-time` および `end-time` クエリパラメータと値を追加します。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。パラメータを区切るには、アンパサンド (&) を使用します。 例えば、次のリクエストは、2019 年 7 月 19 日から 2019 年 7 月 26 日まで、キャンペーンのすべての実行によってメッセージが配信された一意のエンドポイントの数を取得します。 ``` https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/campaigns/80b8efd84042ff8d9c96ce2f8example/kpis/daterange/unique-deliveries?start-time=2019-07-19T00:00:00Z&end-time=2019-07-26T23:59:59Z ``` コードの説明は以下のとおりです。 + `pinpoint.us-east-1.amazonaws.com` は、プロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + `1234567890123456789012345example` は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + `80b8efd84042ff8d9c96ce2f8example` は、キャンペーンの一意の識別子です。 + `unique-deliveries`は、*エンドポイントの配信*キャンペーンメトリクスの `kpi-name` 値です。これは、キャンペーンのすべての実行によって、メッセージが配信されたユニークなエンドポイントの数を報告するメトリックです。 + `2019-07-19T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-07-26T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ AWS CLI ] を使用してキャンペーンの分析データをクエリするには AWS CLI、 **get-campaign-date-range-kpi** コマンドを使用して、必要なパラメータに適切な値を指定します。 ``` C:\> aws pinpoint get-campaign-date-range-kpi ^ --application-id application-id ^ --campaign-id campaign-id ^ --kpi-name kpi-name ``` コードの説明は以下のとおりです。 + *application-id* は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + *campaign-id* は、キャンペーンの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータをクエリするフィルターを適用するには、`start-time` および `end-time` パラメータと値をクエリに追加します。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 7 月 19 日から 2019 年 7 月 26 日まで、キャンペーンのすべての実行によってメッセージが配信された一意のエンドポイントの数を取得します。 ``` C:\> aws pinpoint get-campaign-date-range-kpi ^ --application-id 1234567890123456789012345example ^ --campaign-id 80b8efd84042ff8d9c96ce2f8example ^ --kpi-name unique-deliveries ^ --start-time 2019-07-19T00:00:00Z ^ --end-time 2019-07-26T23:59:59Z ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + `80b8efd84042ff8d9c96ce2f8example` は、キャンペーンの一意の識別子です。 + `unique-deliveries`は、*エンドポイントの配信*キャンペーンメトリクスの `kpi-name` 値です。これは、キャンペーンのすべての実行によって、メッセージが配信されたユニークなエンドポイントの数を報告するメトリックです。 + `2019-07-19T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-07-26T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ SDK for Java ] を使用してキャンペーンの分析データをクエリするには AWS SDK for Java、[Campaign Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html) API の **GetCampaignDateRangeKpiRequest**メソッドを使用します。必要なパラメータに適切な値を指定します。 ``` GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest() .withApplicationId("applicationId") .withCampaignId("campaignId") .withKpiName("kpiName") ``` コードの説明は以下のとおりです。 + *applicationId* は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + *campaignId* は、キャンペーンの一意の識別子です。 + *kpiName* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータをクエリするフィルターを適用するには、`startTime` および `endTime` パラメータと値をクエリに含めます。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 7 月 19 日から 2019 年 7 月 26 日まで、キャンペーンのすべての実行によってメッセージが配信された一意のエンドポイントの数を取得します。 ``` GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest() .withApplicationId("1234567890123456789012345example") .withCampaignId("80b8efd84042ff8d9c96ce2f8example") .withKpiName("unique-deliveries") .withStartTime(Date.from(Instant.parse("2019-07-19T00:00:00Z"))) .withEndTime(Date.from(Instant.parse("2019-07-26T23:59:59Z"))); ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + `80b8efd84042ff8d9c96ce2f8example` は、キャンペーンの一意の識別子です。 + `unique-deliveries`は、*エンドポイントの配信*キャンペーンメトリクスの `kpi-name` 値です。これは、キャンペーンのすべての実行によって、メッセージが配信されたユニークなエンドポイントの数を報告するメトリックです。 + `2019-07-19T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-07-26T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ クエリを送信すると、Amazon Pinpoint はクエリ結果を JSON レスポンスで返します。結果の構造は、クエリしたメトリクスによって異なります。一部のメトリクスは 1 つの値しか返しません。例えば、前述の例で使用された*エンドポイント配信* (`unique-deliveries`) キャンペーンメトリックは、すべてのキャンペーンの実行により、1 つの値 (メッセージが配信されたユニークエンドポイントの数) を返します。この場合、JSON レスポンスは次のようになります。 ``` { "CampaignDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "CampaignId":"80b8efd84042ff8d9c96ce2f8example", "EndTime":"2019-07-26T23:59:59Z", "KpiName":"unique-deliveries", "KpiResult":{ "Rows":[ { "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"123.0" } ] } ] }, "StartTime":"2019-07-19T00:00:00Z" } } ``` 他のメトリクスは複数の値を返し、関連するフィールドで値をグループ化します。メトリクスが複数の値を返す場合、JSON レスポンスにはデータのグループ化に使用されたフィールドを示すフィールドが含まれます。 クエリ結果の構造の詳細については、「[JSON クエリ結果を使用する](analytics-query-results.md)」を参照してください。 # 複数のキャンペーンの Amazon Pinpoint データをクエリする 複数のキャンペーンのデータをクエリする方法は 2 つあります。最適な方法は、すべて同じプロジェクトに関連付けられているキャンペーンのデータをクエリするかどうかによって異なります。その場合は、すべてのキャンペーンのデータに対してクエリを実行するか、それらのキャンペーンのみまたはサブセットのどちらに対してクエリを実行するかによっても異なります。 異なるプロジェクトに関連付けられているキャンペーン、または同じプロジェクトに関連付けられているキャンペーンのサブセットのみのデータをクエリするには、データをクエリするキャンペーンごとに 1 つずつ、一連の個別のクエリを作成して実行するのが最善の方法です。前のセクションでは、1 つのキャンペーンのデータをクエリする方法について説明しています。 同じプロジェクトに関連付けられているすべてのキャンペーンのデータをクエリするには、[アプリケーションメトリクス](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) API を使用します。以下の必須のパラメータの値を指定します。 + **application-id** – プロジェクトの一意の識別子であるプロジェクト ID。Amazon Pinpoint では、*プロジェクト*と*アプリケーション*という用語は同じ意味です。 + **kpi-name** – クエリするメトリクスの名前。この値は、関連するメトリクスを記述し、ハイフンで区切られた小文字の英数字で構成される 2 つ以上の用語で構成されます。サポートされているメトリクスの完全なリストと各メトリクスの `kpi-name` 値については、「[プロジェクト、キャンペーン、ジャーニーの標準メトリクス](analytics-standard-metrics.md)」を参照してください。 日付範囲でデータをフィルタリングすることもできます。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを返します。異なる日付でデータをフィルタリングするには、サポートされている日付範囲パラメータを使用して、日付範囲の最初と最後の日時を指定します。値は拡張 ISO 8601 形式で、協定世界時（UTC）を使用する必要があります (例: `2019-07-19T20:00:00Z` は、2019年7月19日午後8時 (UTC) )。日付範囲は包括的であり、31 日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。 次の例は、Amazon Pinpoint REST API、、および を使用して AWS CLIキャンペーンの分析データをクエリする方法を示しています AWS SDK for Java。サポートされている AWS SDK を使用して、キャンペーンの分析データをクエリできます。 AWS CLI 例は Microsoft Windows 用にフォーマットされています。Unix、Linux、macOS の場合は、キャレット (^) 行継続文字をバックスラッシュ (\$1) に置き換えます。 ------ #### [ REST API ] Amazon Pinpoint REST API を使用して複数のキャンペーンの分析データをクエリするには、HTTP(S) GET リクエストを [Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) URI に送信します。URI で、必要なパスパラメータに次の適切な値を指定します。 ``` https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name ``` 各パラメータの意味は次のとおりです。 + *endpoint* は、キャンペーンに関連付けられたプロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + *application-id* は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 すべてのパラメータは、URL エンコードする必要があります。 特定の日付範囲のデータを取得するフィルターを適用するには、URI に `start-time` および `end-time` クエリパラメータと値を追加します。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。パラメータを区切るには、アンパサンド (&) を使用します。 例えば、次のリクエストは、2019 年 7 月 19 日から 2019 年 7 月 26 日まで、プロジェクトの各キャンペーンによってメッセージが配信された一意のエンドポイントの数を取得します。 ``` https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/unique-deliveries-grouped-by-campaign?start-time=2019-07-19T00:00:00Z&end-time=2019-07-26T23:59:59Z ``` コードの説明は以下のとおりです。 + `pinpoint.us-east-1.amazonaws.com` は、プロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + `1234567890123456789012345example` は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + `unique-deliveries-grouped-by-campaign` は、*エンドポイント配信の `kpi-name` 値で、キャンペーンごとの*アプリケーションメトリック (メッセージが配信されたユニークエンドポイントの数を返すメトリック) ごとにグループ化されています。 + `2019-07-19T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-07-26T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ AWS CLI ] を使用して複数のキャンペーンの分析データをクエリするには AWS CLI、 **get-application-date-range-kpi** コマンドを使用して、必要なパラメータに適切な値を指定します。 ``` C:\> aws pinpoint get-application-date-range-kpi ^ --application-id application-id ^ --kpi-name kpi-name ``` コードの説明は以下のとおりです。 + *application-id* は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータを取得するフィルターを適用するには、`start-time` および `end-time` パラメータと値をクエリに含めます。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 7 月 19 日から 2019 年 7 月 26 日まで、プロジェクトの各キャンペーンによってメッセージが配信された一意のエンドポイントの数を取得します。 ``` C:\> aws pinpoint get-application-date-range-kpi ^ --application-id 1234567890123456789012345example ^ --kpi-name unique-deliveries-grouped-by-campaign ^ --start-time 2019-07-19T00:00:00Z ^ --end-time 2019-07-26T23:59:59Z ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + `unique-deliveries-grouped-by-campaign` は、*エンドポイント配信の `kpi-name` 値で、キャンペーンごとの*アプリケーションメトリック (メッセージが配信されたユニークエンドポイントの数を返すメトリック) ごとにグループ化されています。 + `2019-07-19T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-07-26T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ SDK for Java ] を使用して複数のキャンペーンの分析データをクエリするには AWS SDK for Java、[Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) API の **GetApplicationDateRangeKpiRequest**メソッドを使用します。必要なパラメータに適切な値を指定します。 ``` GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest() .withApplicationId("applicationId") .withKpiName("kpiName") ``` コードの説明は以下のとおりです。 + *applicationId* は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + *kpiName* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータを取得するフィルターを適用するには、`startTime` および `endTime` パラメータと値をクエリに含めます。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 7 月 19 日から 2019 年 7 月 26 日まで、プロジェクトの各キャンペーンによってメッセージが配信された一意のエンドポイントの数を取得します。 ``` GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest() .withApplicationId("1234567890123456789012345example") .withKpiName("unique-deliveries-grouped-by-campaign") .withStartTime(Date.from(Instant.parse("2019-07-19T00:00:00Z"))) .withEndTime(Date.from(Instant.parse("2019-07-26T23:59:59Z"))); ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、キャンペーンに関連付けられているプロジェクトの一意の識別子です。 + `unique-deliveries-grouped-by-campaign` は、*エンドポイント配信の `kpi-name` 値で、キャンペーンごとの*アプリケーションメトリック (メッセージが配信されたユニークエンドポイントの数を返すメトリック) ごとにグループ化されています。 + `2019-07-19T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-07-26T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ クエリを送信すると、Amazon Pinpoint はクエリ結果を JSON レスポンスで返します。結果の構造は、クエリしたメトリクスによって異なります。一部のメトリクスは 1 つの値しか返しません。その他のメトリクスは複数の値を返し、それらの値は関連するフィールドによってグループ化されます。メトリクスが複数の値を返す場合、JSON レスポンスにはデータのグループ化に使用されたフィールドを示すフィールドが含まれます。 例えば、前述の例で使用されている*キャンペーンごとにグループ化されたエンドポイント配信* (`unique-deliveries-grouped-by-campaign`) アプリケーションメトリックは、プロジェクトに関連付けられた各キャンペーンについて、複数の値 (メッセージが配信されたユニークなエンドポイントの数) を返します。この場合、JSON レスポンスは次のようになります。 ``` { "ApplicationDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "EndTime":"2019-07-26T23:59:59Z", "KpiName":"unique-deliveries-grouped-by-campaign", "KpiResult":{ "Rows":[ { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"80b8efd84042ff8d9c96ce2f8example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"123.0" } ] }, { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"810c7aab86d42fb2b56c8c966example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"456.0" } ] }, { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"42d8c7eb0990a57ba1d5476a3example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"789.0" } ] } ] }, "StartTime":"2019-07-19T00:00:00Z" } } ``` この場合、`GroupedBys` フィールドは値がキャンペーン ID (`CampaignId`) でグループ化されていることを示しています。 クエリ結果の構造の詳細については、「[JSON クエリ結果を使用する](analytics-query-results.md)」を参照してください。 # トランザクションメッセージの Amazon Pinpoint 分析データをクエリする Amazon Pinpoint コンソールの分析ページを使用することに加えて、Amazon Pinpoint Analytics API を使用して、プロジェクトに送信されたトランザクションメッセージの配信とエンゲージメントの傾向についてのインサイトを提供する標準メトリクスのサブセットについて分析データをクエリできます。 メトリクスは測定可能な値で、*重要業績評価指標 (KPI)* とも呼ばれ、トランザクションメッセージのパフォーマンスを監視および評価するのに役立ちます。例えば、メトリクスを使用して、送信した E メールのトランザクション数、送信した SMS メッセージ数、または受取人に配信されたメッセージ数を調べることができます。Amazon Pinpoint は、プロジェクトに送信するすべての E メールのトランザクションおよび SMS メッセージについて、このデータを自動的に収集し、集計します。これは、90 日間データを保存します。 Amazon Pinpoint 分析 API を使用してデータをクエリする場合、クエリの範囲、データ、グループ化、フィルターを定義するさまざまなオプションを選択できます。これを行うには、適用する日付ベースのフィルターに加えて、クエリするプロジェクトとメトリクスを指定するパラメータを使用します。 このトピックでは、これらのオプションを選択し、プロジェクトに関するトランザクションメッセージングデータをクエリする方法の例を説明します。 ## 前提条件 トランザクションメッセージの分析データをクエリする前に、クエリの定義に使用する、次の情報を収集すると役立ちます。 + **Project ID** – メッセージの送信元のプロジェクトの一意の識別子。Amazon Pinpoint API では、この値は `application-id` プロパティに保存されます。Amazon Pinpoint コンソールでは、この値は** すべてのプロジェクト** ページで**Project ID** として表示されます。 + **Date range** – オプションで、データを問い合せる日付範囲の最初と最後の日付と時刻。日付範囲は包括的であり、31日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを自動的にクエリします。 + **Metric** – クエリするメトリクスの名前。具体的には、メトリクスの `kpi-name` 値。サポートされているメトリクスの完全なリストと各メトリクスの `kpi-name` 値については、「[プロジェクト、キャンペーン、ジャーニーの標準メトリクス](analytics-standard-metrics.md)」を参照してください。 また、関連するフィールドでデータをグループ化するかどうかを決定することもできます。する場合、データを自動的にグループ化するように設計されたメトリクスを選択することで、分析とレポート作成を簡素化できます。例えば、Amazon Pinpoint には、受信者に配信されたトランザクション SMS メッセージの数を報告する標準メトリクスがいくつか用意されています。これらのメトリクスの 1 つは、データを日付ごとに自動的にグループ化します (`txn-sms-delivered-grouped-by-date`)。別のメトリクスでは、データが国またはリージョンによって自動的にグループ化されます (`txn-sms-delivered-grouped-by-country`)。3 番目のメトリクスは、単純に一つの値、つまり受信者に配信されたメッセージングの数を返します (`txn-sms-delivered`)。必要な方法でデータをグループ化する標準メトリクスが見つからない場合は、必要なデータを返す一連のクエリを開発できます。その後、クエリ結果を手動で分類したり、デザインするカスタムグループに結合できます。 最後に、クエリするデータにアクセスする権限があることを確認することが重要です。詳細については、「[Amazon Pinpoint 分析データのクエリ実行用の IAM ポリシー](analytics-permissions.md)」を参照してください。 # トランザクション E メールメッセージの Amazon Pinpoint データをクエリする プロジェクトに送信されたトランザクション E メールメッセージのデータをクエリするには、[Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) API を使用して、次の必須パラメータの値を指定します。 + **application-id** – プロジェクトの一意の識別子であるプロジェクト ID。Amazon Pinpoint では、*プロジェクト*と*アプリケーション*という用語は同じ意味です。 + **kpi-name** – クエリするメトリクスの名前。この値は、関連するメトリクスを記述し、ハイフンで区切られた小文字の英数字で構成される 2 つ以上の用語で構成されます。サポートされているメトリクスの完全なリストと各メトリクスの `kpi-name` 値については、「[プロジェクト、キャンペーン、ジャーニーの標準メトリクス](analytics-standard-metrics.md)」を参照してください。 また、特定の日付範囲のデータをクエリするフィルターを適用することもできます。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを返します。異なる日付でデータをフィルタリングするには、サポートされている日付範囲パラメータを使用して、日付範囲の最初と最後の日時を指定します。値は拡張 ISO 8601 形式で、協定世界時 (UTC) を使用する必要があります (例: `2019-09-06T20:00:00Z` は、2019 年 9 月 6 日午後 8 時 (UTC) )。日付範囲は包括的であり、31 日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。 次の例は、Amazon Pinpoint REST API、、および を使用して AWS CLI、トランザクション E メールメッセージの分析データをクエリする方法を示しています AWS SDK for Java。任意のサポートされている AWS SDK を使用して、トランザクションメッセージの分析データをクエリできます。 AWS CLI 例は Microsoft Windows 用にフォーマットされています。Unix、Linux、macOS の場合は、キャレット (^) 行継続文字をバックスラッシュ (\$1) に置き換えます。 ------ #### [ REST API ] Amazon Pinpoint REST API を使用してトランザクション E メールメッセージの分析データをクエリするには、HTTP(S) GET リクエストを [Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) URI に送信します。URI で、必要なパスパラメータに次の適切な値を指定します。 ``` https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name ``` 各パラメータの意味は次のとおりです。 + *endpoint* は、プロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + *application-id* は、プロジェクトの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 すべてのパラメータは、URL エンコードする必要があります。 特定の日付範囲のデータをクエリするフィルターを適用するには、URI に `start-time` および `end-time` クエリパラメータと値を追加します。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。パラメータを区切るには、アンパサンド (&) を使用します。 例えば、次のリクエストは、2019 年 9 月 6 日から 2019 年 9 月 13 日までプロジェクトに送信されたトランザクション E メールメッセージの数を取得します。 ``` https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/txn-emails-sent?start-time=2019-09-06T00:00:00Z&end-time=2019-09-13T23:59:59Z ``` コードの説明は以下のとおりです。 + `pinpoint.us-east-1.amazonaws.com` は、プロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + `1234567890123456789012345example` は、プロジェクトの一意の識別子です。 + `txn-emails-sent` は、*送信*アプリケーションメトリクスの`kpi-name` 値で、プロジェクトのために送信されたトランザクション E メールメッセージの数を報告するメトリクスです。 + `2019-09-06T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-09-13T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ AWS CLI ] を使用してトランザクション E メールメッセージの分析データをクエリするには AWS CLI、 **get-application-date-range-kpi** コマンドを使用して、必要なパラメータに適切な値を指定します。 ``` C:\> aws pinpoint get-application-date-range-kpi ^ --application-id application-id ^ --kpi-name kpi-name ``` コードの説明は以下のとおりです。 + *application-id* は、プロジェクトの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータをクエリするフィルターを適用するには、`start-time` および `end-time` パラメータと値をクエリに追加します。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 9 月 6 日から 2019 年 9 月 13 日までプロジェクトに送信されたトランザクション E メールメッセージの数を取得します。 ``` C:\> aws pinpoint get-application-date-range-kpi ^ --application-id 1234567890123456789012345example ^ --kpi-name txn-emails-sent ^ --start-time 2019-09-06T00:00:00Z ^ --end-time 2019-09-13T23:59:59Z ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、プロジェクトの一意の識別子です。 + `txn-emails-sent` は、*送信*アプリケーションメトリクスの`kpi-name` 値で、プロジェクトのために送信されたトランザクション E メールメッセージの数を報告するメトリクスです。 + `2019-09-06T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-09-13T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ SDK for Java ] を使用してトランザクション E メールメッセージの分析データをクエリするには AWS SDK for Java、[Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) API の **GetApplicationDateRangeKpiRequest**メソッドを使用します。必要なパラメータに適切な値を指定します。 ``` GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest() .withApplicationId("applicationId") .withKpiName("kpiName") ``` コードの説明は以下のとおりです。 + *applicationId* は、プロジェクトの一意の識別子です。 + *kpiName* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータをクエリするフィルターを適用するには、`startTime` および `endTime` パラメータと値をクエリに含めます。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 9 月 6 日から 2019 年 9 月 13 日までプロジェクトに送信されたトランザクション E メールメッセージの数を取得します。 ``` GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest() .withApplicationId("1234567890123456789012345example") .withKpiName("txn-emails-sent") .withStartTime(Date.from(Instant.parse("2019-09-06T00:00:00Z"))) .withEndTime(Date.from(Instant.parse("2019-09-13T23:59:59Z"))); ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、プロジェクトの一意の識別子です。 + `txn-emails-sent` は、*送信*アプリケーションメトリクスの`kpi-name` 値で、プロジェクトのために送信されたトランザクション E メールメッセージの数を報告するメトリクスです。 + `2019-09-06T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-09-13T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ クエリを送信すると、Amazon Pinpoint はクエリ結果を JSON レスポンスで返します。結果の構造は、クエリしたメトリクスによって異なります。一部のメトリクスは 1 つの値しか返しません。例えば、前述の例で使用されている、*送信* (`txn-emails-sent`) アプリケーションメトリクスは、1 つの値 (プロジェクトから送信されたトランザクション E メールメッセージの数) を返します。この場合、JSON レスポンスは次のようになります。 ``` { "ApplicationDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "EndTime":"2019-09-13T23:59:59Z", "KpiName":"txn-emails-sent", "KpiResult":{ "Rows":[ { "Values":[ { "Key":"TxnEmailsSent", "Type":"Double", "Value":"62.0" } ] } ] }, "StartTime":"2019-09-06T00:00:00Z" } } ``` 他のメトリクスは複数の値を返し、関連するフィールドで値をグループ化します。メトリクスが複数の値を返す場合、JSON レスポンスにはデータのグループ化に使用されたフィールドを示すフィールドが含まれます。 クエリ結果の構造の詳細については、「[JSON クエリ結果を使用する](analytics-query-results.md)」を参照してください。 # トランザクション SMS メッセージの Amazon Pinpoint データをクエリする プロジェクトに送信されたトランザクション SMS メッセージのデータをクエリするには、[Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) API を使用して、次の必須パラメータの値を指定します。 + **application-id** – プロジェクトの一意の識別子であるプロジェクト ID。Amazon Pinpoint では、*プロジェクト*と*アプリケーション*という用語は同じ意味です。 + **kpi-name** – クエリするメトリクスの名前。この値は、関連するメトリクスを記述し、ハイフンで区切られた小文字の英数字で構成される 2 つ以上の用語で構成されます。サポートされているメトリクスの完全なリストと各メトリクスの `kpi-name` 値については、「[プロジェクト、キャンペーン、ジャーニーの標準メトリクス](analytics-standard-metrics.md)」を参照してください。 また、特定の日付範囲のデータをクエリするフィルターを適用することもできます。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを返します。異なる日付でデータをフィルタリングするには、サポートされている日付範囲パラメータを使用して、日付範囲の最初の日時と最後の日時を指定します。値は拡張 ISO 8601 形式で、協定世界時 (UTC) を使用する必要があります (例: `2019-09-06T20:00:00Z` は、2019 年 9 月 6 日午後 8 時 (UTC) )。日付範囲は包括的であり、31 日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。 次の例は、Amazon Pinpoint REST API、、および を使用して AWS CLI、トランザクション SMS メッセージの分析データをクエリする方法を示しています AWS SDK for Java。サポートされている任意の AWS SDK を使用して、トランザクションメッセージの分析データをクエリできます。 AWS CLI 例は Microsoft Windows 用にフォーマットされています。Unix、Linux、macOS の場合は、キャレット (^) 行継続文字をバックスラッシュ (\$1) に置き換えます。 ------ #### [ REST API ] Amazon Pinpoint REST API を使用してトランザクション SMS メッセージの分析データをクエリするには、HTTP(S) GET リクエストを [Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) URI に送信します。URI で、必要なパスパラメータに次の適切な値を指定します。 ``` https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name ``` 各パラメータの意味は次のとおりです。 + *endpoint* は、プロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + *application-id* は、プロジェクトの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 すべてのパラメータは、URL エンコードする必要があります。 特定の日付範囲のデータを取得するフィルターを適用するには、URI に `start-time` および `end-time` クエリパラメータと値を追加します。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。パラメータを区切るには、アンパサンド (&) を使用します。 例えば、次のリクエストは、2019 年 9 月 6 日から 2019 年 9 月 8 日まで毎日送信されたトランザクション SMS メッセージの数を取得します。 ``` https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/txn-sms-sent-grouped-by-date?start-time=2019-09-06T00:00:00Z&end-time=2019-09-08T23:59:59Z ``` コードの説明は以下のとおりです。 + `pinpoint.us-east-1.amazonaws.com` は、プロジェクトをホストする AWS リージョンの Amazon Pinpoint エンドポイントです。 + `1234567890123456789012345example` は、プロジェクトの一意の識別子です。 + `txn-sms-sent-grouped-by-date` は、日付アプリケーションメトリクスで*グループ化された送信*の `kpi-name` 値で、日付範囲の各日に送信されたトランザクション SMS メッセージの数を返すメトリクスです。 + `2019-09-06T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-09-08T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ AWS CLI ] を使用してトランザクション SMS メッセージの分析データをクエリするには AWS CLI、 **get-application-date-range-kpi** コマンドを使用して、必要なパラメータに適切な値を指定します。 ``` C:\> aws pinpoint get-application-date-range-kpi ^ --application-id application-id ^ --kpi-name kpi-name ``` コードの説明は以下のとおりです。 + *application-id* は、プロジェクトの一意の識別子です。 + *kpi-name* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータを取得するフィルターを適用するには、`start-time` および `end-time` パラメータと値をクエリに含めます。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 9 月 6 日から 2019 年 9 月 8 日まで毎日送信されたトランザクション SMS メッセージの数を取得します。 ``` C:\> aws pinpoint get-application-date-range-kpi ^ --application-id 1234567890123456789012345example ^ --kpi-name txn-sms-sent-grouped-by-date ^ --start-time 2019-09-06T00:00:00Z ^ --end-time 2019-09-08T23:59:59Z ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、プロジェクトの一意の識別子です。 + `txn-sms-sent-grouped-by-date` は、日付アプリケーションメトリクスで*グループ化された送信*の `kpi-name` 値で、日付範囲の各日に送信されたトランザクション SMS メッセージの数を返すメトリクスです。 + `2019-09-06T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-09-08T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ #### [ SDK for Java ] を使用してトランザクション SMS メッセージの分析データをクエリするには AWS SDK for Java、[Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) API の **GetApplicationDateRangeKpiRequest**メソッドを使用して、必要なパラメータに適切な値を指定します。 ``` GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest() .withApplicationId("applicationId") .withKpiName("kpiName") ``` コードの説明は以下のとおりです。 + *applicationId* は、プロジェクトの一意の識別子です。 + *kpiName* は、クエリするメトリクスの `kpi-name` 値です。 特定の日付範囲のデータを取得するフィルターを適用するには、`startTime` および `endTime` パラメータと値をクエリに含めます。これらのパラメータを使用すると、データを取得する日付範囲の最初と最後の日付と時刻（両端を含む）を、拡張 ISO 8601 形式で指定できます。例えば、次のリクエストは、2019 年 9 月 6 日から 2019 年 9 月 8 日まで毎日送信されたトランザクション SMS メッセージの数を取得します。 ``` GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest() .withApplicationId("1234567890123456789012345example") .withKpiName("txn-sms-sent-grouped-by-date") .withStartTime(Date.from(Instant.parse("2019-09-06T00:00:00Z"))) .withEndTime(Date.from(Instant.parse("2019-09-08T23:59:59Z"))); ``` コードの説明は以下のとおりです。 + `1234567890123456789012345example` は、プロジェクトの一意の識別子です。 + `txn-sms-sent-grouped-by-date` は、日付アプリケーションメトリクスで*グループ化された送信*の `kpi-name` 値で、日付範囲の各日に送信されたトランザクション SMS メッセージの数を返すメトリクスです。 + `2019-09-06T00:00:00Z` は、端の値を含む日付範囲の一部として、データを取得する最初の日付と時刻です。 + `2019-09-08T23:59:59Z` は、端の値を含む日付範囲の一部として、データを取得する最後の日付と時刻です。 ------ クエリを送信すると、Amazon Pinpoint はクエリ結果を JSON レスポンスで返します。結果の構造は、クエリしたメトリクスによって異なります。一部のメトリクスは 1 つの値しか返しません。他のメトリクスは複数の値を返し、関連するフィールドでそれらの値をグループ化します。メトリクスが複数の値を返す場合、JSON レスポンスにはデータのグループ化に使用されたフィールドを示すフィールドが含まれます。 例えば、前述の例で使用されている、日付 (`txn-sms-sent-grouped-by-date`) アプリケーションのメトリクスで*グループ化された送信*は、複数の値（与えられた日付範囲の各日中に送信されたトランザクション SMS のメッセージ数）を返します。この場合、JSON レスポンスは次のようになります。 ``` { "ApplicationDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "EndTime":"2019-09-08T23:59:59Z", "KpiName":"txn-sms-sent-grouped-by-date", "KpiResult":{ "Rows":[ { "GroupedBys":[ { "Key":"Date", "Type":"String", "Value":"2019-09-06" } ], "Values":[ { "Key":"TxnSmsSent", "Type":"Double", "Value":"29.0" } ] }, { "GroupedBys":[ { "Key":"Date", "Type":"String", "Value":"2019-09-07" } ], "Values":[ { "Key":"TxnSmsSent", "Type":"Double", "Value":"35.0" } ] }, { "GroupedBys":[ { "Key":"Date", "Type":"String", "Value":"2019-09-08" } ], "Values":[ { "Key":"TxnSmsSent", "Type":"Double", "Value":"10.0" } ] } ] }, "StartTime":"2019-09-06T00:00:00Z" } } ``` この場合、`GroupedBys` フィールドは値が暦日 (`Date`) でグループ化されていることを示しています。これにより、以下のように処理されます。 + 29 件のメッセージが 2019 年 9 月 6 日に送信されました。 + 35 件のメッセージが 2019 年 9 月 7 日に送信されました。 + 10 件のメッセージが 2019 年 9 月 8 日に送信されました。 クエリ結果の構造の詳細については、「[JSON クエリ結果を使用する](analytics-query-results.md)」を参照してください。 # Amazon Pinpoint 分析 JSON クエリ結果を使用する Amazon Pinpoint Analytics API を使用して分析データをクエリすると、Amazon Pinpoint は JSON レスポンスで結果を返します。アプリケーションメトリクス、キャンペーンメトリクス、およびジャーニーエンゲージメントメトリクスの場合、レスポンスのデータは、Amazon Pinpoint 分析データをレポートするための標準 JSON スキーマに準拠します。 つまり、選択したプログラミング言語またはツールを使用して、1 つ以上のこれらのメトリクスのデータをクエリし、各クエリの結果を取得して、結果をテーブル、オブジェクト、またはその他の場所に書き込むカスタムソリューションを実装できます。その後、別のサービスまたはアプリケーションを使用して、その場所でクエリ結果を操作できます。 例えば、以下のことが可能です。 + 一連のメトリクスを定期的にクエリし、好みのデータ可視化フレームワークを使用して結果を表示するカスタムダッシュボードを構築します。 + 適切なメトリクスをクエリし、その結果をグラフまたはユーザーが設計する他の種類のレポートに表示することで、エンゲージメント率を追跡するレポートを作成します。 + 解析データを解析して特定のストレージ形式に書き込み、結果を長期ストレージソリューションに移植します。 Amazon Pinpoint Analytics API は、Amazon Pinpoint プロジェクトや Amazon Pinpoint アカウントで後で読み込んだり使用したりできる永続オブジェクトを作成または保存するようには設計されていないことに注意してください。その代わりに、API は、分析データを取得し、そのデータを他のサービスやアプリケーションに転送して、さらに分析、保存、レポート作成を行うのに役立つように設計されています。これは、アプリケーションメトリクス、キャンペーンメトリクス、およびジャーニーエンゲージメントメトリクスに対してプログラミングによりクエリを実行できるすべての分析データに対して同じ JSON レスポンス構造とスキーマを使用して部分的に行います。 このトピックでは、アプリケーションメトリクス、キャンペーンメトリクス、またはジャーニーエンゲージメントメトリクスのクエリに対する JSON 応答の構造、オブジェクト、および項目について説明します。ジャーニー実行メトリクスまたはジャーニーアクティビティ実行メトリクスのクエリに対する JSON レスポンスのフィールドについては、「[Amazon Pinpoint プロジェクト、キャンペーン、ジャーニーに適用される標準メトリクス](analytics-standard-metrics.md)」を参照してください。 ## JSON の構造 クエリ結果の解析と使用を支援するために、Amazon Pinpoint Analytics API では、アプリケーションメトリクス、キャンペーンメトリクス、およびジャーニーエンゲージメントメトリクスをプログラミングによりクエリを実行できるすべての Amazon Pinpoint 分析データに対して同じ JSON レスポンス構造を使用します。各 JSON レスポンスでは、プロジェクト ID (`ApplicationId`) など、クエリを定義した値を指定します。レスポンスには、1 つ（1 つだけ）の `KpiResult` オブジェクトも含まれます。`KpiResult` オブジェクトには、クエリの結果セット全体が含まれます。 各 `KpiResult` オブジェクトには `Rows` オブジェクトが含まれます。これは、クエリ結果とその結果の値に関する関連メタデータを含むオブジェクトの配列です。`Rows` オブジェクトの構造と内容には、次の一般的な特性があります。 + クエリ結果の各行は、`Rows` オブジェクト内にある `Values`という別個の JSON オブジェクトです。例えば、クエリが 3 つの値を返す場合、`Rows` オブジェクトには 3 つの `Values` オブジェクトが含まれます。各 `Values` オブジェクトには、クエリの個別の結果が含まれます。 + クエリ結果の各列は、適用される `Values` オブジェクトのプロパティです。列の名前は、`Values` オブジェクトの `Key` フィールドに保存されます。 + グループ化されたクエリ結果の場合、各 `Values` オブジェクトには関連付けられた `GroupedBys` オブジェクトがあります。`GroupedBys` オブジェクトは、結果をグループ化するために使用されたフィールドを示します。また、関連付けられた `Values` オブジェクトのグループ化値も提供します。 + メトリクスのクエリ結果が null の場合、`Rows` オブジェクトは空です。 これらの一般的な特性以外にも、`Rows` オブジェクトの構造と内容はメトリクスによって異なります。これは、Amazon Pinpoint が、*単一値メトリクス*と*複数値メトリクス*の 2 種類のメトリクスをサポートするためです。 *単一値のメトリクス*は、累積値を 1 つだけ提供します。例えば、キャンペーンのすべての実行によって受取人に配信されたメッセージの割合が挙げられます。*複数値のメトリクス*は、複数の値を提供し、それらの値を関連するフィールド別にグループ化します。例えば、キャンペーンの実行ごとに受取人に配信されたメッセージの割合を、キャンペーンの実行ごとにグループ化して示します。 メトリクスが単一値メトリクスか複数値メトリクスかは、メトリクスの名前を参照するとすばやく判断できます。名前に `grouped-by` が含まれていない場合は、単一値メトリクスです。含まれている場合は、複数値メトリクスです。プログラミングによりクエリを実行できるメトリクスの完全なリストについては、「[Amazon Pinpoint プロジェクト、キャンペーン、ジャーニーに適用される標準メトリクス](analytics-standard-metrics.md)」を参照してください。 ### 単一値メトリクス 単一値メトリクスの場合、`Rows` オブジェクトには次の `Values` オブジェクトが含まれます。 + クエリされたメトリクスのフレンドリ名を指定します。 + クエリされたメトリクスに値を提供します。 + 返された値のデータ型を識別します。 例えば、次の JSON レスポンスには、単一値のメトリクスのクエリ結果が含まれます。このメトリクスは、2019 年 8 月 1 日から 2019 年 8 月 31 日まで、プロジェクトに関連付けられているすべてのキャンペーンによってメッセージが配信された一意のエンドポイントの数を示します。 ``` { "ApplicationDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "EndTime":"2019-08-31T23:59:59Z", "KpiName":"unique-deliveries", "KpiResult":{ "Rows":[ { "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"1368.0" } ] } ] }, "StartTime":"2019-08-01T00:00:00Z" } } ``` この例では、レスポンスは、2019 年 8 月 1 日から 2019 年 8 月 31 日までの間で、プロジェクトのすべてのキャンペーンで 1,368 個の一意のエンドポイントにメッセージを配信したことを示しています。 + `Key` は、値が `Value` フィールド (`UniqueDeliveries`) で指定されるメトリクスのフレンドリ名です。 + `Type` は、`Value` フィールド (`Double`) で指定された値のデータ型です。 + `Value` は、適用されたすべてのフィルター (`1368.0`) を含む、クエリされたメトリクスの実際の値です。 単一値メトリクスのクエリ結果が null (0 以上でない) の場合、`Rows` オブジェクトは空です。Amazon Pinpoint は、メトリクスに返すべきデータがない場合、メトリックに null 値を返します。例: ``` { "ApplicationDateRangeKpiResponse":{ "ApplicationId":"2345678901234567890123456example", "EndTime":"2019-08-31T23:59:59Z", "KpiName":"unique-deliveries", "KpiResult":{ "Rows":[ ] }, "StartTime":"2019-08-01T00:00:00Z" } } ``` ### 複数値メトリクス 複数値メトリクスの `Rows` オブジェクトの構造と内容は、単一値メトリクスとほとんど同じです。複数値のメトリクスの `Rows` オブジェクトには、`Values` オブジェクトも含まれます。`Values` オブジェクトは、クエリされたメトリクスのフレンドリ名を指定し、そのメトリクスの値を提供して、その値のデータ型を識別します。 ただし、複数値メトリクスの `Rows` オブジェクトには、1 つ以上の `GroupedBy` オブジェクトも含まれます。クエリ結果には、`Values` オブジェクトごとに 1 つの `GroupedBy` オブジェクトがあります。`GroupedBy` オブジェクトは、結果内のデータをグループ化するために使用されたフィールドと、そのフィールドのデータ型を示します。また、そのフィールド (関連付けられた `Values` オブジェクト) のグループ化値も示します。 例えば、次の JSON レスポンスには、2019 年 8 月 1 日から 2019 年 8 月 31 日までの間で、プロジェクトに関連付けられた各キャンペーンについて、メッセージが配信された一意のエンドポイントの数を報告する複数値メトリクスのクエリ結果が含まれています。 ``` { "ApplicationDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "EndTime":"2019-08-31T23:59:59Z", "KpiName":"unique-deliveries-grouped-by-campaign", "KpiResult":{ "Rows":[ { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"80b8efd84042ff8d9c96ce2f8example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"123.0" } ] }, { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"810c7aab86d42fb2b56c8c966example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"456.0" } ] }, { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"42d8c7eb0990a57ba1d5476a3example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"789.0" } ] } ] }, "StartTime":"2019-08-01T00:00:00Z" } } ``` この例では、2019 年 8 月 1 日から 2019 年 8 月 31 日までの間で、プロジェクトの 3 つのキャンペーンで一意のエンドポイントにメッセージを配信したという応答が示されます。これらのキャンペーンそれぞれの配信数の内訳は次のとおりです。 + キャンペーン `80b8efd84042ff8d9c96ce2f8example` では、123 の一意のエンドポイントにメッセージを配信しました。 + キャンペーン `810c7aab86d42fb2b56c8c966example` では、456 の一意のエンドポイントにメッセージを配信しました。 + キャンペーン `42d8c7eb0990a57ba1d5476a3example` では、789 の一意のエンドポイントにメッセージを配信しました。 オブジェクトおよびフィールドの一般的な構造は次のとおりです。 + `GroupedBys.Key` – `GroupedBys.Value` フィールド (`CampaignId`) に指定されたグループ化値を保存するプロパティまたはフィールドの名前。 + `GroupedBys.Type` – `GroupedBys.Value` フィールド (`String`) で指定された値のデータ型。 + `GroupedBys.Value` – `GroupedBys.Key` フィールド（キャンペーン ID）で指定された、データのグループ化に使用されたフィールドの実際の値。 + `Values.Key` – 値が `Values.Value` フィールド (`UniqueDeliveries`) で指定されるメトリクスのフレンドリ名。 + `Values.Type` – `Values.Value` フィールド (`Double`) で指定された値のデータ型。 + `Values.Value` – 適用されたすべてのフィルターを含む、クエリされたメトリクスの実際の値。 特定のプロジェクト、キャンペーン、またはその他のリソースに対する、複数値メトリクスのクエリ結果が null（ゼロ以下）の場合、Amazon Pinpoint はリソースにオブジェクトまたはフィールドを返しません。複数値メトリクスのクエリ結果が、すべてのリソースで null の場合、Amazon Pinpoint は空の `Rows` オブジェクトを返します。 ## JSON オブジェクトとフィールド プロジェクト ID (`ApplicationId`) などのクエリを定義した値を指定することに加えて、アプリケーションメトリクス、キャンペーンメトリック、またはジャーニーエンゲージメントメトリクスのクエリに対する各 JSON レスポンスには、`KpiResult` オブジェクトが含まれます。このオブジェクトには、クエリの全体的な結果セットが含まれ、この結果を解析して、別のサービスまたはアプリケーションに分析データを送信できます。各 `KpiResult` オブジェクトには、メトリクスにより、次の標準オブジェクトおよびフィールドの一部またはすべてが含まれます。 | オブジェクトまたはフィールド | 説明 | | --- | --- | | Rows | クエリの結果セットを含むオブジェクトの配列。 | | Rows.GroupedBys | 複数値メトリクスの場合、クエリ結果でデータをグループ化するために使用されたフィールドと値を定義するフィールドの配列。 | | Rows.GroupedBys.Key | 複数値メトリクスの場合、GroupedBys.Value フィールドで指定された値を保存するプロパティまたはフィールドの名前。 | | Rows.GroupedBys.Type | 複数値メトリクスの場合、GroupedBys.Value フィールドで指定された値のデータ型。 | | Rows.GroupedBys.Value | 複数値メトリクスの場合、クエリ結果のデータをグループ化するために使用されたフィールドの実際の値。この値は、関連付けられた Values オブジェクトに相関します。 | | Rows.Values | クエリ結果を含むフィールドの配列。 | | Rows.Values.Key | クエリされたメトリクスのフレンドリ名。メトリクスの値は Values.Value フィールドで指定されます。 | | Rows.Values.Type | Values.Value フィールドで指定された値のデータ型。 | | Rows.Values.Value | 適用されたすべてのフィルターを含む、クエリされたメトリクスの実際の値。 | ジャーニー実行メトリクスまたはジャーニーアクティビティ実行メトリクスのクエリに対する JSON レスポンスのフィールドについては、「[Amazon Pinpoint プロジェクト、キャンペーン、ジャーニーに適用される標準メトリクス](analytics-standard-metrics.md)」を参照してください。