En esta guía, se explica cómo usar el método create
en el recurso membership
de la API de Google Chat para invitar o agregar a un usuario, un Grupo de Google o
de Chat a un espacio, lo que también se conoce como crear un
membresía. Cuando creas una membresía, si el miembro especificado tiene su
política de aceptación automática desactivada, se lo invitará y deberá aceptar el espacio
antes de unirte. De lo contrario, si creas una membresía, se agregará al miembro.
directamente en el espacio especificado.
El
Recurso Membership
representa si se invita a un usuario humano o a una app de Google Chat
es parte de un espacio o está ausente.
Requisitos previos
Python
- Una empresa o empresa 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. y la descripción de tu app de Chat.
- Instala el Python Biblioteca cliente de las APIs de Google
-
Crea credenciales de ID de cliente de OAuth para una aplicación de escritorio. Para ejecutar la muestra
guarda las credenciales como un archivo JSON llamado
client_secrets.json
en tu directorio local.
- Elige un alcance de autorización que admita la autenticación de usuarios.
Node.js
- Una empresa o empresa 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. y la descripción de tu app de Chat.
- Instala el Node.js Biblioteca cliente de las APIs de Google
-
Crea credenciales de ID de cliente de OAuth para una aplicación de escritorio. Para ejecutar la muestra
guarda las credenciales como un archivo JSON llamado
client_secrets.json
en tu directorio local.
- Elige un alcance de autorización que admita la autenticación de usuarios.
Cómo invitar o agregar un usuario a un espacio
Para invitar o agregar un usuario a un espacio, pasa lo siguiente en tu solicitud:
- Especifica el alcance de la autorización
chat.memberships
. - Llama al
Método
create
en la Recursomembership
. - Establece
parent
en el nombre de recurso del espacio en el que se creará la membresía. - Establece
member
enusers/{user}
, donde{user}
es la persona que deseas. crear membresía para y es:- El ID de la
persona
en la API de People. Por ejemplo, si la API de People
persona
resourceName
espeople/123456789
; luego establecemembership.member.name
ausers/123456789
. - El ID de la usuario en la API de Directory.
- La dirección de correo electrónico del usuario. Por ejemplo,
users/222larabrown@gmail.com
ousers/larabrown@cymbalgroup.com
. Si el usuario utiliza una Cuenta de Google o pertenece a otra organización de Google Workspace, debes usar su dirección de correo electrónico.
- El ID de la
persona
en la API de People. Por ejemplo, si la API de People
persona
En el siguiente ejemplo, se agrega un usuario a un espacio:
Python
- En tu directorio de trabajo, crea un archivo llamado
chat_membership_user_create.py
Incluye el siguiente código en
chat_membership_user_create.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then adds a user to a Chat space by creating a membership. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().create( # The space in which to create a membership. parent = 'spaces/SPACE', # Specify which user the membership is for. body = { 'member': { 'name':'users/USER', 'type': 'HUMAN' } } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que que puedes obtener de la Métodospaces.list
en la API de Chat o desde la URL de un espacio.USER
: Es un ID de usuario.
En tu directorio de trabajo, compila y ejecuta la muestra:
python3 chat_membership_user_create.py
Node.js
- En el directorio de trabajo, crea un archivo llamado
add-user-to-space.js
. Incluye el siguiente código en
add-user-to-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Adds the user to the Chat space. * @return {!Promise<!Object>} */ async function addUserToSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.members.create({ parent: 'spaces/SPACE', requestBody: {member: {name: 'users/USER', type: 'HUMAN'}} }); } addUserToSpace().then(console.log);
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que puedes obtener del Métodospaces.list
en la API de Chat o desde la URL de un espacio.USER
: Es un ID de usuario.
En tu directorio de trabajo, ejecuta la muestra:
node add-user-to-space.js
La API de Chat devuelve una instancia de
membership
en la que se detalle la membresía de usuario que se creó.
Invita o agrega un Grupo de Google a un espacio
Para invitar o agregar un Grupo de Google a un espacio, pasa lo siguiente en tu solicitud:
- Especifica el alcance de la autorización
chat.memberships
. - Llama al
Método
create
en la Recursomembership
. - Establece
parent
en el nombre de recurso del espacio en el que se creará la membresía. - Establece
groupMember
comogroups/{group}
, donde{group}
es el ID del grupo que deseas. para la que quieres crear la membresía. El ID del grupo se puede recuperar con el API de Cloud Identity. Por ejemplo, si la API de Cloud Identity muestra un grupo con el nombregroups/123456789
y, luego, establecemembership.groupMember.name
agroups/123456789
.
No se pueden agregar Grupos de Google a un chat en grupo o un mensaje directo; solo a una espacio con nombre. En el siguiente ejemplo, se agrega un grupo a un espacio con nombre:
Python
- En tu directorio de trabajo, crea un archivo llamado
chat_membership_group_create.py
Incluye el siguiente código en
chat_membership_group_create.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then adds a group to a Chat space by creating a membership. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().create( # The named space in which to create a membership. parent = 'spaces/SPACE', # Specify which group the membership is for. body = { 'groupMember': { 'name':'groups/GROUP', } } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que que puedes obtener de la Métodospaces.list
en la API de Chat o desde la URL de un espacio.GROUP
: Es un ID de grupo.
En tu directorio de trabajo, compila y ejecuta la muestra:
python3 chat_membership_group_create.py
Node.js
- En el directorio de trabajo, crea un archivo llamado
add-group-to-space.js
. Incluye el siguiente código en
add-group-to-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Adds the group to the Chat space. * @return {!Promise<!Object>} */ async function addUserToSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.members.create({ parent: 'spaces/SPACE', requestBody: {groupMember: {name: 'groups/GROUP'}} }); } addUserToSpace().then(console.log);
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que puedes obtener del Métodospaces.list
en la API de Chat o desde la URL de un espacio.GROUP
: Es un ID de grupo.
En tu directorio de trabajo, ejecuta la muestra:
node add-group-to-space.js
La API de Chat devuelve una instancia de
membership
en la que se detalla la pertenencia a un grupo que se creó.
Agrega una app de Chat a un espacio
Una app de Chat no puede agregar otra app como miembro a un espacio. Para agregar una app de Chat a un espacio, sigue estos pasos: o un mensaje directo entre dos usuarios humanos, pasa lo siguiente en tu solicitud:
- Especifica el alcance de la autorización
chat.memberships.app
. - Llama al
Método
create
en el recursomembership
. - Establece
parent
en el nombre de recurso del espacio en el que se creará la membresía. - Establece
member
enusers/app
. un alias que representa la aplicación que llama al API de Chat.
En el siguiente ejemplo, se agrega una app de Chat a un espacio:
Python
- En tu directorio de trabajo, crea un archivo llamado
chat_membership_app_create.py
Incluye el siguiente código en
chat_membership_app_create.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.memberships.app"] def main(): ''' Authenticates with Chat API via user credentials, then adds the Chat app to a Chat space. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().create( # The space in which to create a membership. parent = 'spaces/SPACE', # Set the Chat app as the entity that gets added to the space. # 'app' is an alias for the Chat app calling the API. body = { 'member': { 'name':'users/app', 'type': 'BOT' } } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
En el código, reemplaza
SPACE
por un nombre de espacio, que que puedes obtener de la Métodospaces.list
en la API de Chat o desde la URL de un espacio.En tu directorio de trabajo, compila y ejecuta la muestra:
python3 chat_membership_app_create.py
Node.js
- En el directorio de trabajo, crea un archivo llamado
add-app-to-space.js
. Incluye el siguiente código en
add-app-to-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Adds the app to the Chat space. * @return {!Promise<!Object>} */ async function addAppToSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.memberships.app', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.members.create({ parent: 'spaces/SPACE', requestBody: {member: {name: 'users/app', type: 'BOT'}} }); } addAppToSpace().then(console.log);
En el código, reemplaza
SPACE
por un nombre de espacio, que que puedes obtener de la Métodospaces.list
en la API de Chat o desde la URL de un espacio.En tu directorio de trabajo, ejecuta la muestra:
node add-app-to-space.js
La API de Chat devuelve una instancia de
membership
en la que se detalla la membresía de la app que se creó.
Temas relacionados
- Obtén detalles sobre la membresía de un usuario o de la app de Chat.
- Enumera los miembros de un espacio.
- Actualiza la membresía de un usuario en un espacio de Google Chat.
- Quita a un usuario o una app de Chat de un espacio.