Questa guida spiega come utilizzare il metodo create
nella risorsa membership
dell'API Google Chat per invitare o aggiungere un utente o un'app Chat in uno spazio noto anche come creazione di un abbonamento. Quando crei un'iscrizione, se il criterio di accettazione automatica è disattivato per il membro specificato, il membro viene invitato e deve accettare l'invito prima di partecipare allo spazio. Altrimenti, se crei un'appartenenza, il membro
viene aggiunto direttamente allo spazio specificato.
La risorsa Membership
indica se un utente umano o l'app Google Chat è stato invitato in uno spazio o è assente in uno spazio.
Prerequisiti
Python
- Python 3.6 o versioni successive
- Lo strumento di gestione dei pacchetti pip
Le librerie client di Google più recenti per Python. Per installarli o aggiornarli, esegui questo comando nell'interfaccia a riga di comando:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Un progetto Google Cloud in cui l'API Google Chat è abilitata e configurata. Per i passaggi da seguire, consulta Creare un'app Google Chat.
Autorizzazione configurata per l'app di Chat. La creazione di un'appartenenza richiede l'autenticazione utente con l'ambito di autorizzazione
chat.memberships
ochat.memberships.app
.
Node.js
- Node.js e npm
Le librerie client di Google più recenti per Node.js. Per installarle, esegui questo comando nell'interfaccia a riga di comando:
npm install @google-cloud/local-auth @googleapis/chat
- Un progetto Google Cloud in cui l'API Google Chat è abilitata e configurata. Per i passaggi da seguire, consulta Creare un'app Google Chat.
Autorizzazione configurata per l'app di Chat. La creazione di un'appartenenza richiede l'autenticazione utente con l'ambito di autorizzazione
chat.memberships
ochat.memberships.app
.
Invitare o aggiungere un utente a uno spazio
Per invitare o aggiungere un utente a uno spazio, trasmetti quanto segue nella richiesta:
- Specifica l'ambito dell'autorizzazione
chat.memberships
. - Chiama il metodo
create
nella risorsamembership
. - Imposta
parent
sul nome della risorsa dello spazio in cui creare l'appartenenza. - Imposta
member
suusers/{user}
, dove{user}
è la persona per cui vuoi creare l'abbonamento, che può essere:- L'ID della
persona
nell'API People. Ad esempio, se l'elemento
persona
resourceName
dell'API People èpeople/123456789
, impostamembership.member.name
suusers/123456789
. - L'ID dell'utente nell'API Directory.
- L'indirizzo email dell'utente. Ad esempio,
users/222larabrown@gmail.com
ousers/larabrown@cymbalgroup.com
. Se l'utente utilizza un Account Google o appartiene a un'altra organizzazione Google Workspace, devi utilizzare il suo indirizzo email.
- L'ID della
persona
nell'API People. Ad esempio, se l'elemento
persona
Nell'esempio seguente viene aggiunto un utente a uno spazio:
Python
- Nella directory di lavoro, crea un file denominato
chat_membership_user_create.py
. Includi il seguente codice in
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()
Sostituisci quanto segue nel codice:
SPACE
: il nome di uno spazio, che puoi ottenere dal metodospaces.list
nell'API Chat o dall'URL di uno spazio.USER
: un ID utente.
Nella directory di lavoro, crea ed esegui l'esempio:
python3 chat_membership_user_create.py
Node.js
- Nella directory di lavoro, crea un file denominato
add-user-to-space.js
. Includi il seguente codice in
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);
Sostituisci quanto segue nel codice:
SPACE
: il nome di uno spazio, che puoi ottenere dal metodospaces.list
nell'API Chat o dall'URL di uno spazio.USER
: un ID utente.
Nella tua directory di lavoro, esegui l'esempio:
node add-user-to-space.js
L'API Chat restituisce un'istanza di
membership
che descrive in dettaglio l'abbonamento creato.
Aggiungere un'app di chat a uno spazio
Un'app di chat non può aggiungere un'altra app come membro a uno spazio. Per aggiungere un'app di chat a uno spazio o a un messaggio diretto tra due utenti umani, trasmetti quanto segue nella richiesta:
- Specifica l'ambito dell'autorizzazione
chat.memberships.app
. - Chiama il metodo
create
nella risorsamembership
. - Imposta
parent
sul nome della risorsa dello spazio in cui creare l'appartenenza. - Imposta
member
suusers/app
; un alias che rappresenta l'app che chiama l'API Chat.
Nell'esempio seguente viene aggiunta un'app di chat a uno spazio:
Python
- Nella directory di lavoro, crea un file denominato
chat_membership_app_create.py
. Includi il seguente codice in
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()
Nel codice, sostituisci
SPACE
con il nome di uno spazio, che puoi ottenere dal metodospaces.list
nell'API Chat o dall'URL di uno spazio.Nella directory di lavoro, crea ed esegui l'esempio:
python3 chat_membership_app_create.py
Node.js
- Nella directory di lavoro, crea un file denominato
add-app-to-space.js
. Includi il seguente codice in
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);
Nel codice, sostituisci
SPACE
con il nome di uno spazio, che puoi ottenere dal metodospaces.list
nell'API Chat o dall'URL di uno spazio.Nella tua directory di lavoro, esegui l'esempio:
node add-app-to-space.js
L'API Chat restituisce un'istanza di
membership
che descrive in dettaglio l'abbonamento creato.
Argomenti correlati
- Visualizzare i dettagli dell'abbonamento di un utente o dell'app di chat.
- Membri dell'elenco in uno spazio.
- Aggiornare l'appartenenza di un utente a uno spazio di Google Chat.
- Rimuovere un utente o un'app di chat da uno spazio.