Obtenir les métadonnées d'un rapport

Pour inspecter les paramètres d'un rapport, tels que son champ d'application et ses métriques, ou pour vérifier son délai d'expiration, utilisez l'API App Optimize afin d'obtenir les métadonnées du rapport.

Cette requête d'API ne renvoie pas les lignes de données réelles du rapport. Pour télécharger ces informations, vous devez lire les données du rapport.

Avant de commencer

gcloud

  • Installez la Google Cloud CLI.

  • Configurez la gcloud CLI afin d'utiliser votre identité fédérée.

    Pour en savoir plus, consultez Se connecter à la gcloud CLI avec votre identité fédérée.

  • Pour initialiser la gcloud CLI, exécutez la commande suivante : 

    gcloud init

  • Après avoir initialisé la gcloud CLI, mettez-la à jour et installez les composants requis : 

    gcloud components update
gcloud components install beta

    • 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. Configurez la gcloud CLI afin d'utiliser votre identité fédérée.

        Pour en savoir plus, consultez Se connecter à la gcloud CLI avec votre identité fédérée.

      3. Créez des identifiants d'authentification locaux pour votre compte utilisateur : 

        gcloud auth application-default login

        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, puis connectez-vous à 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 lire les métadonnées d'un rapport, demandez à votre administrateur de vous accorder le rôle IAM Lecteur App Optimize (roles/appoptimize.viewer) sur le projet qui possède la ressource de rapport. 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.

    Obtenir les métadonnées d'un rapport

    Pour récupérer les métadonnées d'un rapport, suivez les instructions de votre méthode préférée :

    gcloud

    Utilisez la commande gcloud beta app-optimize reports describe pour obtenir les métadonnées d'un rapport.

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

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du Google Cloud projet propriétaire de la ressource de rapport que vous souhaitez récupérer.
    • REPORT_ID : ID du rapport à récupérer. Cet ID a été spécifié lors de la création du rapport et peut être obtenu en listant les rapports.

    Python

    Le code Python suivant utilise AppOptimizeClient.get_report() pour obtenir les métadonnées d'un rapport.

    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)

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du Google Cloud projet propriétaire de la ressource de rapport que vous souhaitez récupérer.
    • REPORT_ID : ID du rapport à récupérer. Cet ID a été spécifié lors de la création du rapport et peut être obtenu en listant les rapports.

    REST

    Utilisez la commande curl suivante pour obtenir les métadonnées du rapport :

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

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du Google Cloud projet propriétaire de la ressource de rapport que vous souhaitez récupérer.
    • REPORT_ID : ID du rapport à récupérer. Cet ID a été spécifié lors de la création du rapport et peut être obtenu en listant les rapports.

    Si la requête aboutit, l'API renvoie une réponse JSON contenant les métadonnées du rapport. Voici un exemple de réponse réussie, incluant la dimension et la métrique sélectionnées, le champ d'application du projet et la date d'expiration prévue du rapport :

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

    Étapes suivantes