Configurare un'integrazione con la UI di Drive

Per visualizzare la tua app su Google Drive quando un utente crea o apre un file, devi prima configurare un'integrazione dell'interfaccia utente (UI) di Drive. La configurazione è necessaria anche per elencare la tua app in Google Workspace Marketplace.

Abilita l'API Drive

Prima di utilizzare le API di Google, devi attivarle in un progetto Google Cloud. Puoi attivare una o più API in un singolo progetto Google Cloud.

Per iniziare l'integrazione con la UI di Google Drive, devi attivare l'API Drive. In questo modo, avrai accesso all'API e alle funzionalità di integrazione della UI.

• Nella console Google Cloud, abilita l'API Google Drive.

  Abilita l'API

Configura l'integrazione con la UI di Drive

1. Nella console API di Google, vai a Menu menu > API e servizi > API e servizi abilitati.

   Vai ad API e servizi abilitati

2. Nella parte inferiore della dashboard API e servizi, fai clic su API Google Drive. Viene visualizzata la pagina di configurazione dell'API Google Drive.
3. Seleziona la scheda Integrazione UI di Drive.
4. (Facoltativo) Inserisci un nome nel campo Nome applicazione. Il nome dell'applicazione viene visualizzato dagli utenti nella scheda Gestisci app delle impostazioni di Drive.
5. (Facoltativo) Inserisci una breve descrizione di una riga nel campo Breve descrizione. La descrizione breve viene mostrata agli utenti nella scheda Gestisci app nelle impostazioni di Drive.
6. (Facoltativo) Inserisci una descrizione completa nel campo Descrizione lunga.

7. Carica una o più icone dell'applicazione da visualizzare nell'elenco delle app di Drive collegate di un utente e nel menu contestuale "Apri con". Le icone devono essere in formato PNG con uno sfondo trasparente. La visualizzazione delle icone in Drive può richiedere fino a 24 ore.

8. Per utilizzare la voce di menu "Apri con " della UI di Drive, inserisci l'URL della tua app nel campo URL di apertura. Questo URL viene utilizzato dal menu contestuale "Apri con".

   • Questo URL deve contenere un nome di dominio completo; localhost non funziona.
   • Questo URL deve essere accessibile agli utenti previsti della tua applicazione. Se hai più versioni dell'applicazione, ad esempio una per la release pubblica e una per la release limitata a utenti selezionati, ogni versione deve utilizzare un URL univoco. Puoi quindi creare configurazioni dell'app diverse per ogni versione.
   • Devi verificare la proprietà di questo URL prima di poter elencare la tua app in Google Workspace Marketplace.
   • Per impostazione predefinita, a questo URL viene aggiunto un parametro di query state per passare i dati dalla UI di Drive alla tua app. Per informazioni sui contenuti del parametro state, consulta Il parametro state.

9. (Facoltativo) Inserisci i tipi MIME e le estensioni file predefiniti nei campi Tipi MIME predefiniti ed Estensioni file predefinite. I tipi MIME e le estensioni file predefiniti rappresentano i file che la tua app è stata creata appositamente per aprire. Ad esempio, l'app potrebbe aprire un formato integrato per la sovrapposizione e la modifica delle immagini. Includi solo tipi di media standard e assicurati che non contengano errori di battitura e ortografia. Se l'app apre solo file di scorciatoie o di scorciatoie di terze parti, puoi lasciare vuoto il campo del tipo MIME.

10. (Facoltativo) Inserisci i tipi MIME secondari e le estensioni del file secondarie nei campi Tipi MIME secondari ed Estensioni del file secondarie. I tipi MIME e le estensioni del file secondari rappresentano i file che la tua app può aprire, ma non sono specifici per la tua app. Ad esempio, la tua app potrebbe essere un'app di editing di immagini che apre immagini PNG e JPG. Includi solo tipi di media standard e assicurati che non contengano errori di battitura e ortografia. Se l'app apre solo file di scorciatoie o di scorciatoie di terze parti, puoi lasciare vuoto il campo del tipo MIME.

11. Per utilizzare il pulsante "Nuovo" della UI di Drive e consentire agli utenti di creare un file con la tua app, seleziona la casella Creazione di file. Vengono visualizzati i campi Nuovo URL e Nome documento (facoltativo).

    • Questo URL deve contenere un nome di dominio completo; localhost non funziona.
    • Devi verificare la proprietà di questo URL prima di poter inserire la tua app nel Google Workspace Marketplace.
    • Per impostazione predefinita, a questo URL viene aggiunto un parametro di query state per passare i dati dalla UI di Drive alla tua app. Per informazioni sui contenuti del parametro state, consulta Il parametro state.

12. Inserisci un URL nel campo Nuovo URL. Questo URL viene utilizzato dal pulsante "Nuovo" per reindirizzare l'utente alla tua applicazione.

13. (Facoltativo) Se vuoi che la tua app apra i file supportati da Google Workspace, seleziona la casella Importazione.

14. (Facoltativo) Se la tua app deve gestire i file su Drive condivisi, seleziona la casella Supporto dei Drive condivisi. Per ulteriori informazioni su come supportare i Drive condivisi nella tua app, consulta Implementare il supporto dei Drive condivisi.

15. Fai clic su Invia.

Richiedi l'ambito drive.install

Per consentire alle app di essere visualizzate come opzione nel menu "Apri con" o "Nuovo", richiedi l'ambito https://www.googleapis.com/auth/drive.install per l'integrazione con la UI di Drive. Quando richiedono questo ambito, gli utenti visualizzano una finestra di dialogo simile alla seguente:

Per saperne di più sugli ambiti che puoi richiedere per le app di Drive e su come richiederli, consulta Informazioni su autorizzazione e autenticazione specifiche per API.

Il parametro state

Per impostazione predefinita, un parametro state viene aggiunto sia all'URL di apertura sia all'URL di creazione per passare i dati dalla UI di Drive alla tua app. Questo parametro contiene una stringa con codifica JSON con variabili del modello e dati sulla richiesta alla tua app. Le variabili incluse dipendono dal tipo di URL utilizzato (URL di apertura o URL di creazione):

Il parametro state è codificato tramite URL, quindi la tua app deve gestire i caratteri di escape e analizzarlo come JSON. Le app possono rilevare il valore create nel parametro state per verificare una richiesta di creazione di un file.

Esempio di informazioni sullo stato in JSON per un nuovo URL

Le informazioni state per un nuovo URL sono:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Esempio di informazioni sullo stato in JSON per un URL aperto

Le informazioni state per un URL aperto sono:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Gli ID e le chiavi risorsa vengono utilizzati per recuperare i metadati dei file e scaricare i contenuti dei file. Una volta che l'app ha l'ID file e un token di accesso, può controllare le autorizzazioni, recuperare i metadati del file e scaricare i contenuti del file come descritto nel metodo files.get.

Argomenti correlati

Un'app installata deve essere in grado di creare, gestire e aprire azioni avviate dalla UI di Drive. Per scoprire di più, consulta Esegui l'integrazione con il pulsante "Nuovo" della UI di Drive o Esegui l'integrazione con il menu contestuale "Apri con" della UI di Drive.