Method: spaces.members.list

Muestra una lista de las membresías de un espacio. Para ver un ejemplo, consulta Cómo mostrar una lista de usuarios y apps de Google Chat en un espacio. Ficha de membresías con autenticación de app indica las membresías en espacios a los que la app de Chat tiene acceso, pero excluye las membresías de la app de Chat, incluidas las propias. La lista de membresías con autenticación del usuario muestra las membresías en los espacios a los que el usuario autenticado tiene acceso.

Admite los siguientes tipos de autenticación:

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. El nombre del recurso del espacio para el que se recuperará una lista de membresías.

Formato: spaces/{space}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de membresías que se mostrarán. Es posible que el servicio muestre menos valores que este.

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. Un token de página, recibido 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. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

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

Para filtrar por rol, establece role en ROLE_MEMBER o ROLE_MANAGER.

Para filtrar por tipo, establece member.type en HUMAN o BOT. También puedes filtrar 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 los demás 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 muestra las membresías asociadas con un Google Group, además de otros tipos de membresías. Si se configura una filter, no se mostrarán las membresías de Google Group que no coincidan con los criterios de filtro.
showInvited

boolean

Opcional. Cuando es true, también muestra las membresías asociadas con los miembros invited, además de otros tipos de membresías. Si se configura un filtro, no se mostrarán 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 realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

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

No se admiten las 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

Respuesta para mostrar las 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 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 posteriores.

Alcances 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.import
  • https://www.googleapis.com/auth/chat.bot
  • 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.