Method: spaces.list

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Enumera los espacios a los que llama el miembro y que son visibles para el emisor o el usuario autenticado. Requiere autenticación. Es totalmente compatible con la autenticación de cuentas de servicio.

Solicitud HTTP

GET https://chat.googleapis.com/v1/spaces

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

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. La cantidad máxima de espacios que se mostrarán. Es posible que el servicio muestre menos de este valor.

Si no se especifica, se muestran 100 espacios como máximo.

El valor máximo es 1,000; los valores superiores a 1,000 se convierten en 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.

pageToken

string

Opcional. Un token de página, recibido de una llamada anterior a espacios de la lista. Proporciona esto para recuperar la página siguiente.

Cuando realices la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de la página. Pasar un valor diferente puede generar resultados inesperados.

filter

string

Opcional. Un filtro de consulta.

Requiere autenticación de usuario.

La API admite el filtrado por spaceType.

Por ejemplo, las siguientes consultas son válidas:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

Con la autenticación de la cuenta de servicio, este campo se ignora y la consulta siempre muestra todos los espacios. Sin embargo, la API de Chat aún valida la sintaxis de la consulta con las cuentas de servicio, por lo que las consultas no válidas se siguen rechazando.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

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

object (Space)

Lista de espacios en la página solicitada (o primera).

nextPageToken

string

Un token que se puede enviar como pageToken para recuperar la siguiente página de resultados. Si está vacía, no hay páginas posteriores.

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Para obtener más información, consulta la guía de autorización.