Listar relatórios

Gerencie seus relatórios da App Optimize API de maneira eficaz listando todas as configurações de relatório no seuprojeto. Google Cloud Isso ajuda a identificar um relatório específico para ler os dados ou excluí-lo antes da data de validade, se ele não for mais necessário.

A operação de lista retorna os metadados do relatório, incluindo o nome do recurso, o escopo, as dimensões, as métricas e o tempo de expiração de cada relatório. Para baixar as informações de custo e uso solicitadas, é necessário ler os dados do relatório.

Antes de começar

gcloud

No Google Cloud console, ative o Cloud Shell.

Ativar o Cloud Shell

Na parte de baixo do Google Cloud console, uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a Google Cloud CLI 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 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 desta 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. 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.

    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.

    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 em execução em Google Cloud na documentação de autenticação. Google Cloud

Funções exigidas

Para ter as permissões necessárias para listar os recursos de relatório de um projeto, peça ao administrador para conceder a você o papel do IAM de Leitor do App Optimize (roles/appoptimize.viewer) no projeto. 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.

Listar relatórios

Para listar relatórios em um projeto, siga as instruções do seu método preferido:

gcloud

Use o comando gcloud beta app-optimize reports list para listar os relatórios em um projeto.

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

Substitua PROJECT_ID pelo ID do Google Cloud projeto que contém os recursos de relatório que você quer listar.

O comando gcloud processa a paginação automaticamente, retornando todos os recursos solicitados.

Python

O código Python a seguir usa AppOptimizeClient.list_reports() para mostrar uma lista de relatórios em um projeto.

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)

Substitua PROJECT_ID pelo ID do Google Cloud projeto que contém os recursos de relatório que você quer listar.

A biblioteca de cliente processa a paginação automaticamente, gerando resultados do iterador.

REST

Use o comando curl a seguir para listar os relatórios de um projeto:

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

Substitua:

  • PROJECT_ID: o ID do Google Cloud projeto que contém os recursos de relatório que você quer listar.
  • PAGE_SIZE: o número máximo de relatórios a serem retornados por página. Se omitido, a API usará um valor padrão. O servidor pode retornar menos relatórios do que o solicitado.

Se a solicitação for bem-sucedida, a API retornará uma resposta JSON contendo uma lista de recursos de relatório. Confira um exemplo de resposta de chamada bem-sucedida:

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

A matriz reports contém os metadados de cada relatório. Se a solicitação não for bem-sucedida, revise a mensagem de erro retornada pela API.

Se a resposta incluir uma string nextPageToken, significa que há mais relatórios a serem recuperados.

Verifique a resposta de um campo nextPageToken. Se o token existir, execute o comando curl a seguir para recuperar a próxima página, incluindo o parâmetro de consulta pageToken. Você pode continuar usando o parâmetro 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"

Substitua:

  • NEXT_PAGE_TOKEN: o valor do nextPageToken recebido na resposta anterior.
  • PAGE_SIZE: o tamanho da página desejado para esta solicitação.

Repita esse processo até que a resposta não contenha mais um nextPageToken, o que indica que você recuperou todos os relatórios.

A seguir