Method: spaces.spaceEvents.list

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

Admite los siguientes tipos de autenticación con un alcance de autorización adecuado para leer los datos solicitados:

  • Autenticación de la app con aprobación del administrador en la versión preliminar para desarrolladores con uno de los siguientes permisos de autorización:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

  • Autenticación de usuarios con uno de los siguientes permisos de autorización:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Para enumerar eventos, el emisor autenticado debe ser miembro del espacio.

Para ver un ejemplo, consulta Cómo enumerar 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 se produjeron 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. El servicio puede devolver una cantidad inferior a este valor.

Los valores negativos muestran un error INVALID_ARGUMENT.
pageToken

string

Opcional. Es un token de página que se recibió de una llamada a list space events anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados a list space events deben guardar correspondencia con la llamada que proporcionó el token de la página. Si pasas valores diferentes a los otros parámetros, es posible que obtengas resultados inesperados.
filter

string

Obligatorio. Es un filtro de consulta.

Debes especificar al menos un tipo de evento (eventType) con el operador has :. Para filtrar por varios tipos de eventos, usa el operador OR. Omite los tipos de eventos por lotes en tu filtro. La solicitud devuelve automáticamente cualquier evento de lote relacionado. Por ejemplo, si filtras por reacciones nuevas (google.workspace.chat.reaction.v1.created), el servidor también devuelve 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 la marca de tiempo exclusiva a partir de la cual se comenzará a enumerar los eventos de espacio. Puedes enumerar los eventos que ocurrieron hasta hace 28 días. Si no se especifica, se enumeran los eventos de espacio de los últimos 28 días.
  • endTime: Es la marca de tiempo inclusiva hasta la que se enumeran los eventos de espacio. 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

Es el 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 devuelve en el objeto Space para las solicitudes de lista.
nextPageToken

string

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

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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.