Configura OAuth

Quando pubblichi la tua app, devi completare quattro attività principali per l'autenticazione e l'autorizzazione:

  1. Compila la schermata per il consenso OAuth.
  2. Crea la tua credenziale OAuth 2.0.
  3. Configurare tutti gli ambiti di cui l'app ha bisogno per funzionare nell'SDK di Google Workspace Marketplace
  4. Richiedi la verifica OAuth della tua app.

Gli ambiti che aggiungi a ogni luogo devono corrispondere e vengono utilizzati nei seguenti modi:

  • Gli ambiti aggiunti alla schermata di consenso OAuth vengono utilizzati per la verifica OAuth.
  • Gli ambiti aggiunti all'SDK di Google Workspace Marketplace vengono utilizzati per le installazioni a livello di dominio e singolari per autorizzare la tua app quando viene installata da Google Workspace Marketplace.
  • Gli ambiti aggiunti al manifest sono necessari per il corretto funzionamento dell'app.

Ad esempio, se pubblichi un'app che include un componente aggiuntivo di Fogli Google e un componente aggiuntivo di Documenti Google, il manifest di Apps Script di ciascun componente aggiuntivo include solo gli ambiti specifici del componente aggiuntivo. Nel progetto Google Cloud, la schermata per il consenso OAuth e l'SDK di Google Workspace Marketplace includono gli ambiti per entrambi i componenti aggiuntivi.

Prerequisiti

La schermata del consenso OAuth è un messaggio che indica agli utenti chi sta richiedendo l'accesso ai loro dati e a quale tipo di dati gli utenti consentono alla tua app di accedere.

  1. Nella console Google Cloud, vai a Menu > API e servizi > Schermata del consenso OAuth.

    Vai alla schermata per il consenso OAuth

  2. Seleziona il tipo di utente per la tua app, quindi fai clic su Crea.
  3. Completa il modulo di registrazione dell'app, poi fai clic su Salva e continua.
  4. Se stai creando un'app da utilizzare al di fuori della tua organizzazione Google Workspace, fai clic su Aggiungi o rimuovi ambiti. Ti consigliamo le seguenti best practice per la selezione degli ambiti:

    • Seleziona gli ambiti che forniscono il livello minimo di accesso richiesto dalla tua app. Per un elenco degli ambiti disponibili, consulta Ambiti OAuth 2.0 per le API di Google.
    • Esamina gli ambiti elencati in ciascuna delle tre sezioni: ambiti non sensibili, ambiti sensibili e ambiti con restrizioni. Per gli ambiti elencati nelle sezioni "I tuoi ambiti sensibili" o "I tuoi ambiti con limitazioni", prova a identificare ambiti non sensibili alternativi per evitare ulteriori revisioni non necessarie.
    • Alcuni ambiti richiedono ulteriori revisioni da parte di Google. Per le app utilizzate solo internamente dalla tua organizzazione Google Workspace, gli ambiti non sono elencati nella schermata del consenso e l'utilizzo di ambiti con limitazioni o sensibili non richiede un'ulteriore revisione da parte di Google. Per ulteriori informazioni, consulta Categorie di ambito.
  5. Dopo aver selezionato gli ambiti richiesti dalla tua app, fai clic su Salva e continua.
  6. Se hai selezionato Esterno come tipo di utente, aggiungi gli utenti di test:
    1. In Utenti di test, fai clic su Aggiungi utenti.
    2. Inserisci il tuo indirizzo email e gli altri utenti di test autorizzati, quindi fai clic su Salva e continua.
  7. Rivedi il riepilogo della registrazione dell'app. Per apportare modifiche, fai clic su Modifica. Se la registrazione dell'app sembra corretta, fai clic su Torna alla dashboard.

2. Crea la tua credenziale OAuth 2.0

A seconda di come hai creato l'app, esistono due modi diversi per creare le tue credenziali OAuth 2.0.

Se hai creato l'app in Apps Script

Passa il progetto Apps Script dal progetto Google Cloud predefinito al nuovo progetto standard. Consulta Passare a un altro progetto standard.

Dopo aver associato il progetto Apps Script al progetto Google Cloud, la credenziale OAuth 2.0 viene creata automaticamente.

Se non hai utilizzato Apps Script per creare l'app

Per creare la tua credenziale OAuth 2.0, consulta Credenziali ID client OAuth.

3. Configura gli ambiti

Fornisci un elenco completo degli ambiti OAuth richiesti dalla tua app. Utilizza sempre gli ambiti più ristretti possibili.

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 viene 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.

4. Invio per la verifica OAuth (solo app pubbliche)

Se un'app pubblica utilizza ambiti sensibili o con restrizioni, deve essere sottoposta a una procedura di revisione della verifica OAuth.

  • Per la verifica OAuth, devi inviare un video dimostrativo che mostri il percorso o la procedura che spiega agli utenti l'utilizzo degli ambiti o dei dati richiesti.
  • Se la tua app utilizza ambiti limitati, potrebbe anche dover essere sottoposta a una valutazione di sicurezza. Consulta Perché è necessaria la valutazione della sicurezza.

Per richiedere la verifica:

  1. Nella console Google Cloud, vai a Menu > API e servizi > Schermata del consenso OAuth.

    Vai alla schermata per il consenso OAuth

  2. Fai clic su Selettore dei progetti e seleziona il tuo progetto.
  3. Fai clic su Modifica app.
  4. Inserisci le informazioni richieste, quindi fai clic su Invia per la verifica.
  5. Nella finestra di dialogo Verifica richiesta, inserisci le giustificazioni appropriate e poi fai clic su Invia per avviare la procedura di verifica.

Se aggiorni l'app in modo da utilizzare ambiti diversi sensibili o con limitazioni, devi sottoporre nuovamente l'app alla verifica OAuth. Non è necessario inviarla di nuovo per la revisione dell'app.

Differenze tra la verifica OAuth e la revisione dell'app

La verifica OAuth è un processo distinto dalla revisione dell'app. Si concentra sull'assicurarsi che la schermata del consenso rappresenti con precisione l'identità e lo scopo della tua app e che l'app non usi in modo improprio i dati utente. La scheda dell'app non può essere approvata finché non è stata completata la verifica OAuth dell'app. Per ulteriori informazioni sulla verifica OAuth, consulta le domande frequenti sulla verifica dell'API OAuth.

La revisione delle app si concentra sulle informazioni fornite nell'API Google Workspace Marketplace, nonché sulla funzionalità e sull'usabilità dell'app. Per scoprire di più sui criteri di revisione delle app, consulta Informazioni sulla revisione delle app.