Method: spaces.members.list

Enumera las membresías en un espacio. Para ver un ejemplo, consulta Cómo enumerar usuarios y apps de Google Chat en un espacio. En la lista de membresías con autenticación de la app, se incluyen las membresías en los espacios a los que tiene acceso la app de Chat, pero se excluyen las membresías de la app de Chat, incluida la suya. La opción User authentication de la lista de membresías muestra las membresías en los espacios a los que tiene acceso el usuario autenticado.

Admite los siguientes tipos de autenticación:

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

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

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación)
    • La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, useAdminAccess es true y se usa uno de los siguientes permisos de autorización:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

Solicitud HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

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 para el que se recuperará una lista de miembros.

Formato: spaces/{space}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de membresías que se devolverán. El servicio puede devolver menos que este valor.

Si no se especifica, se devuelven, como máximo, 100 membresías.

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 que se recibió de una llamada anterior para enumerar membresías. Proporciona este parámetro para recuperar la página siguiente.

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

string

Opcional. Es un filtro de búsqueda.

Puedes filtrar las membresías por el rol (role) y el tipo (member.type) de un miembro.

Para filtrar por rol, configura role como ROLE_MEMBER o ROLE_MANAGER.

Para filtrar por tipo, establece member.type en HUMAN o BOT. También puedes filtrar por member.type con el operador !=.

Para filtrar por rol y tipo, usa el operador AND. Para filtrar por rol o tipo, usa el operador OR.

Se requiere member.type = "HUMAN" o member.type != "BOT" cuando useAdminAccess se establece como verdadero. Se rechazarán otros filtros de tipo de miembro.

Por ejemplo, las siguientes consultas son válidas:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Las siguientes consultas no son válidas:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

boolean

Opcional. Cuando es true, también devuelve las membresías asociadas a un Google Group, además de otros tipos de membresías. Si se establece un filter, no se devuelven las membresías de Google Group que no coinciden con los criterios del filtro.
showInvited

boolean

Opcional. Cuando es true, también devuelve las membresías asociadas a los miembros de invited, además de otros tipos de membresías. Si se establece un filtro, no se devuelven las membresías de invited que no coinciden con los criterios del filtro.

Actualmente, requiere autenticación del usuario.
useAdminAccess

boolean

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que llama debe ser administrador de Google Workspace y tener el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.memberships.readonly o chat.admin.memberships.

No se admite la inclusión de membresías de apps en un espacio cuando se usa el acceso de administrador.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta a la lista de membresías del espacio.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

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

object (Membership)

Lista sin ordenar. Es la lista de membresías en la página solicitada (o en la primera).
nextPageToken

string

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

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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