Questo documento contiene informazioni su autorizzazione e autenticazione specifiche per l'API Google Workspace Events. Prima di leggere questo documento, assicurati di leggere le informazioni generali sull'autenticazione e sull'autorizzazione di Google Workspace in Informazioni su autenticazione e autorizzazione.
Configura OAuth 2.0 per l'autorizzazione
Configura la schermata per il consenso OAuth e scegli gli ambiti per definire quali informazioni vengono mostrate agli utenti e ai revisori delle app e registra la tua app in modo da poterla pubblicare in un secondo momento.
Ambiti dell'API Google Workspace Events
Per definire il livello di accesso concesso alla tua app, devi identificare e dichiarare gli ambiti di autorizzazione. Un ambito di autorizzazione è una stringa URI OAuth 2.0 che contiene il nome dell'app Google Workspace, il tipo di dati a cui accede e il livello di accesso. Gli ambiti sono le richieste della tua app di utilizzare i dati di Google Workspace, inclusi i dati dell'Account Google degli utenti.
Quando l'app viene installata, all'utente viene chiesto di convalidare gli ambiti utilizzati dall'app. In genere, devi scegliere l'ambito più mirato possibile ed evitare di richiedere ambiti non necessari per l'app. Gli utenti concedono più facilmente l'accesso ad ambiti limitati e chiaramente descritti.
L'API Google Workspace Events utilizza gli ambiti delle applicazioni Google Workspace che supportano gli abbonamenti. Se la tua app utilizza già gli ambiti richiesti per l'abbonamento, non è necessario aggiungere ambiti per utilizzare l'API Google Workspace Events. Se aggiungi ambiti, scegli quello meno sensibile che consente comunque il funzionamento della tua app. Per maggiori dettagli sulle categorie di ambiti, consulta Categorie di ambiti.
La tabella seguente elenca gli ambiti supportati per l'API Google Workspace Events:
| Codice ambito | Descrizione | Utilizzo | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Consente alle app di Chat di visualizzare le chat e inviare messaggi. Consente l'accesso a tutte le funzionalità disponibili per le app di Chat. | Non sensibile | ||
https://www.googleapis.com/auth/chat.memberships |
Visualizzare, aggiungere e rimuovere membri dalle conversazioni in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Visualizzare i membri delle conversazioni di Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.app.memberships |
Visualizzare, aggiungere, aggiornare e rimuovere membri dalle conversazioni e dagli spazi in Chat come app di Chat. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Sensibile |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Visualizzare i membri delle conversazioni e degli spazi in Google Chat come app di Chat. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Sensibile |
||
https://www.googleapis.com/auth/chat.spaces |
Creare spazi e conversazioni e visualizzare o aggiornare i metadati (incluse le impostazioni della cronologia) in Chat. | Sensibile | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Visualizzare la chat e gli spazi in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.app.spaces |
Creare conversazioni e spazi e visualizzare o aggiornare i metadati (incluse le impostazioni della cronologia) in Chat come app Chat. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Sensibile |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Visualizzare i metadati (incluse le impostazioni della cronologia) in Google Chat come app di Chat. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Sensibile |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Visualizzare, aggiungere ed eliminare reazioni ai messaggi in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Visualizzare le reazioni a un messaggio in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.messages |
Visualizzare, scrivere, inviare, aggiornare ed eliminare messaggi, nonché aggiungere, visualizzare ed eliminare reazioni ai messaggi | Con restrizioni | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Visualizzare messaggi e reazioni in Chat. | Con limitazioni |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Visualizzare messaggi e reazioni in Chat come app di Chat. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Con limitazioni |
||
https://www.googleapis.com/auth/chat.users.readstate |
Visualizzare e aggiornare lo stato di lettura dell'utente in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Visualizzare lo stato di lettura dell'utente in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.users.availability |
Visualizzare e modificare lo stato di disponibilità in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
Visualizzare lo stato di disponibilità in Chat. | Sensibile |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Visualizzare i metadati di tutti gli spazi e di tutte le conversazioni in Google Chat all'interno della tua organizzazione Google Workspace, anche quando l'app di Chat non ne fa parte. Questo ambito è supportato solo con gli abbonamenti dei clienti. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Con restrizioni | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
Visualizzare tutti i membri negli spazi e nelle conversazioni di Google Chat della tua organizzazione Google Workspace, anche quando l'app di Chat non ne fa parte. Questo ambito è supportato solo con gli abbonamenti dei clienti. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Con restrizioni | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
Visualizzare tutti i messaggi e tutte le reazioni della tua organizzazione Google Workspace, anche quando l'app Chat non fa parte di uno spazio o di una conversazione. Questo ambito è supportato solo con gli abbonamenti dei clienti. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Con restrizioni | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Visualizzare l'ultima ora di lettura di tutti gli utenti in tutti gli spazi e in tutte le conversazioni della tua organizzazione Google Workspace, anche quando l'app di Chat non ne fa parte. Questo ambito è supportato solo con gli abbonamenti dei clienti. Richiede l'approvazione dell'amministratore. Questo ambito supporta solo l'autenticazione delle app con i service account. Non puoi eseguire l'autenticazione con le credenziali utente o con la delega a livello di dominio utilizzando questo ambito. |
Con restrizioni | ||
| Google Drive | ||||
https://www.googleapis.com/auth/drive.file |
Creare nuovi file di Drive o modificare i file esistenti che apri con un'app o che l'utente condivide con un'app mentre utilizza l'API Google Picker o il selettore file dell'app. | Non sensibile | ||
https://www.googleapis.com/auth/drive |
Visualizzare e gestire tutti i file di Drive. | Con restrizioni | ||
https://www.googleapis.com/auth/drive.readonly |
Visualizzare e scaricare tutti i file di Drive. | Con restrizioni | ||
https://www.googleapis.com/auth/drive.metadata |
Visualizzare e gestire i metadati dei file in Drive. | Con restrizioni | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Visualizzare i metadati dei file in Drive. | Con restrizioni | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Consenti alle app di creare, modificare e leggere i metadati relativi agli spazi di riunione creati dalla tua app. | Sensibile |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Consenti alle app di leggere i metadati relativi a qualsiasi spazio di riunione a cui l'utente ha accesso. | Sensibile |
||
La colonna Utilizzo nella tabella precedente indica la sensibilità di ogni ambito:
Non sensibili: questi ambiti forniscono l'ambito più ridotto di accesso all'autorizzazione e richiedono solo la verifica app di base. Per informazioni su questo requisito, consulta Requisiti di verifica.
Sensibili: questi ambiti forniscono l'accesso a dati utente di Google specifici autorizzati dall'utente per la tua app. Richiedono un'ulteriore verifica dell'app. Per informazioni su questo requisito, consulta Requisiti per gli ambiti sensibili e con restrizioni.
Con restrizioni: questi ambiti forniscono un ampio accesso ai dati utente di Google e richiedono una procedura di verifica dell'ambito con restrizioni. Per informazioni su questo requisito, consulta Servizi API di Google: norme relative ai dati utente e Requisiti aggiuntivi per ambiti API specifici. Se memorizzi dati con ambito limitato su server (o li trasmetti), devi sottoporti a una valutazione della sicurezza.
Se la tua app richiede l'accesso ad altre API di Google, puoi aggiungere anche questi ambiti. Per saperne di più sugli ambiti delle API di Google, consulta Utilizzare OAuth 2.0 per accedere alle API di Google.
Per ulteriori informazioni sugli ambiti OAuth 2.0 specifici, consulta Ambiti OAuth 2.0 per le API di Google.
Verifica OAuth
L'utilizzo di determinati ambiti OAuth potrebbe richiedere che la tua app venga sottoposta alla verifica delle app OAuth. Leggi le domande frequenti sulle app OAuth per determinare quando l'app deve essere sottoposta a verifica e quale tipo di verifica è richiesto. Consulta anche i Termini di servizio di Drive.
Tipi di autenticazione richiesti
Questa sezione spiega quali tipi di autenticazione sono richiesti o supportati e fornisce gli ambiti supportati per ogni metodo dell'API Google Workspace Events.
Per gli abbonamenti agli eventi di Chat, l'API Google Workspace Events supporta l'autenticazione sia dell'utente sia dell'app per chiamare alcuni dei suoi metodi. Se un metodo API supporta entrambe le credenziali, il tipo di credenziale utilizzato nella chiamata influisce sul risultato restituito. Ad esempio, se chiami il metodo subscriptions.list con l'autenticazione utente, l'API restituisce un elenco di abbonamenti a cui l'utente autenticato può accedere. Se utilizzi l'autenticazione dell'app, l'API restituisce un elenco di abbonamenti a cui l'app può accedere. Per scoprire di più sui tipi di autenticazione di Chat, vedi Autentica e autorizza le app di Chat e le richieste API di Chat.
La tabella seguente mostra gli ambiti e i tipi di autenticazione richiesti o supportati per ogni metodo dell'API Google Workspace Events:
| Metodo | Autenticazione utente obbligatoria o supportata | Autenticazione delle app supportata (solo app di Chat) | Ambiti di autorizzazione supportati | |
|---|---|---|---|---|
| Crea una sottoscrizione | — |
Con l'autenticazione utente, richiede un ambito supportato per ogni tipo di evento:
Con l'autenticazione dell'app e l'approvazione dell'amministratore (solo app di Google Chat), richiede un ambito supportato per ogni tipo di evento:
|
||
| Sottoscrivi un abbonamento |
Con l'autenticazione utente, questo metodo richiede un ambito che supporti almeno un tipo di evento per l'abbonamento.
Con l'autenticazione dell'app (solo app di Chat):
|
|||
| Elenca le sottoscrizioni |
Con l'autenticazione utente, questo metodo richiede un ambito che supporti almeno un tipo di evento per l'abbonamento.
Con l'autenticazione dell'app (solo app di Chat):
|
|||
| Aggiorna un abbonamento | — |
Con l'autenticazione utente, richiede un ambito supportato per ogni tipo di evento:
Con l'autenticazione dell'app e l'approvazione dell'amministratore (solo app di Google Chat), richiede un ambito supportato per ogni tipo di evento:
|
||
| Riattiva un abbonamento | — |
Con l'autenticazione utente, richiede un ambito supportato per ogni tipo di evento:
Con l'autenticazione dell'app e l'approvazione dell'amministratore (solo app di Chat), richiede un ambito supportato per ogni tipo di evento:
|
||
| Elimina un abbonamento |
Con l'autenticazione utente, questo metodo richiede un ambito che supporti almeno un tipo di evento per l'abbonamento.
Con l'autenticazione dell'app (solo app di Chat):
|
|||
Ambiti per tipo di evento
Quando chiami l'API Google Workspace Events utilizzando l'autenticazione utente, devi specificare uno o più ambiti corrispondenti ai tipi di eventi dell'abbonamento.
La tabella seguente mostra gli ambiti di autorizzazione supportati per ogni tipo di evento:
| Eventi | Tipi di eventi | Ambiti di autorizzazione supportati | ||||||
|---|---|---|---|---|---|---|---|---|
| Chat | ||||||||
| Un messaggio viene pubblicato o aggiornato. |
|
Con Autenticazione utente:
|
||||||
| Viene aggiunta o eliminata una reazione oppure vengono modificate più reazioni. |
|
Con Autenticazione utente:
|
||||||
| Un'iscrizione viene creata, aggiornata o rimossa oppure vengono modificate più iscrizioni. |
|
Con Autenticazione utente:
|
||||||
| Uno spazio viene aggiornato o eliminato. |
|
Con Autenticazione utente:
|
||||||
| Lo stato di lettura dello spazio o lo stato di lettura del thread di un utente viene aggiornato. |
|
Con Autenticazione utente:
|
||||||
| Viene aggiornata una disponibilità. |
|
Con Autenticazione utente:
|
||||||
| Drive | ||||||||
| Un file viene creato, modificato, spostato, eliminato, rinominato, spostato nel cestino o rimosso dal cestino. |
|
|
||||||
| Viene creata o risolta una proposta di accesso su un file. |
|
|
||||||
| Un'approvazione viene annullata, completata, creata, reimpostata, i revisori vengono modificati o i revisori hanno risposto su un file. |
|
|
||||||
| Un commento viene creato, eliminato, modificato, riaperto o risolto in un file. |
|
|
||||||
| Viene creata, eliminata o modificata una risposta in un file. |
|
|
||||||
| Viene creata, eliminata o modificata un'autorizzazione per un file. |
|
|
||||||
| Meet | ||||||||
| Inizia o termina una conferenza. |
|
|
||||||
| Un partecipante partecipa o abbandona una conferenza. |
|
|
||||||
| È stata generata una registrazione. |
|
|
||||||
| È stata generata una trascrizione. |
|
|
||||||