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 le tue credenziali OAuth 2.0.
  3. Configura tutti gli ambiti necessari per l'esecuzione dell'app nell'SDK di Google Workspace Marketplace
  4. Inviare l'app per la verifica OAuth.

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

  • Gli ambiti aggiunti alla schermata per il 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 singole 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 file manifest di Apps Script di ogni componente aggiuntivo includerà solo gli ambiti specifici del componente aggiuntivo. Nel tuo 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 di consenso OAuth è un messaggio che indica agli utenti chi richiede l'accesso ai loro dati e a quale tipo di dati gli utenti possono concedere l'accesso alla tua app.

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

    Vai alla schermata per il consenso OAuth

  2. Seleziona il tipo di utente per l'app e fai clic su Crea.
  3. Compila 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. Quando selezioni gli ambiti, ti consigliamo di attenerti alle seguenti best practice:

    • 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 tutti gli ambiti elencati nelle sezioni "I tuoi ambiti sensibili" o "I tuoi ambiti con restrizioni", prova a identificare ambiti alternativi non sensibili per evitare ulteriori revisioni superflue.
    • Alcuni ambiti richiedono revisioni aggiuntive 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 restrizioni o sensibili non richiede un'ulteriore revisione da parte di Google. Per maggiori 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 tutti 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 è 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 credenziali OAuth 2.0.

Se hai creato la tua app in Apps Script

Cambia il tuo progetto Apps Script dal progetto Google Cloud predefinito al nuovo progetto standard. Consulta Passaggio a un progetto standard diverso.

Dopo aver associato il progetto Apps Script al progetto Google Cloud, le credenziali OAuth 2.0 vengono create automaticamente.

Se non hai utilizzato Apps Script per creare la tua app

Per creare le credenziali OAuth 2.0, consulta Credenziali ID client OAuth.

3. Configura gli ambiti

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

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 utilizzo dei dati di Google Workspace, inclusi i dati dell'Account Google degli utenti.

Una volta installata l'app, all'utente viene chiesto di convalidare gli ambiti utilizzati dall'app. In genere, dovresti scegliere l'ambito più specifico possibile ed evitare di richiedere ambiti non richiesti dall'app. Gli utenti concedono più facilmente l'accesso ad ambiti limitati e chiaramente descritti.

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

Se un'app pubblica utilizza ambiti sensibili o con restrizioni, deve essere sottoposta a un processo di controllo di verifica OAuth.

  • Per la verifica OAuth, devi inviare un video dimostrativo che mostri il percorso o il flusso che spieghi l'utilizzo degli ambiti o dei dati richiesti agli utenti.
  • Se la tua app utilizza ambiti con restrizioni, potrebbe anche essere necessario eseguire una valutazione di sicurezza. Vedi Perché è necessaria la valutazione della sicurezza.

Per richiedere la verifica, segui questi passaggi:

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

    Vai alla schermata per il consenso OAuth

  2. Fai clic su Selettore 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, quindi fai clic su Invia per avviare la procedura di verifica.

Se aggiorni la tua app in modo da utilizzare ambiti sensibili o restrittivi, devi inviare di nuovo l'app per la verifica OAuth. Non è necessario inviarlo di nuovo per la revisione dell'app.

Differenze tra verifica OAuth e revisione delle app

La verifica OAuth è una procedura separata rispetto all'esame delle app. Il suo scopo principale è garantire che la schermata di consenso rappresenti accuratamente l'identità e l'intento della tua app e che quest'ultima non faccia un uso improprio dei dati utente. La tua scheda dell'app non può essere approvata finché la verifica OAuth dell'app non viene completata. 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, sulla funzionalità e sull'usabilità della tua app. Per scoprire di più sui criteri di revisione delle app, consulta Informazioni sulla revisione delle app.