Method: spaces.list

Muestra una lista de los espacios de los que es miembro el llamador. Los chats en grupo y los MD no se muestran hasta que se envía el primer mensaje. Para ver un ejemplo, consulta Cómo enumerar espacios.

Admite los siguientes tipos de autenticación:

  • Autenticación de la app con el alcance de autorización:

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

  • 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

Para enumerar todos los espacios nombrados por 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. Es la cantidad máxima de espacios que se mostrarán. Es posible que el servicio devuelva menos de este valor.

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

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

Los valores negativos muestran un error INVALID_ARGUMENT.
pageToken

string

Opcional. Es un token de página, recibido desde una llamada a list spaces anterior. 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 página. Pasar un valor diferente puede generar resultados inesperados.
filter

string

Opcional. Un filtro de búsqueda.

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 varios tipos de espacios, 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

Es la respuesta de 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)

Es la lista de espacios de la página solicitada (o primera). Nota: El campo permissionSettings no se muestra en el objeto Space para las solicitudes de lista.
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.

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