Berichte auflisten

Sie können Ihre App Optimize API-Berichte effektiv verwalten, indem Sie alle Berichtskonfigurationen in Ihrem Google Cloud -Projekt auflisten. So können Sie einen bestimmten Bericht identifizieren, um seine Daten zu lesen oder ihn vor seinem Ablaufdatum zu löschen, wenn er nicht mehr benötigt wird.

Der Listenvorgang gibt die Berichtsmetadaten zurück, einschließlich des Ressourcennamens, des Bereichs, der Dimensionen, der Messwerte und der Ablaufzeit für jeden Bericht. Wenn Sie die angeforderten Kosten- und Nutzungsinformationen herunterladen möchten, müssen Sie die Daten des Berichts lesen.

Hinweis

gcloud

Aktivieren Sie Cloud Shell in der Google Cloud Console.

Cloud Shell aktivieren

Unten in der Google Cloud Console wird eine Cloud Shell-Sitzung gestartet und eine Eingabeaufforderung angezeigt. Cloud Shell ist eine Shell-Umgebung, in der das Google Cloud CLI bereits installiert ist und Werte für Ihr aktuelles Projekt bereits festgelegt sind. Das Initialisieren der Sitzung kann einige Sekunden dauern.

Informationen zum Einrichten der Authentifizierung für eine Produktionsumgebung finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter Standardanmeldedaten für Anwendungen für Code einrichten, der auf Google Cloudausgeführt wird .

Python

  1. Installieren Sie die Python-Clientbibliothek für die App Optimize API.

  2. Wenn Sie die Python-Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    1. Installieren Sie die Google Cloud CLI.

    2. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    3. Wenn Sie eine lokale Shell verwenden, erstellen Sie lokale Anmeldedaten zur Authentifizierung für Ihr Nutzerkonto: 

      gcloud auth application-default login

      Wenn Sie Cloud Shell verwenden, müssen Sie das nicht tun.

      Wenn ein Authentifizierungsfehler zurückgegeben wird und Sie einen externen Identitätsanbieter (IdP) verwenden, prüfen Sie, ob Sie sich mit Ihrer föderierten Identität in der gcloud CLI angemeldet haben.

    Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

    Informationen zum Einrichten der Authentifizierung für eine Produktionsumgebung finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter Standardanmeldedaten für Anwendungen für Code einrichten, der auf Google Cloudausgeführt wird .

REST

Wenn Sie die REST API-Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, verwenden Sie die Anmeldedaten, die Sie der gcloud CLI bereitstellen.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter Für die Verwendung von REST authentifizieren.

Informationen zum Einrichten der Authentifizierung für eine Produktionsumgebung finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter Standardanmeldedaten für Anwendungen für Code einrichten, der auf Google Cloudausgeführt wird .

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle App Optimize Viewer (roles/appoptimize.viewer) für das Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Auflisten der Berichtsressourcen eines Projekts benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Berichte auflisten

So listen Sie Berichte in einem Projekt auf:

gcloud

Verwenden Sie den Befehl gcloud beta app-optimize reports list, um die Berichte in einem Projekt aufzulisten.

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

Ersetzen Sie PROJECT_ID durch die ID des Google Cloud-Projekts, zu dem die Berichtsressourcen gehören, die Sie auflisten möchten.

Der Befehl gcloud verarbeitet die Paginierung automatisch und gibt alle angeforderten Ressourcen zurück.

Python

Im folgenden Python-Code wird AppOptimizeClient.list_reports() verwendet, um eine Liste von Berichten in einem Projekt anzuzeigen.

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)

Ersetzen Sie PROJECT_ID durch die ID des Google Cloud-Projekts, zu dem die Berichtsressourcen gehören, die Sie auflisten möchten.

Die Clientbibliothek führt die Paginierung automatisch durch und gibt Ergebnisse aus dem Iterator zurück.

REST

Verwenden Sie den folgenden curl-Befehl, um die Berichte für ein Projekt aufzulisten:

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

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID des Google Cloud Projekts, zu dem die Berichtsressourcen gehören, die Sie auflisten möchten.
  • PAGE_SIZE: Die maximale Anzahl von Berichten, die pro Seite zurückgegeben werden sollen. Wenn keine Angabe gemacht wird, wird ein Standardwert verwendet. Der Server gibt möglicherweise weniger Berichte als angefordert zurück.

Wenn die Anfrage erfolgreich ist, gibt die API eine JSON-Antwort mit einer Liste von Berichtsressourcen zurück. Hier ist ein Beispiel für eine erfolgreiche Antwort auf einen Aufruf:

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

Das reports-Array enthält die Metadaten für jeden Bericht. Wenn die Anfrage nicht erfolgreich ist, sehen Sie sich die von der API zurückgegebene Fehlermeldung an.

Wenn die Antwort den String nextPageToken enthält, sind weitere Berichte abzurufen.

Suchen Sie in der Antwort nach dem Feld nextPageToken. Wenn das Token vorhanden ist, führen Sie den folgenden curl-Befehl aus, um die nächste Seite abzurufen. Fügen Sie dazu den Abfrageparameter pageToken ein. Sie können den Parameter pageSize weiterhin verwenden.

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"

Ersetzen Sie Folgendes:

  • NEXT_PAGE_TOKEN: Der Wert von nextPageToken, der in der vorherigen Antwort empfangen wurde.
  • PAGE_SIZE: Die Seitengröße, die Sie für diese Anfrage wünschen.

Wiederholen Sie diesen Vorgang, bis die Antwort kein nextPageToken mehr enthält. Das bedeutet, dass Sie alle Berichte abgerufen haben.

Nächste Schritte