En esta guía, se explica cómo usar el método get()
en el recurso Membership
de la API de Google Chat para obtener detalles sobre una membresía en un espacio.
Si eres administrador de Google Workspace, puedes llamar al método get()
para recuperar detalles sobre cualquier membresía de tu organización de Google Workspace.
El
recurso Membership
representa si un usuario humano o la app de Google Chat están invitados a un espacio, forman parte de él o no están presentes.
La autenticación con autenticación de apps permite que una app de Chat obtenga membresías de los espacios a los que tiene acceso en Google Chat (por ejemplo, espacios de los que es miembro), pero excluye las membresías de la app de Chat, incluidas las propias. La autenticación con autenticación del usuario muestra las membresías de los espacios a los que tiene acceso el usuario autenticado.
Requisitos previos
Node.js
- Una cuenta de Google Workspace para empresas o empresas con acceso a Google Chat
- Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Instala la biblioteca cliente de Cloud para Node.js.
- Crea credenciales de acceso según la forma en que deseas autenticarte en tu solicitud a la API de Google Chat:
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
client_secrets.json
en tu directorio local. - Para autenticarte como la app de Chat, crea las credenciales de la cuenta de servicio y guárdalas como un archivo JSON llamado
credentials.json
.
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
- Elige un permiso de autorización según si quieres autenticarte como usuario o como la app de Chat.
- Un espacio de Google Chat del que sea miembro el usuario autenticado o la app de Chat que realiza la llamada. Para autenticarte como la app de Chat, agrégala al espacio.
Python
- Una cuenta de Google Workspace para empresas o empresas con acceso a Google Chat
- Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Instala la biblioteca cliente de Cloud de Python.
- Crea credenciales de acceso según la forma en que deseas autenticarte en tu solicitud a la API de Google Chat:
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
client_secrets.json
en tu directorio local. - Para autenticarte como la app de Chat,
crea credenciales de cuenta de servicio y guárdalas como un archivo JSON con el nombre
credentials.json
.
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
- Elige un alcance de autorización según si quieres autenticarte como usuario o como la app de Chat.
- Un espacio de Google Chat del que sea miembro el usuario autenticado o la app de Chat que realiza la llamada. Para autenticarte como la app de Chat, agrégala al espacio.
Java
- Una cuenta empresarial o empresarial de Google Workspace con acceso a Google Chat
- Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Instala la biblioteca cliente de Cloud para Java.
- Crea credenciales de acceso según la forma en que deseas autenticarte en tu solicitud a la API de Google Chat:
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
client_secrets.json
en tu directorio local. - Para autenticarte como la app de Chat,
crea credenciales de cuenta de servicio y guárdalas como un archivo JSON con el nombre
credentials.json
.
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
- Elige un permiso de autorización según si quieres autenticarte como usuario o como la app de Chat.
- Un espacio de Google Chat del que sea miembro el usuario autenticado o la app de Chat que realiza la llamada. Para autenticarte como la app de Chat, agrégala al espacio.
Apps Script
- Una cuenta de Google Workspace para empresas o empresas con acceso a Google Chat
- Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Crea un proyecto independiente de Apps Script y activa el Servicio de chat avanzado.
- En esta guía, debes usar la autenticación del usuario o de la app. Para autenticar como la app de Chat, crea credenciales de cuenta de servicio. Para conocer los pasos, consulta Autentícate y autoriza como una app de Google Chat.
- Elige un permiso de autorización según si quieres autenticarte como usuario o como la app de Chat.
- Un espacio de Google Chat en el que es miembro el usuario autenticado o la app de Chat que realiza la llamada. Para autenticarte como la app de Chat, agrégala al espacio.
Cómo obtener detalles sobre una membresía
Para obtener detalles sobre una membresía en Google Chat, pasa lo siguiente en tu solicitud:
- Con la autenticación de la app, especifica el alcance de la autorización
chat.bot
. Con la autenticación de usuarios, especifica el permiso de autorizaciónchat.memberships.readonly
ochat.memberships
. Como práctica recomendada, elige el permiso más restrictivo que aún permita que tu app funcione. - Realiza una llamada al método
GetMembership()
. - Pasa el
name
de la membresía que deseas obtener. Obtén el nombre de la membresía del recurso de membresía de Google Chat.
Obtén una membresía con autenticación de usuario
Sigue estos pasos para obtener una membresía con la autenticación de usuarios:
Node.js
Python
Java
Apps Script
Para ejecutar esta muestra, reemplaza lo siguiente:
SPACE_NAME
: Es el ID delname
del espacio. Puedes obtener el ID llamando al métodoListSpaces()
o desde la URL del espacio.MEMBER_NAME
: Es el ID delname
del miembro. Para obtener el ID, llama al métodoListMemberships()
.
La API de Chat muestra una instancia de Membership
que detalla la membresía especificada.
Obtén una membresía con autenticación de apps
Sigue estos pasos para obtener una membresía con la autenticación de apps:
Node.js
Python
Java
Apps Script
Para ejecutar esta muestra, reemplaza lo siguiente:
SPACE_NAME
: Es el ID delname
del espacio. Para obtener el ID, llama al métodoListSpaces()
o desde la URL del espacio.MEMBER_NAME
: Es el ID delname
del miembro. Para obtener el ID, llama al métodoListMemberships()
.
La API de Chat muestra una instancia de Membership
que detalla la membresía especificada.
Obtén detalles sobre las membresías como administrador de Google Workspace
Si eres administrador de Google Workspace, puedes llamar al método GetMembership()
para recuperar detalles sobre una membresía de cualquier usuario de tu organización de Google Workspace.
Para llamar a este método como administrador de Google Workspace, haz lo siguiente:
- Llama al método con la autenticación del usuario y especifica un alcance de autorización que admita llamar al método con privilegios de administrador.
- En tu solicitud, especifica el parámetro de consulta
useAdminAccess
comotrue
.
Para obtener más información y ejemplos, consulta Cómo administrar espacios de Google Chat como administrador de Google Workspace.
Temas relacionados
- Enumera los miembros de un espacio.
- Invitar o agregar un usuario o una app de Chat a un espacio
- Actualiza la membresía de un usuario en un espacio de Google Chat.
- Quitar un usuario o una app de Chat de un espacio