Lister les rapports

Gérez efficacement vos rapports sur l'API App Optimize en listant toutes les configurations de rapport dans votre projet Google Cloud . Cela vous permet d'identifier un rapport spécifique pour lire ses données ou le supprimer avant sa date d'expiration s'il n'est plus nécessaire.

L'opération de liste renvoie les métadonnées du rapport, y compris le nom de la ressource, le champ d'application, les dimensions, les métriques et le délai d'expiration pour chaque rapport. Pour télécharger les informations sur les coûts et l'utilisation demandées, vous devez lire les données du rapport.

Avant de commencer

gcloud

Dans la console Google Cloud , activez Cloud Shell.

Activer Cloud Shell

En bas de la console Google Cloud , une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

Pour en savoir plus sur la configuration de l'authentification dans un environnement de production, consultez Configurer les Identifiants par défaut de l'application pour le code s'exécutant sur Google Cloud dans la documentation sur l'authentification Google Cloud .

Python

  1. Installez la bibliothèque cliente Python pour l'API App Optimize.

  2. Pour utiliser les exemples Python de cette page dans un environnement de développement local, installez et initialisez la gcloud CLI, puis configurez les Identifiants par défaut de l'application avec vos identifiants utilisateur.

    1. Installez la Google Cloud CLI.

    2. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    3. Si vous utilisez un shell local, créez des identifiants d'authentification locaux pour votre compte utilisateur : 

      gcloud auth application-default login

      Vous n'avez pas besoin de le faire si vous utilisez Cloud Shell.

      Si une erreur d'authentification est renvoyée et que vous utilisez un fournisseur d'identité (IdP) externe, vérifiez que vous vous êtes connecté à la gcloud CLI avec votre identité fédérée.

    Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

    Pour en savoir plus sur la configuration de l'authentification dans un environnement de production, consultez Configurer les Identifiants par défaut de l'application pour le code s'exécutant sur Google Cloud dans la documentation sur l'authentification Google Cloud .

REST

Pour utiliser les exemples API REST de cette page dans un environnement de développement local, vous devez utiliser les identifiants que vous fournissez à la gcloud CLI.

    Installez la Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour en savoir plus, consultez la section S'authentifier pour utiliser REST dans la documentation sur l'authentification Google Cloud .

Pour en savoir plus sur la configuration de l'authentification dans un environnement de production, consultez Configurer les Identifiants par défaut de l'application pour le code s'exécutant sur Google Cloud dans la documentation sur l'authentification Google Cloud .

Rôles requis

Pour obtenir les autorisations nécessaires pour lister les ressources de rapport d'un projet, demandez à votre administrateur de vous accorder le rôle IAM Lecteur App Optimize (roles/appoptimize.viewer) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Lister les rapports

Pour lister les rapports d'un projet, suivez les instructions de votre méthode préférée :

gcloud

Utilisez la commande gcloud beta app-optimize reports list pour lister les rapports d'un projet.

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

Remplacez PROJECT_ID par l'ID du projet Google Cloudqui possède les ressources de rapport que vous souhaitez répertorier.

La commande gcloud gère automatiquement la pagination et renvoie toutes les ressources demandées.

Python

Le code Python suivant utilise AppOptimizeClient.list_reports() pour afficher la liste des rapports d'un projet.

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)

Remplacez PROJECT_ID par l'ID du projet Google Cloudqui possède les ressources de rapport que vous souhaitez répertorier.

La bibliothèque cliente gère automatiquement la pagination et génère les résultats à partir de l'itérateur.

REST

Exécutez la commande curl suivante pour lister les rapports d'un projet :

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

Remplacez les éléments suivants :

  • PROJECT_ID : ID du Google Cloud projet propriétaire des ressources de rapport que vous souhaitez lister.
  • PAGE_SIZE : nombre maximal de rapports à renvoyer par page. En cas d'omission, l'API utilise une valeur par défaut. Le serveur peut renvoyer un nombre de rapports inférieur à celui demandé.

Si la requête aboutit, l'API renvoie une réponse JSON contenant une liste de ressources de rapport. Voici un exemple de réponse d'appel réussie :

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

Le tableau reports contient les métadonnées de chaque rapport. Si la requête échoue, examinez le message d'erreur renvoyé par l'API.

Si la réponse inclut une chaîne nextPageToken, cela signifie qu'il y a d'autres rapports à récupérer.

Recherchez un champ nextPageToken dans la réponse. Si le jeton existe, exécutez la commande curl suivante pour récupérer la page suivante, y compris le paramètre de requête pageToken. Vous pouvez continuer à utiliser le paramètre 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"

Remplacez les éléments suivants :

  • NEXT_PAGE_TOKEN : valeur de nextPageToken reçue dans la réponse précédente.
  • PAGE_SIZE : taille de page souhaitée pour cette requête.

Répétez ce processus jusqu'à ce que la réponse ne contienne plus de nextPageToken, ce qui indique que vous avez récupéré tous les rapports.

Étapes suivantes