Method: spaces.spaceEvents.list

Muestra una lista de eventos de un espacio de Google Chat. Para cada evento, la carga útil contiene la versión más reciente del recurso de Chat. Por ejemplo, si enumeras eventos sobre miembros nuevos del espacio, el servidor muestra recursos Membership que contienen los detalles más recientes de la membresía. Si se quitaron miembros nuevos durante el período solicitado, la carga útil del evento contendrá un recurso Membership vacío.

Requiere autenticación del usuario. Para mostrar una lista de eventos, el usuario autenticado debe ser miembro del espacio.

Para ver un ejemplo, consulta Cómo crear una lista de eventos de un espacio de Google Chat.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso del espacio de Google Chat en el que ocurrieron los eventos.

Formato: spaces/{space}.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de eventos de espacio que se devuelven. Es posible que el servicio muestre menos valores que este.

Los valores negativos muestran un error INVALID_ARGUMENT.
pageToken

string

Opcional. Es un token de página, recibido desde una llamada a eventos de espacio de lista anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados a los eventos de lista de espacios deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.
filter

string

Obligatorio. Un filtro de consulta

Debes especificar al menos un tipo de evento (eventType) con el operador tiene :. Para filtrar por varios tipos de eventos, usa el operador OR. Omite los tipos de eventos por lotes en tu filtro. La solicitud muestra automáticamente todos los eventos de lotes relacionados. Por ejemplo, si filtras por reacciones nuevas (google.workspace.chat.reaction.v1.created), el servidor también muestra eventos de reacciones nuevas por lotes (google.workspace.chat.reaction.v1.batchCreated). Para obtener una lista de los tipos de eventos admitidos, consulta la documentación de referencia de SpaceEvents.

De manera opcional, también puedes filtrar por hora de inicio (startTime) y hora de finalización (endTime):

  • startTime: Es una marca de tiempo exclusiva desde la que se comienzan a enumerar los eventos espaciales. Puedes enumerar los eventos que ocurrieron hasta 28 días antes. Si no se especifica, se muestran los eventos de espacio de los últimos 28 días.
  • endTime: Es la marca de tiempo inclusiva hasta la que se enumeran los eventos espaciales. Si no se especifica, se enumeran los eventos hasta el momento de la solicitud.

Para especificar una hora de inicio o finalización, usa el operador igual = y el formato RFC-3339. Para filtrar por startTime y endTime, usa el operador AND.

Por ejemplo, las siguientes consultas son 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")

Las siguientes consultas no son vá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"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para enumerar los eventos del espacio.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Campos
spaceEvents[]

object (SpaceEvent)

Los resultados se muestran en orden cronológico (el evento más antiguo primero). Nota: El campo permissionSettings no se muestra en el objeto Space para las solicitudes de lista.
nextPageToken

string

Es el token de Continuation que se usa para recuperar más eventos. Si se omite este campo, no habrá páginas siguientes.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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 obtener más información, consulta la Guía de autorización.