1 つのキャンペーンの Amazon Pinpoint データをクエリする

1 つのキャンペーンのデータをクエリするには、Campaign Metrics API を使用して、次の必須パラメータに値を指定します。

• application-id – キャンペーンに関連付けられているプロジェクトの一意の識別子であるプロジェクト ID。Amazon Pinpoint では、プロジェクトとアプリケーションという用語は同じ意味です。

• campaign-id – キャンペーンの一意の識別子。

• kpi-name – クエリするメトリクスの名前。この値は、関連するメトリクスを記述し、ハイフンで区切られた小文字の英数字で構成される 2 つ以上の用語で構成されます。サポートされているメトリクスの完全なリストと各メトリクスの kpi-name 値については、「プロジェクト、キャンペーン、ジャーニーの標準メトリクス」を参照してください。

また、特定の日付範囲のデータをクエリするフィルターを適用することもできます。日付範囲を指定しない場合、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 の場合は、キャレット (^) 行継続文字をバックスラッシュ (\) に置き換えます。

REST API

Amazon Pinpoint REST API を使用してキャンペーンの分析データをクエリするには、HTTP (S) GET リクエストを Campaign Metrics 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、キャンペーンメトリクス 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 クエリ結果を使用する」を参照してください。