Method: alerts.list

Lista os alertas.

Solicitação HTTP

GET https://alertcenter.googleapis.com/v1beta1/alerts

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
customerId

string

Opcional. O identificador exclusivo da conta do Google Workspace do cliente a que os alertas estão associados. O customerId precisa ter o "C" inicial removido (por exemplo, 046psxkn). Inferido da identidade do autor da chamada, se não for fornecido. Encontre seu ID de cliente.

pageSize

integer

Opcional. O tamanho da página solicitado. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.

pageToken

string

Opcional. Um token que identifica a página de resultados que o servidor retornará. Se estiver vazio, uma nova iteração será iniciada. Para continuar uma iteração, transmita o valor do campo nextPageToken da ListAlertsResponse anterior.

filter

string

Opcional. Uma string de consulta para filtrar resultados de alertas. Para mais detalhes, consulte Filtros de consulta e Campos de filtro de consulta compatíveis.

orderBy

string

Opcional. A ordem de classificação dos resultados da lista. Se não for especificado, os resultados podem ser retornados em ordem arbitrária. É possível classificar os resultados em ordem decrescente com base no carimbo de data/hora de criação usando orderBy="createTime desc". Atualmente, a classificação aceita é createTime asc, createTime desc, updateTime desc

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para uma solicitação de listagem de alertas.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string
}
Campos
alerts[]

object (Alert)

A lista de alertas.

nextPageToken

string

O token para a próxima página. Se não estiver vazio, indica que pode haver mais alertas correspondentes à solicitação de listagem. Esse valor pode ser usado em uma ListAlertsRequest subsequente para receber alertas que continuam a partir do último resultado da chamada da lista atual.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/apps.alerts

Para mais informações, consulte o Guia de autorização.