Method: spaces.list

Muestra los espacios a los que pertenece el emisor. Los chats en grupo y los MD no aparecen en la lista hasta que se envía el primer mensaje. Para ver un ejemplo, consulta Enumera los espacios.

Requiere autenticación. Es totalmente compatible con la autenticación de cuentas de servicio, y la autenticación de usuarios requiere el permiso de autorización chat.spaces o chat.spaces.readonly.

Enumera los espacios visibles para el emisor o el usuario autenticado. Los chats en grupo y los MD no aparecen en la lista hasta que se envía el primer mensaje.

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. Si usas un valor superior a 1,000, 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 espacios de lista. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza 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.

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

Para filtrar por tipo de espacio, debes especificar un valor de enumeración válido, como SPACE o GROUP_CHAT (el spaceType no puede ser SPACE_TYPE_UNSPECIFIED). Para consultar 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.

Con la autenticación de la cuenta de servicio, se ignora este campo 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 se siguen rechazando las consultas no válidas.

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

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

Permisos de 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.