Method: spaces.spaceEvents.list

Lista eventos de um espaço do Google Chat. Para cada evento, o payload contém a versão mais recente do recurso do Chat. Por exemplo, se você listar eventos sobre novos participantes do espaço, o servidor retornará recursos Membership que contêm os detalhes mais recentes da associação. Se os novos membros forem removidos durante o período solicitado, o payload do evento conterá um recurso Membership vazio.

Exige a autenticação do usuário. Para isso, o usuário autenticado precisa participar do espaço.

Para conferir um exemplo, consulte Listar eventos de um espaço do Google Chat.

Solicitação HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Nome do recurso do espaço do Google Chat onde os eventos ocorreram.

Formato: spaces/{space}.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de eventos de espaço retornados. O serviço pode retornar menos que esse valor.

Valores negativos retornam um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Um token de página, recebido de uma chamada anterior de eventos do espaço de lista. Forneça isso para recuperar a página subsequente.

Na paginação, todos os outros parâmetros enviados para listar eventos de espaço precisam corresponder à chamada que forneceu o token da página. A transmissão de valores diferentes para os outros parâmetros pode gerar resultados inesperados.
filter

string

Obrigatório. Um filtro de consulta.

É necessário especificar pelo menos um tipo de evento (eventType) usando o operador :. Para filtrar por vários tipos de evento, use o operador OR. Omita tipos de eventos em lote no filtro. A solicitação retorna automaticamente todos os eventos em lote relacionados. Por exemplo, se você filtrar por novas reações (google.workspace.chat.reaction.v1.created), o servidor também vai retornar eventos de novas reações em lote (google.workspace.chat.reaction.v1.batchCreated). Para conferir uma lista de tipos de eventos com suporte, consulte a documentação de referência da SpaceEvents.

Também é possível filtrar por horário de início (startTime) e de término (endTime):

  • startTime: carimbo de data/hora exclusivo a partir do qual os eventos de espaço serão listados. Você pode listar eventos que ocorreram há até 28 dias. Se não for especificado, lista os eventos do espaço dos últimos 28 dias.
  • endTime: carimbo de data/hora inclusive até que os eventos do espaço são listados. Se não for especificado, lista os eventos até o momento da solicitação.

Para especificar um horário de início ou término, use o operador = igual e o formato em RFC-3339. Para filtrar por startTime e endTime, use o operador AND.

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

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

As consultas a seguir são inválidas:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

As consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para listar eventos do espaço.

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

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

object (SpaceEvent)

Os resultados são retornados em ordem cronológica (o evento mais antigo primeiro). Observação: o campo permissionSettings não é retornado no objeto de espaço para solicitações de lista.
nextPageToken

string

Token de continuação usado para buscar mais eventos. 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.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.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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