Method: spaces.list

Enumera los espacios de los que es miembro el emisor. Los chats en grupo y los MD no aparecerán hasta que se envíe el primer mensaje. Para ver un ejemplo, consulta Crea una lista de espacios.

Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios.

Muestra una lista de los espacios visibles para el emisor o el usuario autenticado. Los chats en grupo y los MD no aparecerán hasta que se envíe el primer mensaje.

Para enumerar todos los espacios con nombre de la organización de Google Workspace, usa el método spaces.search() con los privilegios de administrador de Workspace.

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 valores que este.

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

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambia automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.
pageToken

string

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

Durante 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

Puedes filtrar los espacios por tipo de espacio (spaceType).

Para filtrar por tipo de espacio, debes especificar un valor de enumeración válido, como SPACE o GROUP_CHAT (spaceType no puede ser SPACE_TYPE_UNSPECIFIED). Para consultar sobre varios tipos de espacio, usa el operador OR.

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.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta para una solicitud de lista de espacios.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá 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 la primera).
nextPageToken

string

Puedes enviar un token como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

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.bot

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