Receber os metadados de um relatório

Para inspecionar as configurações de um relatório, como escopo e métricas, ou verificar o tempo de expiração, use a App Optimize API para acessar os metadados do relatório.

Essa solicitação de API não retorna as linhas de dados reais no relatório. Para baixar essas informações, é necessário ler os dados do relatório.

Antes de começar

gcloud

  • Instale a Google Cloud CLI.

  • Configure a CLI gcloud para usar sua identidade federada.

    Para mais informações, consulte Fazer login na CLI gcloud com sua identidade federada.

  • Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

  • Depois de inicializar a CLI gcloud, atualize-a e instale os componentes necessários: 

    gcloud components update
gcloud components install beta

    • Para informações sobre como configurar a autenticação em um ambiente de produção, consulte Configurar o Application Default Credentials para código em execução em Google Cloud na documentação de autenticação. Google Cloud

    Python

    1. Instale a biblioteca de cliente Python para a App Optimize API.

    2. Para usar os exemplos do Python nesta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.

      1. Instale a Google Cloud CLI.

      2. Configure a CLI gcloud para usar sua identidade federada.

        Para mais informações, consulte Fazer login na CLI gcloud com sua identidade federada.

      3. Crie credenciais de autenticação local para sua conta de usuário: 

        gcloud auth application-default login

        Se um erro de autenticação for retornado e você estiver usando um provedor de identidade (IdP) externo, confirme se você fez login na CLI gcloud com sua identidade federada.

      Saiba mais em Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .

      Para informações sobre como configurar a autenticação em um ambiente de produção, consulte Configurar o Application Default Credentials para código em execução em Google Cloud na documentação de autenticação. Google Cloud

    REST

    Para usar as amostras da API REST desta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para a CLI gcloud.

      Instale a Google Cloud CLI e faça login na CLI gcloud com sua identidade federada.

    Saiba mais em Autenticar para usar REST na documentação de autenticação do Google Cloud .

    Para informações sobre como configurar a autenticação em um ambiente de produção, consulte Configurar o Application Default Credentials para código em execução em Google Cloud na documentação de autenticação. Google Cloud

    Funções exigidas

    Para receber as permissões necessárias para ler os metadados de um relatório, peça ao administrador para conceder a você o papel do IAM de Leitor da App Optimize (roles/appoptimize.viewer) no projeto que possui o recurso do relatório. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

    Também é possível conseguir as permissões necessárias usando personalizados papéis ou outros predefinidos papéis.

    Acessar metadados do relatório

    Para recuperar os metadados de um relatório, siga as instruções do método preferido:

    gcloud

    Use o comando gcloud beta app-optimize reports describe para acessar os metadados de um relatório.

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

    Substitua:

    • PROJECT_ID: o ID do Google Cloud projeto que possui o recurso do relatório que você quer recuperar.
    • REPORT_ID: o ID do relatório a ser recuperado. Esse ID foi especificado quando o relatório foi criado e pode ser obtido listando os relatórios.

    Python

    O código Python a seguir usa AppOptimizeClient.get_report() para acessar os metadados de um relatório.

    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)

    Substitua:

    • PROJECT_ID: o ID do Google Cloud projeto que possui o recurso do relatório que você quer recuperar.
    • REPORT_ID: o ID do relatório a ser recuperado. Esse ID foi especificado quando o relatório foi criado e pode ser obtido listando os relatórios.

    REST

    Use o comando curl a seguir para acessar os metadados do relatório:

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

    Substitua:

    • PROJECT_ID: o ID do Google Cloud projeto que possui o recurso do relatório que você quer recuperar.
    • REPORT_ID: o ID do relatório a ser recuperado. Esse ID foi especificado quando o relatório foi criado e pode ser obtido listando os relatórios.

    Se a solicitação for bem-sucedida, a API vai retornar uma resposta JSON contendo os metadados do relatório. Confira um exemplo de resposta bem-sucedida, incluindo a dimensão e a métrica selecionadas, o escopo do projeto e quando o relatório está programado para expirar:

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

    A seguir