Metadaten eines Berichts abrufen

Wenn Sie die Einstellungen eines Berichts, z. B. seinen Bereich und seine Messwerte, oder seine Ablaufzeit prüfen möchten, verwenden Sie die App Optimize API, um die Metadaten des Berichts abzurufen.

Bei dieser API-Anfrage werden nicht die tatsächlichen Datenzeilen im Bericht zurückgegeben. Wenn Sie diese Informationen herunterladen möchten, müssen Sie die Daten des Berichts lesen.

Hinweis

gcloud

  • Installieren Sie die Google Cloud CLI.

  • Konfigurieren Sie die gcloud CLI für die Verwendung Ihrer föderierten Identität.

    Weitere Informationen finden Sie unter Mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  • Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

    gcloud init
  • Aktualisieren Sie die gcloud CLI nach der Initialisierung und installieren Sie die erforderlichen Komponenten:

    gcloud components update
    gcloud components install beta
  • 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. Konfigurieren Sie die gcloud CLI für die Verwendung Ihrer föderierten Identität.

        Weitere Informationen finden Sie unter Mit Ihrer föderierten Identität in der gcloud CLI anmelden.

      3. Erstellen Sie lokale Anmeldedaten zur Authentifizierung für Ihr Nutzerkonto:

        gcloud auth application-default login

        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 und melden Sie sich dann mit Ihrer föderierten Identität in der gcloud CLI an.

    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, in dem sich die Berichtsressource befindet, damit Sie die Berechtigungen erhalten, die Sie zum Lesen der Metadaten eines Berichts 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.

    Berichtsmetadaten abrufen

    So rufen Sie die Metadaten für einen Bericht ab:

    gcloud

    Verwenden Sie den Befehl gcloud beta app-optimize reports describe, um die Metadaten eines Berichts abzurufen.

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

    Ersetzen Sie Folgendes:

    • PROJECT_ID: die ID des Google Cloud Projekts, zu dem die Berichtsressource gehört, die Sie abrufen möchten.
    • REPORT_ID: die ID des Berichts, der abgerufen werden soll. Diese ID wurde beim Erstellen des Berichts angegeben und kann durch Auflisten von Berichten abgerufen werden.

    Python

    Im folgenden Python-Code wird AppOptimizeClient.get_report() verwendet, um die Metadaten eines Berichts abzurufen.

    from google.cloud import appoptimize_v1beta
    
    project_id = "PROJECT_ID"
    report_id = "REPORT_ID"
    name = f"projects/{project_id}/locations/global/reports/{report_id}"
    
    # Create the App Optimize client and request the report's metadata
    client = appoptimize_v1beta.AppOptimizeClient()
    request = appoptimize_v1beta.GetReportRequest(name=name)
    response = client.get_report(request=request)
    
    # Display the metadata
    print(response)
    

    Ersetzen Sie Folgendes:

    • PROJECT_ID: die ID des Google Cloud Projekts, zu dem die Berichtsressource gehört, die Sie abrufen möchten.
    • REPORT_ID: die ID des Berichts, der abgerufen werden soll. Diese ID wurde beim Erstellen des Berichts angegeben und kann durch Auflisten von Berichten abgerufen werden.

    REST

    Verwenden Sie den folgenden Befehl curl, um die Berichtsmetadaten abzurufen:

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

    Ersetzen Sie Folgendes:

    • PROJECT_ID: die ID des Google Cloud Projekts, zu dem die Berichtsressource gehört, die Sie abrufen möchten.
    • REPORT_ID: die ID des Berichts, der abgerufen werden soll. Diese ID wurde beim Erstellen des Berichts angegeben und kann durch Auflisten von Berichten abgerufen werden.

    Wenn die Anfrage erfolgreich ist, gibt die API eine JSON-Antwort mit den Berichtsmetadaten zurück. Hier sehen Sie ein Beispiel für eine erfolgreiche Antwort mit der ausgewählten Dimension und dem ausgewählten Messwert, dem Projektumfang und dem Ablaufdatum des Berichts:

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

    Nächste Schritte