- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- Pruébala
Muestra una lista de las membresías de un espacio. Para ver un ejemplo, consulta Cómo enumerar usuarios y apps de Google Chat de un espacio. En las fichas de membresías con autenticación de app, se enumeran las membresías en espacios a los que tiene acceso la app de Chat, pero se excluyen las membresías de la app de Chat, incluidas las propias. En las fichas de membresías con autenticación de usuarios, se enumeran las membresías en los espacios a los que tiene acceso el usuario autenticado.
Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios.
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 |
Obligatorio. El nombre de recurso del espacio para el que se recupera una lista de membresía. Formato: espacios/{space} |
Parámetros de consulta
Parámetros | |
---|---|
pageSize |
Opcional. La cantidad máxima de membresías que se mostrarán. Es posible que el servicio muestre menos que 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 |
pageToken |
Opcional. 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 se utiliza 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 |
Opcional. Un filtro de consulta. Puedes filtrar las membresías por la función ( Para filtrar por función, establece Para filtrar por tipo, establece Para filtrar por rol y tipo, usa el operador Se requiere Por ejemplo, las siguientes consultas son válidas:
Las siguientes consultas no son válidas:
El servidor rechaza las consultas no válidas con un error |
showGroups |
Opcional. Cuando es |
showInvited |
Opcional. Cuando Actualmente requiere la autenticación del usuario. |
useAdminAccess |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que llama debe ser un administrador de Google Workspace con el privilegio para administrar las conversaciones del chat y los espacios. Requiere el permiso de OAuth 2.0 No se admite mostrar 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 enumerar 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 ( |
Campos | |
---|---|
memberships[] |
Lista sin ordenar. Lista de membresías en la página solicitada (o primera). |
nextPageToken |
Un token que puedes enviar como |
Alcances de autorización
Se necesita uno de los siguientes alcances 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.