レポートのメタデータを取得する

レポートのスコープや指標などの設定を検査したり、有効期限を確認したりするには、App Optimize API を使用してレポートのメタデータを取得します。

この 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. このガイドを完了するために必要な権限があることを確認します。

    10.

必要なロール

レポートのメタデータを読み取るために必要な権限を取得するには、レポート リソースを所有するプロジェクトに対する 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/REPORT_ID"

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

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

リクエストが成功すると、API はレポートのメタデータを含む JSON レスポンスを返します。

以下は、選択したディメンションと指標、プロジェクト スコープ、レポートの有効期限などを含む、成功したレスポンスの例です。

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

次のステップ