Method: spaces.members.list

Enumera las membresías en un espacio. Para ver un ejemplo, consulta Membresías de la lista. En las fichas de membresías con autenticación de apps, se detallan las membresías de los espacios a los que tiene acceso la app de Chat, pero se excluyen las membresías de la app de Chat, incluidas las propias. Enumera las membresías con autenticación de usuario para enumerar las membresías en espacios a los que el usuario autenticado tiene acceso.

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

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 cual se recupera una lista de membresía.

Formato: espacios/{espacio}

Parámetros de consulta

Parámetros
pageSize

integer

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

Si no se especifica, se muestran 100 membresías 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

Un token de página, recibido de una llamada anterior para enumerar las membresías. Proporciona este parámetro para recuperar la página siguiente.

Cuando realizas la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

Puedes filtrar membresías por función de miembro (role) y tipo (member.type).

Para filtrar por función, establece role en ROLE_MEMBER o ROLE_MANAGER.

Para filtrar por tipo, establece member.type en HUMAN o BOT.

Para filtrar por función y tipo, usa el operador AND. Para filtrar por función o tipo, usa el operador OR.

Por ejemplo, las siguientes consultas son válidas:

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

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 true, también muestra membresías asociadas con un Google Group, además de otros tipos de membresías. Si se establece una filter, no se mostrarán las membresías de Google Group que no coincidan con los criterios del filtro.

showInvited

boolean

Opcional. Cuando true, también muestra membresías asociadas con invited miembros, además de otros tipos de membresías. Si se configura un filtro, no se mostrarán las membresías de invited que no coincidan con los criterios del filtro.

Actualmente, requiere autenticación de usuario.

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 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Campos
memberships[]

object (Membership)

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

string

Un token que puedes enviar 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 alcances de OAuth:

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