レポートのデータを読み取る

App Optimize API でレポートを作成したら、レポートの費用と使用率のデータを取得します。このオペレーションでは、レポートのリクエスト時に指定したディメンションと指標に従って構造化された列と行として、この情報がダウンロードされます。

この API リクエストは、レポートの構成設定のみを返すレポートのメタデータの取得とは異なります。

始める前に

gcloud

  • Google Cloud CLI をインストールします。

  • フェデレーション ID（連携 ID）を使用するように gcloud CLI を構成します。

    詳細については、連携 ID を使用して gcloud CLI にログインするをご覧ください。

  • gcloud CLI を初期化するには、次のコマンドを実行します。

    gcloud init

  • gcloud CLI を初期化した後に更新して、必要なコンポーネントをインストールします。

    gcloud components update
gcloud components install beta

    • 本番環境での認証の設定については、 Google Cloud 認証ドキュメントの Google Cloudで実行されるコードのアプリケーションのデフォルト認証情報を設定する をご覧ください。

    Python

    1. App Optimize API 用の Python クライアント ライブラリをインストールします。

    2. ローカル開発環境でこのページの Python サンプルを使用するには、gcloud CLI をインストールして初期化し、ユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定します。

      1. Google Cloud CLI をインストールします。

      2. フェデレーション ID（連携 ID）を使用するように gcloud CLI を構成します。

        詳細については、連携 ID を使用して gcloud CLI にログインするをご覧ください。

      3. ユーザー アカウントのローカル認証情報を作成します。 

        gcloud auth application-default login

        認証エラーが返され、外部 ID プロバイダ（IdP）を使用している場合は、 フェデレーション ID を使用して gcloud CLI にログインしていることを確認します。

      詳細については、 Google Cloud 認証ドキュメントの ローカル開発環境の ADC の設定をご覧ください。

      本番環境での認証の設定については、 Google Cloud 認証ドキュメントの Google Cloudで実行されるコードのアプリケーションのデフォルト認証情報を設定する をご覧ください。

    REST

    このページの REST API サンプルをローカル開発環境で使用するには、gcloud CLI に指定した認証情報を使用します。

      Google Cloud CLI をインストールし、 フェデレーション ID を使用して gcloud CLI にログインします。

    詳細については、 Google Cloud 認証ドキュメントの REST を使用して認証するをご覧ください。

    本番環境での認証の設定については、 Google Cloud 認証ドキュメントの Google Cloudで実行されるコードのアプリケーションのデフォルト認証情報を設定する をご覧ください。

    必要なロール

    レポートのデータを読み取るために必要な権限を取得するには、レポート リソースを所有するプロジェクトに対する App Optimize 閲覧者 （roles/appoptimize.viewer）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

    必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

    レポートデータを読み取る

    完了したレポートからデータを読み取るには、次の手順に沿って操作します。

    gcloud

    gcloud beta app-optimize reports read コマンドを使用して、レポートのデータを取得します。

    gcloud beta app-optimize reports read REPORT_ID \
  --project=PROJECT_ID \
  --location=global

    次のように置き換えます。

    • PROJECT_ID: 読み取るレポート リソースを所有する Google Cloud プロジェクトの ID。
    • REPORT_ID: 読み取るレポートの ID。この ID はレポートの作成時に指定され、レポートを一覧表示することで取得できます。

    gcloud コマンドはページ分割を自動的に処理し、リクエストされたすべてのリソースを返します。

    cost フィールドの値については、費用指標の解釈をご覧ください。データと制限事項の詳細については、データを理解するをご覧ください。

    Python

    次の Python コードは、AppOptimizeClient.read_report() を使用してレポートのデータを読み取ります。

    from google.cloud import appoptimize_v1beta

project_id = "PROJECT_ID"
report_id = "REPORT_ID"

# Create the App Optimize client and read a report's data
client = appoptimize_v1beta.AppOptimizeClient()
request = appoptimize_v1beta.ReadReportRequest(
    name=f"projects/{project_id}/locations/global/reports/{report_id}"
)
result = client.read_report(request=request)

# Display the report data
print(result)

    次のように置き換えます。

    • PROJECT_ID: 読み取るレポート リソースを所有する Google Cloud プロジェクトの ID。
    • REPORT_ID: 読み取るレポートの ID。この ID はレポートの作成時に指定され、レポートを一覧表示することで取得できます。

    クライアント ライブラリはページ分割を自動的に処理し、イテレータから結果を生成します。

    cost フィールドの値については、費用指標の解釈をご覧ください。データと制限事項の詳細については、データを理解するをご覧ください。

    REST

    REST API の :read カスタム メソッドに HTTP POST リクエストを送信します。

    1. 次の curl コマンドを使用して、レポートデータの最初のページを読み取るリクエストを送信します。

      curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{"pageSize": PAGE_SIZE}' \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports/REPORT_ID:read"

      次のように置き換えます。

      • PROJECT_ID: 読み取るレポート リソースを所有する Google Cloud プロジェクトの ID。
      • REPORT_ID: 読み取るレポートの ID。この ID はレポートの作成時に指定され、レポートを一覧表示することで取得できます。
      • PAGE_SIZE: ページごとに返す行の最大数。より大きな値を指定した場合でも、サーバーはページあたり最大 1,000 行を返します。レスポンスには 10 MB のサイズ上限もあるため、その上限内に収まるように返される行数が少なくなることがあります。pageSize が省略されている場合は、デフォルトのサイズが使用されます。

    2. リクエストが成功すると、API はレポートのスキーマと行を含む JSON レスポンスを返します。成功したレスポンスの例を次に示します。

      {
  "rows": [
    [
      "//apphub.googleapis.com/projects/123456789/locations/us-central1/applications/my-app-1",
      {
        "currency_code": "USD",
        "units": "106",
        "nanos": 321590000
      }
    ],
    [
      "//apphub.googleapis.com/projects/123456789/locations/us-central1/applications/my-app-2",
      {
        "currency_code": "USD",
        "units": "797",
        "nanos": 641691000
      }
    ]
  ],
  "columns": [
    {
      "name": "application",
      "type": "STRING"
    },
    {
      "name": "cost",
      "type": "RECORD",
      "columns": [
        {
          "name": "currency_code",
          "type": "STRING"
        },
        {
          "name": "units",
          "type": "INT64"
        },
        {
          "name": "nanos",
          "type": "INT64"
        }
      ]
    }
  ],
  "nextPageToken": "AABBCCddeeffGGHHiiJJkkLL"
}

      cost フィールドの値については、費用指標の解釈をご覧ください。データと制限事項の詳細については、データを理解するをご覧ください。

    3. レスポンスに nextPageToken フィールドが含まれている場合、レポートには追加の行が含まれます。次のページの結果を取得するには、JSON 本文の pageToken フィールドにこのトークンを含む別の POST リクエストを行います。

      curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{"pageToken": "NEXT_PAGE_TOKEN", "pageSize": PAGE_SIZE}' \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports/REPORT_ID:read"

      次のように置き換えます。

      • NEXT_PAGE_TOKEN: 前のレスポンスで受信した nextPageToken の値。
      • PAGE_SIZE: ページごとに返す行の最大数。この値はページ リクエスト間で変更できますが、サーバーサイドの制限は引き続き適用されます。

      レスポンスに nextPageToken が含まれなくなるまで、このプロセスを繰り返します。これは、すべてのレポートデータを取得したことを示します。

    次のステップ