Questa guida spiega come utilizzare il metodo
create()
nella risorsa Membership
dell'API Google Chat per invitare o aggiungere un utente, un gruppo Google o un'app di chat a uno spazio, ovvero creare un abbonamento. Quando crei un abbonamento, se l'abbonato specificato ha
disattivato la policy di accettazione automatica, viene invitato e deve accettare
l'invito allo spazio prima di potervi accedere. In caso contrario, la creazione di un abbonamento aggiunge
il membro direttamente allo spazio specificato.
Se sei un amministratore di Google Workspace, puoi aggiungere utenti, Gruppi Google o app di Chat a qualsiasi spazio della tua organizzazione Google Workspace.
La risorsa
Membership
indica se un utente umano o un'app Google Chat è invitato a, fa parte di o non è presente in uno spazio.
Prerequisiti
Node.js
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di chat.
- Installa la libreria client Cloud Node.js.
- Crea le credenziali di accesso in base a come vuoi autenticarti nella richiesta dell'API Google Chat:
- Per l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
credentials.json
nella directory locale. - Per l'autenticazione come app Chat,
crea le credenziali
dell'account di servizio e salvale come file JSON denominato
credentials.json
.
- Per l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app Chat.
Python
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di chat.
- Installa la libreria client Python Cloud.
- Crea le credenziali di accesso in base a come vuoi autenticarti nella richiesta dell'API Google Chat:
- Per l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
credentials.json
nella directory locale. - Per l'autenticazione come app Chat,
crea le credenziali
dell'account di servizio e salvale come file JSON denominato
credentials.json
.
- Per l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app Chat.
Java
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di chat.
- Installa la libreria client Java Cloud.
- Crea le credenziali di accesso in base a come vuoi autenticarti nella richiesta dell'API Google Chat:
- Per l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
credentials.json
nella directory locale. - Per l'autenticazione come app Chat,
crea le credenziali
dell'account di servizio e salvale come file JSON denominato
credentials.json
.
- Per l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app Chat.
Apps Script
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di chat.
- Crea un progetto Apps Script autonomo e attiva il servizio di chat avanzato.
- In questa guida devi utilizzare l'autenticazione utente o dell'app. Per eseguire l'autenticazione come app Chat, crea le credenziali del service account. Per la procedura, vedi Autenticare e autorizzare come app Google Chat.
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app Chat.
Invitare o aggiungere un utente a uno spazio come utente
Per invitare o aggiungere un utente a uno spazio con autenticazione utente, passa quanto segue nella richiesta:
- Specifica l'ambito di autorizzazione
chat.memberships
. - Chiama il metodo
CreateMembership()
. - Passa
parent
come nome della risorsa dello spazio in cui creare l'abbonamento. - Trasmetti
membership
come istanza diMembership
con il campomember
impostato come segue:- Il campo
type
impostato suHUMAN
. - Il campo
name
è impostato suusers/{user}
, dove{user}
è la persona che vuoi aggiungere allo spazio. Per specificare l'utente Chat, sostituisci{user}
con uno dei seguenti valori:- L'ID della
persona
nell'API People. Ad esempio, se l'person
resourceName
dell'API People èpeople/123456789
, utilizza il valoreusers/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'person
- Il campo
L'esempio seguente aggiunge un utente a uno spazio con autenticazione utente:
Node.js
Python
Java
Apps Script
Per eseguire l'esempio, sostituisci quanto segue:
SPACE_NAME
: l'ID diname
dello spazio. Puoi ottenere l'ID chiamando il metodoListSpaces()
o dall'URL dello spazio.USER_NAME
: un ID utente.
L'API Chat restituisce un'istanza di
Membership
che descrive in dettaglio l'appartenenza dell'utente creata.
Invitare o aggiungere un gruppo Google a uno spazio
Per invitare o aggiungere un gruppo Google a uno spazio con autenticazione utente (l'autenticazione app non supporta l'invito o l'aggiunta di un gruppo Google a uno spazio), trasmetti quanto segue nella richiesta:
- Specifica l'ambito di autorizzazione
chat.memberships
. - Chiama il metodo
CreateMembership()
. - Passa
parent
come nome della risorsa dello spazio in cui creare l'abbonamento. - Passa
membership
come istanza diMembership
con il camponame
digroupMember
impostato sugroups/{group}
, dove{group}
è l'ID gruppo per cui vuoi creare l'iscrizione. L'ID del gruppo può essere recuperato utilizzando l'API Cloud Identity.
I gruppi Google non possono essere aggiunti a una chat di gruppo o a un messaggio diretto, ma solo a uno spazio con nome.
L'esempio seguente aggiunge un gruppo a uno spazio denominato con l'autenticazione utente:
Node.js
Python
Java
Apps Script
Per eseguire l'esempio, sostituisci quanto segue:
SPACE_NAME
: l'ID diname
dello spazio. Puoi ottenere l'ID chiamando il metodoListSpaces()
o dall'URL dello spazio.GROUP_NAME
: un ID gruppo.
L'API Chat restituisce un'istanza di
Membership
che descrive in dettaglio l'appartenenza dell'utente creata.
Aggiungere un'app di Chat a uno spazio
Un'app di chat non può aggiungere un'altra app come membro di 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 con l'autenticazione utente (l'autenticazione app non supporta l'invito o l'aggiunta di un'app di chat a uno spazio):
- Specifica l'ambito di autorizzazione
chat.memberships.app
. - Chiama il metodo
CreateMembership()
. - Passa
parent
come nome della risorsa dello spazio in cui creare l'abbonamento. - Trasmetti
membership
come istanza diMembership
con il campomember
impostato come segue:- Il campo
type
impostato suBOT
. - Il campo
name
impostato suusers/app
; un alias che rappresenta l'app che chiama l'API Chat.
- Il campo
Il seguente esempio aggiunge un'app di Chat a uno spazio:
Node.js
Python
Java
Apps Script
Per eseguire l'esempio, sostituisci SPACE_NAME
con l'ID dello spazio name
.
Puoi ottenere l'ID chiamando il metodo
ListSpaces()
o dall'URL dello spazio.
L'API Chat restituisce un'istanza di
Membership
che descrive in dettaglio l'appartenenza dell'utente creata.
Invitare o aggiungere un utente a uno spazio come app di Chat
L'autenticazione dell'app richiede l'approvazione dell'amministratore una sola volta.
Per invitare o aggiungere un utente a uno spazio con autenticazione dell'app, trasmetti quanto segue nella richiesta:
- Specifica l'ambito di autorizzazione
chat.app.memberships
. - Chiama il
metodo
create
sulla risorsamembership
. - Imposta
parent
sul nome della risorsa dello spazio in cui creare l'abbonamento. - Imposta
member
suusers/{user}
, dove{user}
è la persona per cui vuoi creare l'abbonamento e può essere:- L'ID della
persona
nell'API People. Ad esempio, se l'API People
person
resourceName
è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'API People
person
Crea una chiave API
Per chiamare un metodo API di anteprima per gli sviluppatori, devi utilizzare una versione di anteprima per gli sviluppatori non pubblica del documento di rilevamento API. Per autenticare la richiesta, devi passare una chiave API.
Per creare la chiave API, apri il progetto Google Cloud della tua app e svolgi i seguenti passaggi:
- Nella console Google Cloud, vai a Menu > API e servizi > Credenziali.
- Fai clic su Crea credenziali > Chiave API.
- Viene visualizzata la nuova chiave API.
- Fai clic su Copia per copiare la chiave API da utilizzare nel codice dell'app. La chiave API può essere trovata anche nella sezione "Chiavi API" delle credenziali del progetto.
- Fai clic su Limita chiave per aggiornare le impostazioni avanzate e limitare l'utilizzo della chiave API. Per maggiori dettagli, consulta Applicare le limitazioni relative alle chiavi API.
Scrivere uno script che chiama l'API Chat
Il seguente esempio aggiunge un utente a uno spazio con autenticazione dell'app:
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.oauth2 import service_account from apiclient.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.app.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then adds a user to a Chat space by creating a membership. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # 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()
Nel codice, sostituisci quanto segue:
API_KEY
: la chiave API che hai creato per creare l'endpoint del servizio per l'API Chat.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, compila ed esegui l'esempio:
python3 chat_membership_app_create.py
Aggiungere utenti o gruppi Google a uno spazio come amministratore di Google Workspace
Se sei un amministratore di Google Workspace, puoi chiamare il metodo create()
per aggiungere utenti, Gruppi Google o app di Chat a qualsiasi spazio della tua organizzazione Google Workspace.
Per chiamare questo metodo in qualità di amministratore di Google Workspace, procedi nel seguente modo:
- Chiama il metodo utilizzando l'autenticazione utente e specifica un ambito di autorizzazione che supporti la chiamata del metodo utilizzando privilegi amministrativi.
- Nella richiesta, specifica il parametro di query
useAdminAccess
sutrue
.
Per ulteriori informazioni ed esempi, vedi Gestire gli spazi di Google Chat come amministratore di Google Workspace.
Limitazioni e considerazioni
- Con l'autenticazione delle app,
un'app di chat può invitare o aggiungere utenti, ma non
Google Gruppi o app di chat. Per aggiungersi, un'app di chat deve utilizzare l'autenticazione utente con l'ambito di autorizzazione
chat.memberships
.
Argomenti correlati
- Visualizzare i dettagli dell'abbonamento di un utente o di un'app di chat.
- Elencare i membri di uno spazio.
- Aggiorna l'iscrizione di un utente a uno spazio Google Chat.
- Rimuovere un utente o l'app Chat da uno spazio.