レポートの一覧表示

Google Cloud プロジェクト内のすべてのレポート構成を一覧表示することで、App Optimize API レポートを効果的に管理できます。これにより、特定のレポートを特定して、データを読み取ったり、不要になったレポートを有効期限前に削除したりできます。

リスト オペレーションは、各レポートのリソース名、スコープ、ディメンション、指標、有効期限などのレポート メタデータを返します。リクエストした費用と使用状況の情報をダウンロードするには、レポートのデータを読み取る必要があります。

始める前に

  1. Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、 アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
  2. Google Cloud CLI をインストールします。

  3. 外部 ID プロバイダ(IdP)を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

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

    gcloud init
  5. このガイドを完了するために必要な権限があることを確認します

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

  7. 外部 ID プロバイダ(IdP)を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

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

    gcloud init
  9. このガイドを完了するために必要な権限があることを確認します

必要なロール

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

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

レポートの一覧表示

REST API を使用してプロジェクト内のレポートを一覧表示するには、レポート コレクション エンドポイントに HTTP GET リクエストを送信します。

次の curl コマンドを使用して、プロジェクトのレポートを一覧表示します。

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports?pageSize=PAGE_SIZE"

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

  • PROJECT_ID: 一覧表示するレポート リソースを所有する Google Cloud プロジェクトの ID。
  • PAGE_SIZE: ページごとに返すレポートの最大数。省略した場合、API はデフォルト値を使用します。サーバーが返すレポートが、リクエストされた数よりも少ないことがあります。

リクエストが成功すると、API はレポート リソースのリストを含む JSON レスポンスを返します。以下は、呼び出しの成功例です。

{
  "reports": [
    {
      "name": "projects/PROJECT_ID/locations/global/reports/my-first-report",
      "dimensions": [
        "location",
        "product_display_name",
        "project",
        "sku"
      ],
      "scopes": [
        {
          "project": "projects/PROJECT_ID"
        }
      ],
      "filter": "hour \u003e= now - duration(\"168h\")",
      "expireTime": "2026-02-05T18:30:39.907639266Z",
      "metrics": [
        "cost"
      ]
    },
    {
      "name": "projects/PROJECT_ID/locations/global/reports/my-second-report",
      "dimensions": [
        "location",
        "product_display_name",
        "project",
        "resource",
        "resource_type"
      ],
      "scopes": [
        {
          "project": "projects/PROJECT_ID"
        }
      ],
      "filter": "hour \u003e= now - duration(\"168h\")",
      "expireTime": "2026-02-05T18:50:25.273833857Z",
      "metrics": [
        "cost",
        "cpu_mean_utilization"
      ]
    }
  ]
}

reports 配列には、各レポートのメタデータが含まれます。リクエストが失敗した場合は、API から返されたエラー メッセージを確認します。

レスポンスに nextPageToken 文字列が含まれている場合は、取得するレポートがまだあることを意味します。

レスポンスで nextPageToken フィールドを確認します。トークンが存在する場合は、次の curl リクエストを実行して、pageToken クエリ パラメータを含む次のページを取得します。pageSize パラメータは引き続き使用できます。

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports?pageToken=NEXT_PAGE_TOKEN&pageSize=PAGE_SIZE"

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

  • NEXT_PAGE_TOKEN: 前のレスポンスで受信した nextPageToken の値。
  • PAGE_SIZE: このリクエストに必要なページサイズ。

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

次のステップ