Obtén los metadatos de un informe

Para inspeccionar la configuración de un informe, como su alcance y sus métricas, o para verificar su hora de vencimiento, usa la API de App Optimize para obtener los metadatos del informe.

Esta solicitud a la API no devuelve las filas de datos reales dentro del informe. Para descargar esta información, debes leer los datos del informe.

Antes de comenzar

gcloud

En la consola de Google Cloud , activa Cloud Shell.

Activa Cloud Shell

En la parte inferior de la consola de Google Cloud , se inicia una sesión de Cloud Shell que muestra una ventana emergente con una línea de comandos. Cloud Shell es un entorno de shell con Google Cloud CLI ya instalada y con valores ya establecidos para el proyecto actual. La sesión puede tardar unos segundos en inicializarse.

Para obtener información sobre cómo configurar la autenticación para un entorno de producción, consulta Configura las credenciales predeterminadas de la aplicación para el código que se ejecuta en Google Cloud en la documentación de autenticación de Google Cloud .

Python

  1. Instala la biblioteca cliente de Python para la API de App Optimize.

  2. Para usar las muestras de Python de esta página en un entorno de desarrollo local, instala e inicializa la gcloud CLI y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.

    1. Instala Google Cloud CLI.

    2. Si usas un proveedor de identidad (IdP) externo, primero debes acceder a gcloud CLI con tu identidad federada.

    3. Si usas un shell local, crea credenciales de autenticación locales para tu cuenta de usuario: 

      gcloud auth application-default login

      No es necesario que lo hagas si usas Cloud Shell.

      Si se devuelve un error de autenticación y usas un proveedor de identidad (IdP) externo, confirma que accediste a la gcloud CLI con tu identidad federada.

    Para obtener más información, consulta Configura ADC para un entorno de desarrollo local en la documentación de autenticación de Google Cloud .

    Para obtener información sobre cómo configurar la autenticación para un entorno de producción, consulta Configura las credenciales predeterminadas de la aplicación para el código que se ejecuta en Google Cloud en la documentación de autenticación de Google Cloud .

REST

Para usar las muestras de la API de REST incluidas en esta página en un entorno de desarrollo local, debes usar las credenciales que proporciones a la gcloud CLI.

    Instala Google Cloud CLI.

    Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

Para obtener más información, consulta Autentícate para usar REST en la documentación de autenticación de Google Cloud .

Para obtener información sobre cómo configurar la autenticación para un entorno de producción, consulta Configura las credenciales predeterminadas de la aplicación para el código que se ejecuta en Google Cloud en la documentación de autenticación de Google Cloud .

Roles obligatorios

Para obtener los permisos que necesitas para leer los metadatos de un informe, pídele a tu administrador que te otorgue el rol de IAM Visualizador de App Optimize (roles/appoptimize.viewer) en el proyecto propietario del recurso del informe. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

Obtén metadatos del informe

Para recuperar los metadatos de un informe, sigue las instrucciones del método que prefieras:

gcloud

Usa el comando gcloud beta app-optimize reports describe para obtener los metadatos de un informe.

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

Reemplaza lo siguiente:

  • PROJECT_ID: Es el ID del Google Cloud proyecto que posee el recurso del informe que deseas recuperar.
  • REPORT_ID: Es el ID del informe que se recuperará. Este ID se especificó cuando se creó el informe y se puede obtener enumerando los informes.

Python

El siguiente código de Python usa AppOptimizeClient.get_report() para obtener los metadatos de un informe.

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)

Reemplaza lo siguiente:

  • PROJECT_ID: Es el ID del Google Cloud proyecto que posee el recurso del informe que deseas recuperar.
  • REPORT_ID: Es el ID del informe que se recuperará. Este ID se especificó cuando se creó el informe y se puede obtener enumerando los informes.

REST

Usa el siguiente comando curl para obtener los metadatos del informe:

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

Reemplaza lo siguiente:

  • PROJECT_ID: Es el ID del Google Cloud proyecto que posee el recurso del informe que deseas recuperar.
  • REPORT_ID: Es el ID del informe que se recuperará. Este ID se especificó cuando se creó el informe y se puede obtener enumerando los informes.

Si la solicitud se realiza correctamente, la API devuelve una respuesta en formato JSON que contiene los metadatos del informe. A continuación, se muestra un ejemplo de una respuesta correcta, que incluye la dimensión y la métrica seleccionadas, el alcance del proyecto y la fecha de vencimiento programada del informe:

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

¿Qué sigue?