Configurare un'integrazione di Drive dell'interfaccia utente

Per visualizzare la tua app su Google Drive quando un utente crea o apre un file: devi innanzitutto configurare un'integrazione con l'interfaccia utente (UI) di Drive. È necessaria anche la configurazione per elencare l'app nella Google Workspace Marketplace.

Abilita l'API Drive

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

Per iniziare l'integrazione con la UI di Google Drive, devi attivare la API Drive. Questo ti permette di accedere all'API e all'integrazione dell'interfaccia utente le funzionalità di machine learning.

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

    Abilita l'API

Configura l'integrazione dell'interfaccia utente di Drive

  1. Nella console API di Google, vai al Menu . > API e Servizi > API abilitate e Google Cloud.

    Vai ad API abilitate e

  2. Nella parte inferiore delle sezioni API e Dashboard dei servizi: fai clic su API Google Drive. La Viene visualizzata la pagina di configurazione dell'API Google Drive.
  3. Seleziona la scheda Integrazione nell'interfaccia utente di Drive.
  4. (Facoltativo) Inserisci un nome nel campo Nome applicazione. L'applicazione il nome viene mostrato agli utenti nella scheda Gestisci applicazioni in Drive impostazioni.
  5. (Facoltativo) Inserisci una breve descrizione di una riga nella Descrizione breve. . La breve descrizione viene visualizzata agli utenti nella scheda Gestisci applicazioni in Impostazioni di Drive.
  6. (Facoltativo) Inserisci una descrizione completa nel campo Descrizione lunga.
  7. Carica una o più icone delle applicazioni da visualizzare nell'elenco di icone di un utente app Drive collegate e nella cartella "Apri con" menu contestuale. Le icone devono essere in formato PNG con uno sfondo trasparente. Le icone possono assumere fino a 24 ore prima di apparire su Drive.

  8. Per utilizzare l'opzione "Apri con" dell'interfaccia utente di Drive menu , inserisci l'URL della tua app nella Apri URL. Questo URL è utilizzato dalla colonna "Apri con" menu contestuale.

    • L'URL deve contenere un nome di dominio completo. localhost non al lavoro.
    • Questo URL deve essere accessibile agli utenti previsti dell'applicazione. Se hai più versioni dell'applicazione, ad esempio una per le applicazioni pubbliche e una per la release limitata per utenti selezionati; ogni versione deve utilizzare un URL univoco. Puoi quindi creare app diverse configurazioni per ogni versione.
    • Devi verificare la proprietà di questo URL prima di poter inserire la tua app in Google Workspace Marketplace.
    • Per impostazione predefinita, a questo URL viene aggiunto un parametro di query state per passare dall'interfaccia utente di Drive all'app. Per informazioni su i contenuti del parametro state; consulta l'articolo The state predefinito.
  9. (Facoltativo) Inserisci le estensioni dei file e i tipi MIME predefiniti nel Campi Tipi MIME predefiniti ed Estensioni file predefinite. MIME predefinito tipi ed estensioni di file rappresentano i file per i quali la tua app è stata creata in modo unico aperta. Ad esempio, la tua app potrebbe aprire un formato integrato per la sovrapposizione la modifica delle immagini. Includi solo contenuti multimediali standard tipi e assicurati che non contengano errori di battitura e errori ortografici. Se l'app apre solo o i file di scorciatoia di terze parti, puoi lasciare vuoto il tipo MIME.

  10. (Facoltativo) Inserisci i tipi MIME secondari e le estensioni dei file nel campo Secondario Campi Tipi MIME ed Estensioni file secondarie. Tipi MIME secondari Le estensioni dei file rappresentano i file che l'app può aprire, ma non sono specifici alla tua app. Ad esempio, la tua app potrebbe essere un'app di modifica delle immagini che apre Immagini PNG e JPG. Includi solo contenuti multimediali standard tipi e assicurati che non contengano errori di battitura e errori ortografici. Se l'app apre solo o i file di scorciatoia di terze parti, puoi lasciare vuoto il tipo MIME.

  11. Per utilizzare l'interfaccia utente di Drive "Nuovo" pulsante e chiedi agli utenti di creare un file un'app, seleziona la casella Creazione di file. Il campo Nuovo URL e la sezione facoltativa Vengono visualizzati i campi Nome documento.

    • L'URL deve contenere un nome di dominio completo. localhost non al lavoro.
    • Devi verificare la proprietà di questo URL prima di poter inserire la tua app in Google Workspace Marketplace.
    • Per impostazione predefinita, a questo URL viene aggiunto un parametro di query state per passare dall'interfaccia utente di Drive all'app. Per informazioni su i contenuti del parametro state; consulta l'articolo The state predefinito.
  12. Inserisci un URL nel campo Nuovo URL. Questo URL viene utilizzato dalla colonna "Nuovo" pulsante 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 l'app deve gestire i file sui Drive condivisi, controlla Assistenza per i Drive condivisi. Per ulteriori informazioni sull'assistenza Drive condivisi nella tua app, consulta Implementare i Drive condivisi assistenza.

  15. Fai clic su Invia.

Richiedi l'ambito drive.install

Per consentire la visualizzazione delle app come opzione nella sezione "Apri con" o il pulsante "Nuovo" menu, richiedi l'integrazione dell'ambito https://www.googleapis.com/auth/drive.install con la UI di Drive. Quando richiedono questo ambito, gli utenti ricevono un di dialogo simile a questa:

Finestra di dialogo di installazione della UI di Google Drive.
Figura 1. La finestra di dialogo di installazione quando utilizzi gli ambiti per la UI di Drive.

Per ulteriori informazioni sugli ambiti che puoi richiedere per le app Drive, e su come richiederle, consulta Autorizzazione e autenticazione specifiche delle API informazioni.

Il parametro state

Per impostazione predefinita, un parametro state viene aggiunto sia all'URL di apertura che al nuovo URL per trasferire i dati dall'UI di Drive all'app. Questo parametro contiene una stringa con codifica JSON con variabili di modello e dati sul richiesta alla tua app. Le variabili incluse dipendono dal tipo di URL utilizzato (Open URL o Nuovo URL):

Variabile di modello Descrizione Applicazione URL
{ids} Un elenco di ID file separati da virgole in fase di apertura. Apri URL
{exportIds} Un elenco di ID file separati da virgole in fase di esportazione (utilizzati solo quando apri i documenti Google integrati). Apri URL
{resourceKeys} Un dizionario JSON di ID file mappati alla rispettiva risorsa chiave. Apri URL
{folderId} L'ID della cartella principale. Nuovo URL
{folderResourceKey} La chiave della risorsa della cartella padre. Nuovo URL
{userId} L'ID profilo che identifica l'utente. Apri URL e nuovo URL
{action} L'azione che viene eseguita. Il valore è open se viene usato un URL di apertura o create quando utilizzi un Nuovo URL. Apri URL e nuovo URL

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

Esempio di informazioni sullo stato in JSON per un nuovo URL

Le informazioni state relative a 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 delle risorse vengono utilizzati per recuperare i metadati del file e scaricare il file contenuti. Una volta che l'app dispone dell'ID file e di un token di accesso, può controllare autorizzazioni, recuperare i metadati del file e scaricare i contenuti del file come descritto nel metodo files.get.

Un'app installata deve essere in grado di creare, gestire e aprire le azioni avviate da la UI di Drive. Per scoprire di più, vedi Eseguire l'integrazione con La UI di Drive "Novità" pulsante o Integrazione con l'opzione "Apri con" della UI di Drive contesto .