Membuat daftar laporan

Kelola laporan App Optimize API secara efektif dengan mencantumkan semua konfigurasi laporan dalam project Anda. Google Cloud Hal ini membantu Anda mengidentifikasi laporan tertentu untuk membaca datanya atau menghapusnya sebelum tanggal habis masa berlakunya jika tidak lagi diperlukan.

Operasi daftar menampilkan metadata laporan, termasuk nama resource, cakupan, dimensi, metrik, dan waktu habis masa berlaku untuk setiap laporan. Untuk mendownload informasi biaya dan penggunaan yang diminta, Anda harus membaca data laporan.

Sebelum memulai

gcloud

Di konsol Google Cloud , aktifkan Cloud Shell.

Aktifkan Cloud Shell

Di bagian bawah konsol Google Cloud , sesi Cloud Shell akan dimulai dan menampilkan perintah command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi pada sesi.

Untuk mengetahui informasi tentang cara menyiapkan autentikasi bagi lingkungan produksi, lihat Menyiapkan Kredensial Default Aplikasi untuk kode yang berjalan di Google Cloud dalam dokumentasi autentikasi Google Cloud .

Python

  1. Instal library klien Python untuk App Optimize API.

  2. Untuk menggunakan contoh Python di halaman ini dalam lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

    1. Instal Google Cloud CLI.

    2. Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

    3. Jika Anda menggunakan shell lokal, buat kredensial autentikasi lokal untuk akun pengguna Anda: 

      gcloud auth application-default login

      Anda tidak perlu melakukan langkah ini jika menggunakan Cloud Shell.

      Jika error autentikasi ditampilkan, dan Anda menggunakan penyedia identitas (IdP) eksternal, konfirmasi bahwa Anda telah login ke gcloud CLI dengan identitas gabungan Anda.

    Untuk mengetahui informasi selengkapnya, lihat Menyiapkan ADC untuk lingkungan pengembangan lokal dalam dokumentasi autentikasi Google Cloud .

    Untuk mengetahui informasi tentang cara menyiapkan autentikasi bagi lingkungan produksi, lihat Menyiapkan Kredensial Default Aplikasi untuk kode yang berjalan di Google Cloud dalam dokumentasi autentikasi Google Cloud .

REST

Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.

    Instal Google Cloud CLI.

    Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk mengetahui informasi selengkapnya, lihat Melakukan autentikasi untuk menggunakan REST dalam dokumentasi autentikasi Google Cloud .

Untuk mengetahui informasi tentang cara menyiapkan autentikasi bagi lingkungan produksi, lihat Menyiapkan Kredensial Default Aplikasi untuk kode yang berjalan di Google Cloud dalam dokumentasi autentikasi Google Cloud .

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan untuk mencantumkan resource laporan project, minta administrator untuk memberi Anda peran IAM App Optimize Viewer (roles/appoptimize.viewer) di project. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Membuat daftar laporan

Untuk mencantumkan laporan dalam project, ikuti petunjuk untuk metode pilihan Anda:

gcloud

Gunakan perintah gcloud beta app-optimize reports list untuk mencantumkan laporan dalam project.

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

Ganti PROJECT_ID dengan ID project Google Cloud yang memiliki resource laporan yang ingin Anda cantumkan.

Perintah gcloud menangani penomoran halaman secara otomatis, dengan menampilkan semua resource yang diminta.

Python

Kode Python berikut menggunakan AppOptimizeClient.list_reports() untuk menampilkan daftar laporan dalam project.

from google.cloud import appoptimize_v1beta

project_id = "PROJECT_ID"

# Create the App Optimize client and request the project's reports
client = appoptimize_v1beta.AppOptimizeClient()
request = appoptimize_v1beta.ListReportsRequest(
    parent=f"projects/{project_id}/locations/global"
)
page_result = client.list_reports(request=request)

# Iterate over the list of reports and display each one
for response in page_result:
    print(response)

Ganti PROJECT_ID dengan ID project Google Cloud yang memiliki resource laporan yang ingin Anda cantumkan.

Library klien menangani penomoran halaman secara otomatis, menghasilkan hasil dari iterator.

REST

Gunakan perintah curl berikut untuk mencantumkan laporan untuk suatu project:

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

Ganti kode berikut:

  • PROJECT_ID: ID Google Cloud project yang memiliki resource laporan yang ingin Anda lihat dalam daftar.
  • PAGE_SIZE: jumlah maksimum laporan yang akan ditampilkan per halaman. Jika tidak ada, API akan menggunakan nilai default. Server mungkin menampilkan lebih sedikit laporan daripada yang diminta.

Jika permintaan berhasil, API akan menampilkan respons JSON yang berisi daftar resource laporan. Berikut adalah contoh respons panggilan yang berhasil:

{
  "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"
      ]
    }
  ]
}

Array reports berisi metadata untuk setiap laporan. Jika permintaan tidak berhasil, tinjau pesan error yang ditampilkan oleh API.

Jika respons menyertakan string nextPageToken, berarti ada laporan lain yang dapat diambil.

Periksa kolom nextPageToken dalam respons. Jika token ada, jalankan perintah curl berikut untuk mengambil halaman berikutnya, termasuk parameter kueri pageToken. Anda dapat terus menggunakan parameter 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"

Ganti kode berikut:

  • NEXT_PAGE_TOKEN: nilai nextPageToken yang diterima dalam respons sebelumnya.
  • PAGE_SIZE: ukuran halaman yang Anda inginkan untuk permintaan ini.

Ulangi proses ini hingga respons tidak lagi berisi nextPageToken, yang menunjukkan bahwa Anda telah mengambil semua laporan.

Langkah berikutnya