Scegli gli ambiti API Google Workspace Events

Questo documento contiene informazioni su autorizzazione e autenticazione specifiche dell'API Google Workspace Events. Prima di leggere questo documento, assicurati di leggere le informazioni generali su autenticazione e autorizzazione di Google Workspace all'indirizzo Scopri di più su autenticazione e autorizzazione.

Configurare OAuth 2.0 per l'autorizzazione

Configurare la schermata per il consenso OAuth e scegliere gli ambiti per definire le informazioni da mostrare agli utenti e ai revisori dell'app e registrare 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 dell'app per lavorare con i dati di Google Workspace, inclusi i dati dell'Account Google degli utenti.

Quando l'app è installata, a un utente viene chiesto di convalidare gli ambiti utilizzati dall'app. In genere, devi scegliere l'ambito più limitato possibile ed evitare di richiedere ambiti non necessari per la tua app. Gli utenti acconsentono più facilmente all'accesso ad ambiti limitati e descritti chiaramente.

Se possibile, ti consigliamo di utilizzare ambiti non sensibili, in quanto concedono accesso per file e limitano l'accesso a funzionalità specifiche necessarie per un'app.

L'API Google Workspace Events utilizza gli ambiti delle applicazioni Google Workspace che supportano le iscrizioni. Se la tua app utilizza già gli ambiti obbligatori per il tuo abbonamento, non è necessario aggiungere altri ambiti per utilizzare l'API Google Workspace Events.

La tabella seguente mostra 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 Google Chat di visualizzare le chat e inviare messaggi. Conferma 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 Google Chat.
Sensibile
https://www.googleapis.com/auth/chat.memberships.readonly Visualizzare i membri delle conversazioni di Google Chat.
Sensibile
https://www.googleapis.com/auth/chat.spaces Creare conversazioni e spazi e visualizzare o aggiornare i metadati (incluse le impostazioni della cronologia) in Google Chat. Sensibile
https://www.googleapis.com/auth/chat.spaces.readonly Visualizzare la chat e gli spazi in Google Chat.
Sensibile
https://www.googleapis.com/auth/chat.messages.reaction s Visualizzare, aggiungere ed eliminare le 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, oltre a aggiungere, visualizzare ed eliminare reazioni ai messaggi. Con restrizioni
https://www.googleapis.com/auth/chat.messages.readonly Visualizzare messaggi e reazioni in Google Chat.
Con restrizioni
Google Meet  
https://www.googleapis.com/auth/meetings.space.created Consenti alle app di creare, modificare e leggere i metadati degli spazi di riunione creati dalla tua app.
Sensibile
https://www.googleapis.com/auth/meetings.space.readonly Consente alle app di leggere i metadati di qualsiasi spazio di riunione a cui l'utente ha accesso.
Sensibile

La colonna Utilizzo nella tabella precedente indica la sensibilità di ogni ambito, in base alle seguenti definizioni:

Se la tua app richiede l'accesso ad altre API di Google, puoi aggiungere anche questi ambiti. Per ulteriori informazioni sugli ambiti delle API di Google, consulta l'articolo Utilizzare OAuth 2.0 per accedere alle API di Google.

Per ulteriori informazioni su 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 segua la procedura di verifica OAuth di Google. Leggi le domande frequenti sulla verifica dell'API OAuth per determinare quando la tua app deve essere sottoposta a verifica e quale tipo di verifica è richiesta. Consulta anche i Termini di servizio aggiuntivi di Google 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 le iscrizioni agli eventi di Google Chat, l'API Google Workspace Events supporta sia l'autenticazione utente che quella 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 può accedere l'utente autenticato. 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 Autenticare e autorizzare le app di Chat e le richieste API di Google Chat.

La tabella seguente mostra gli ambiti e i tipi di autenticazione obbligatori o supportati per ciascun metodo dell'API Events di Google Workspace:

Metodo Autenticazione utente richiesta o supportata Autenticazione app supportata (solo app Google Chat) Ambiti di autorizzazione supportati
Creare un abbonamento

Richiede un ambito supportato per ogni tipo di evento:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Acquistare un abbonamento Con l'autenticazione utente, questo metodo richiede un ambito che supporti almeno un tipo di evento per l'abbonamento.

Con l'autenticazione delle app (solo app Google Chat):

  • chat.bot
Elenco abbonamenti Con l'autenticazione utente, questo metodo richiede un ambito che supporti almeno un tipo di evento per l'abbonamento.

Con l'autenticazione delle app (solo app Google Chat):

  • chat.bot
Aggiornare un abbonamento

Richiede un ambito supportato per ogni tipo di evento:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Riattivare un abbonamento

Richiede un ambito supportato per ogni tipo di evento:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Eliminare un abbonamento Con l'autenticazione utente, questo metodo richiede un ambito che supporti almeno un tipo di evento per l'abbonamento.

Con l'autenticazione delle app (solo app Google Chat):

  • chat.bot

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 evento Ambiti di autorizzazione supportati
Google Chat  
Viene pubblicato o aggiornato un messaggio.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
Viene aggiunta o eliminata una reazione oppure vengono modificate più reazioni.
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
Viene creato, aggiornato o rimosso un abbonamento oppure vengono modificati più abbonamenti.
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
Un spazio viene aggiornato o eliminato.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Meet  
Una conferenza inizia o termina.
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
Un partecipante si unisce o lascia una conferenza.
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
È stata generata una registrazione.
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
È stata generata una trascrizione.
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly