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 API App Optimize para receber 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, leia os dados do relatório.

Antes de começar

gcloud

No console do Google Cloud , ative o Cloud Shell.

Ativar o Cloud Shell

Na parte de baixo do console Google Cloud , uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

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

Python

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

  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 CLI do Google Cloud.

    2. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

    3. Se você estiver usando um shell local, crie credenciais de autenticação local para sua conta de usuário: 

      gcloud auth application-default login

      Não é necessário fazer isso se você estiver usando o Cloud Shell.

      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.

    Para mais informações, consulte 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 executado no Google Cloud na documentação de autenticação do Google Cloud .

REST

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

    Instale a CLI do Google Cloud.

    Ao usar um provedor de identidade (IdP) externo, primeiro 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 executado no Google Cloud na documentação de autenticação do 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 do App Optimize (roles/appoptimize.viewer) no projeto que possui o recurso de 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 papéis personalizados ou outros papéis predefinidos.

Receber metadados do relatório

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

gcloud

Use o comando gcloud beta app-optimize reports describe para receber 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 tem o recurso de 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 relatórios.

Python

O código Python a seguir usa AppOptimizeClient.get_report() para receber 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 tem o recurso de 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 relatórios.

REST

Use o seguinte comando curl para receber 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 tem o recurso de 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 relatórios.

Se a solicitação for bem-sucedida, a API vai retornar uma resposta JSON com 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 expira:

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