Method: subscriptions.list

Lista as assinaturas do Google Workspace. Para saber como usar esse método, consulte Listar assinaturas do Google Workspace.

Solicitação HTTP

GET https://workspaceevents.googleapis.com/v1/subscriptions

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

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de assinaturas a serem retornadas. O serviço pode retornar menos que esse valor.

Se não for especificado ou definido como 0, até 50 assinaturas serão retornadas.

O valor máximo é 100. Se você especificar um valor maior que 100, o sistema vai retornar apenas 100 assinaturas.
pageToken

string

Opcional. Um token de página recebido de uma chamada "list subscriptions" anterior. Forneça esse parâmetro para recuperar a página seguinte.

Na paginação, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Passar um valor diferente pode levar a resultados inesperados.
filter

string

Obrigatório. Um filtro de consulta.

É possível filtrar as assinaturas por tipo de evento (event_types) e recurso de destino (target_resource).

É preciso especificar pelo menos um tipo de evento na consulta. Para filtrar vários tipos de eventos, use o operador OR.

Para filtrar por tipo de evento e recurso de destino, use o operador AND e especifique o nome completo do recurso, como //chat.googleapis.com/spaces/{space}.

Por exemplo, as consultas a seguir são válidas:

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

O servidor rejeita consultas inválidas com um erro INVALID_ARGUMENT.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A mensagem de resposta para SubscriptionsService.ListSubscriptions.

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

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

object (Subscription)

Lista de assinaturas.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

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