トランザクション E メールメッセージの Amazon Pinpoint データをクエリする - Amazon Pinpoint

サポート終了通知: 2026 年 10 月 30 日、 AWS は Amazon Pinpoint のサポートを終了します。2026 年 10 月 30 日を過ぎると、Amazon Pinpoint コンソールまたは Amazon Pinpoint のリソース (エンドポイント、セグメント、キャンペーン、ジャーニー、分析) にアクセスできなくなります。詳細については、「Amazon Pinpoint のサポート終了」を参照してください。注: SMS、音声、モバイルプッシュ、OTP、電話番号の検証に関連する APIs は、この変更の影響を受けず、 AWS エンドユーザーメッセージングでサポートされています。

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

トランザクション E メールメッセージの Amazon Pinpoint データをクエリする

プロジェクトに送信されたトランザクション E メールメッセージのデータをクエリするには、Application Metrics API を使用して、次の必須パラメータの値を指定します。

  • application-id – プロジェクトの一意の識別子であるプロジェクト ID。Amazon Pinpoint では、プロジェクトとアプリケーションという用語は同じ意味です。

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

また、特定の日付範囲のデータをクエリするフィルターを適用することもできます。日付範囲を指定しない場合、Amazon Pinpoint は過去 31 暦日のデータを返します。異なる日付でデータをフィルタリングするには、サポートされている日付範囲パラメータを使用して、日付範囲の最初と最後の日時を指定します。値は拡張 ISO 8601 形式で、協定世界時 (UTC) を使用する必要があります (例: 2019-09-06T20:00:00Z は、2019 年 9 月 6 日午後 8 時 (UTC) )。日付範囲は包括的であり、31 日以内に制限する必要があります。また、最初の日付と時刻は、現在の日付から 90 日未満である必要があります。

次の例は、Amazon Pinpoint REST API、AWS CLI、および AWS SDK for Java を使用して、トランザクション E メールメッセージの分析データをクエリする方法を示しています。任意のサポートされている AWS SDK を使用して、トランザクションメッセージの分析データをクエリできます。これらの AWS CLI の例は、Microsoft Windows 用にフォーマットされています。Unix、Linux、macOS の場合は、キャレット (^) 行継続文字をバックスラッシュ (\) に置き換えます。

REST API

Amazon Pinpoint REST API を使用してトランザクション E メールメッセージの分析データをクエリするには、HTTP(S) GET リクエストを Application Metrics 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

AWS CLI を使用してトランザクション E メールメッセージの分析データをクエリするには、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

AWS SDK for Java を使用してトランザクション E メールメッセージの分析データを照会するには、Application Metrics 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 クエリ結果を使用する」を参照してください。