L'API Data Studio consente di cercare e gestire gli asset di Data Studio.
Il caso d'uso principale dell'API è consentire alle organizzazioni di Google Workspace o Cloud Identity di automatizzare la gestione e la migrazione degli asset di Data Studio.
Panoramica dei requisiti
Per utilizzare l'API Data Studio, devi completare i seguenti passaggi:
- Configura un'app per utilizzare l'API.
- Utilizza la Console di amministrazione Google per autorizzare l'app.
- Ottieni i token di accesso OAuth 2.0 e chiama l'API.
I passaggi precedenti possono essere eseguiti dalla stessa organizzazione o da organizzazioni diverse in base ai seguenti scenari comuni:
- App interne sviluppate per un'organizzazione. L'organizzazione configura e autorizza l'app per tutti gli utenti della propria organizzazione.
- App di terze parti sviluppate per utenti/clienti esterni (ovvero lo sviluppatore e gli utenti appartengono a organizzazioni diverse). Lo sviluppatore configura l'app, ma l'organizzazione dell'utente autorizza l'app di terze parti.
1. Configura un'app per utilizzare l'API
Per configurare l'app:
Abilita l'API
Per abilitare un'API per il tuo progetto:
- Apri l'[API Data Studio] nella console API di Google.
- Quando richiesto, seleziona un progetto o creane uno nuovo.
- Fai clic su Abilita.
- Quando richiesto, leggi e accetta i Termini di servizio dell'API.
Crea un client OAuth
I seguenti passaggi per creare un client OAuth sono linee guida generali e devono essere modificati in base ai requisiti dell'app.
- Vai a Configura la schermata per il consenso OAuth.
- Scegli Interna, fai clic su Crea.
- Compila i campi obbligatori e fai clic su Salva.
- Vai a Credenziali.
- Fai clic su CREA CREDENZIALI.
- Seleziona ID client OAuth.
- Scegli il
Application Typeappropriato. (L'applicazione web è la più comune). - Compila i campi obbligatori e fai clic su Crea.
- Prendi nota dell'ID client perché viene utilizzato per autorizzare l'app.
2. Autorizza l'app per un'organizzazione
Le app che utilizzano l'API Data Studio possono autenticare e autorizzare solo gli utenti di Google Workspace se l'organizzazione dell'utente ha autorizzato l'app utilizzando la delega a livello di dominio per controllare l'accesso API.
Configura la delega a livello di dominio con l'ID client OAuth dell'app e gli ambiti richiesti dall'app.
- Accedi alla Console di amministrazione Google e vai alla delega a livello di dominio.
- In
API clients, fai clic su Aggiungi nuovo. - Inserisci il
Client IDdell'app da autorizzare (ovvero l'app che utilizza l'API Studio). - Inserisci tutti gli ambiti OAuth richiesti dall'app. Se utilizzi l'API Data Studio per gestire gli asset, in genere vengono richiesti i seguenti ambiti:
https://www.googleapis.com/auth/datastudiohttps://www.googleapis.com/auth/userinfo.profile
- Fai clic su Autorizza.
Dopo aver autorizzato l'app, tutti gli utenti di Workspace appartenenti all'organizzazione saranno autorizzati automaticamente a utilizzare l'app con l'API Data Studio.
3. Ottieni i token di accesso OAuth 2.0 e chiama l'API
Una volta sviluppata e autorizzata l'app, avrai l'accesso necessario per chiamare l'API per gli utenti di Workspace. Per informazioni dettagliate su come utilizzare le API di Google con OAuth, vedi Utilizzare OAuth 2.0 per accedere alle API di Google. Consulta il Riferimento API per le operazioni disponibili.
Risoluzione dei problemi
Finestra di dialogo OAuth mancante
Se l'organizzazione di un utente ha autorizzato l'app, gli utenti di questa organizzazione non visualizzeranno la finestra di dialogo OAuth quando autorizzano l'app. L'unica eccezione è se l'app richiede l'autorizzazione per ambiti API di Google aggiuntivi che l'amministratore di Workspace non ha configurato, nel qual caso la finestra di dialogo OAuth verrà mostrata agli utenti.
Errore 400: invalid_scope
Se un utente riceve un messaggio Error 400: invalid_scope quando tenta di
autorizzare l'app, significa che l'organizzazione dell'utente non ha autorizzato l'app o l'ha autorizzata in modo errato
autorizzato l'app. Per risolvere il problema, l'utente dovrà richiedere alla propria organizzazione di autorizzare l'app.