Configurare un'integrazione di Drive dell'interfaccia utente

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

Abilitare 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 l'UI di Google Drive, devi abilitare l'API Drive. In questo modo avrai accesso all'API e alle funzionalità di integrazione dell'UI.

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

  Abilitare l'API

Configurare l'integrazione dell'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 dell'UI di Drive.
4. (Facoltativo) Inserisci un nome nel campo Nome applicazione. Il nome dell'applicazione viene mostrato agli utenti nella scheda Gestisci app delle impostazioni di Drive.
5. (Facoltativo) Inserisci una breve descrizione di una riga nel campo Breve descrizione. La breve descrizione viene mostrata agli utenti nella scheda Gestisci app delle 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. Potrebbero essere necessarie fino a 24 ore prima che le icone vengano visualizzate in Drive.

8. Per utilizzare la voce di menu "Apri con" dell'UI di Drive, inserisci l'URL della tua app nel campo Apri URL. 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 con limitazioni per gli utenti selezionati, ogni versione deve utilizzare un URL univoco. Puoi quindi creare configurazioni di app diverse per ogni versione.
   • Prima di poter elencare la tua app in Google Workspace Marketplace, devi verificare la proprietà di questo URL.
   • Per impostazione predefinita, a questo URL viene aggiunto un parametro di query state per trasmettere i dati dall'UI di Drive alla tua app. Per informazioni su i contenuti del parametro state, vedi Il parametro state parameter.

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 è progettata in modo univoco per aprire. Ad esempio, la tua app potrebbe aprire un formato integrato per la stratificazione e la modifica delle immagini. Includi solo i tipi di media standard e assicurati che non contengano errori di battitura e ortografici. Se la tua app apre solo file di scorciatoie o di scorciatoie di terze parti, puoi lasciare vuoto il tipo MIME.

10. (Facoltativo) Inserisci i tipi MIME e le estensioni file secondari nei campi Tipi MIME secondari ed Estensioni file secondarie. I tipi MIME e le estensioni 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 modifica delle immagini che apre immagini PNG e JPG. Includi solo i tipi di media standard e assicurati che non contengano errori di battitura e ortografici. Se la tua app apre solo file di scorciatoie o di scorciatoie di terze parti, puoi lasciare vuoto il tipo MIME.

11. Per utilizzare il pulsante "Nuovo " dell'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.
    • Prima di poter elencare la tua app in Google Workspace Marketplace, devi verificare la proprietà di questo URL.
    • Per impostazione predefinita, a questo URL viene aggiunto un parametro di query state per trasmettere i dati dall'UI di Drive alla tua app. Per informazioni su i contenuti del parametro state, vedi Il parametro state parameter.

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 sui Drive condivisi, seleziona la casella Supporto per i Drive condivisi. Per ulteriori informazioni su come supportare i Drive condivisi nella tua app, vedi Implementare il supporto per i Drive condivisi.

15. Fai clic su Invia.

Richiedere l'ambito drive.install

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

Per ulteriori informazioni sugli ambiti che puoi richiedere per le app di Drive, e su come richiederli, vedi Informazioni su autorizzazione e autenticazione specifiche per API informazioni.

Il parametro state

Per impostazione predefinita, a entrambi gli URL Apri URL e Nuovo URL viene aggiunto un parametro state per trasmettere i dati dall'UI di Drive alla tua app. Questo parametro contiene una stringa con codifica JSON con variabili di modello e dati sulla richiesta alla tua app. Le variabili incluse dipendono dal tipo di URL utilizzato (Apri URL o Nuovo URL):

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 sullo 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 Apri URL

Le informazioni sullo state per un Apri URL 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 la tua 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 files.get metodo.

Argomenti correlati

Un'app installata deve essere in grado di creare, gestire e aprire le azioni avviate dall'UI di Drive. Per scoprire di più, vedi Eseguire l'integrazione con il pulsante "Nuovo" dell'UI di Drive o Eseguire l'integrazione con il menu contestuale "Apri con" dell'UI di Drive.