Creazione delle interfacce di Google Drive

I componenti aggiuntivi di Google Workspace possono fornire quando l'utente usa Google Drive. Questo ti permette di fornire all'utente ottenere ulteriori informazioni pertinenti, automatizzare le attività e mettere in contatto i tuoi sistemi su Google Drive.

Accesso all'interfaccia utente del componente aggiuntivo

Puoi aprire un componente aggiuntivo di Google Workspace in Google Drive, se la sua icona appare nel colonna dell'icona sul lato destro dell'interfaccia utente di Drive. R Il componente aggiuntivo di Google Workspace può definisci un'interfaccia della home page, un'interfaccia di selezione degli elementi o entrambe:

  • Se un utente fa clic sull'icona del componente aggiuntivo su Google Drive, il componente aggiuntivo esegue il token drive.homepageTrigger corrispondente (se presente). Questa funzione crea e restituisce una scheda home page su Google Drive per la visualizzazione. In caso contrario drive.homepageTrigger viene definita una funzione, viene visualizzata una scheda generica della home page.
  • Se l'utente seleziona uno o più elementi su Google Drive e poi fa clic sul componente aggiuntivo o seleziona gli elementi mentre il componente aggiuntivo è aperto, il componente esegue drive.onItemsSelectedTrigger funzione contestuale (se presente). Questa funzione crea il Google Drive del componente aggiuntivo "elementi selezionati" contestuali interfaccia e lo restituisce a Google Drive per la visualizzazione.

Creazione dell'interfaccia del componente aggiuntivo Drive

Puoi creare interfacce che estendono Google Drive seguendo queste informazioni generali passaggi:

  1. Decidi se il tuo componente aggiuntivo deve avere un'interfaccia specifica homepage. Decidi anche se vuoi fornire un'interfaccia contestuale per quando e seleziona gli elementi di Drive.
  2. Aggiungi il token appropriato addOns.common e addOns.drive campi per il progetto di script del componente aggiuntivo manifest, inclusi eventuali ambiti Drive richiesti.
  3. Se fornisci una home page specifica per Drive, di implementare drive.homepageTrigger: per creare questa interfaccia. Puoi anche scegliere di utilizzare common.homepageTrigger per più host Google Workspace.
  4. Se fornisci un'interfaccia di selezione degli elementi contestuali di Drive, devi implementare un drive.onItemsSelectedTrigger di trigger contestuale per creare questa interfaccia. Vedi Interfaccia contestuale di Drive per gli elementi selezionati) per maggiori dettagli.
  5. Implementare le funzioni di callback associate necessarie per rispondere alla richiesta Interazioni con l'interfaccia utente, come i clic sui pulsanti.

Home page di Drive

Google Drive supporta la visualizzazione del componente aggiuntivo di Google Workspace home page. Per visualizzare la home page comune del componente aggiuntivo su Google Drive, assicurati semplicemente che è un campo addOns.drive nel file manifest del componente aggiuntivo.

In alternativa, aggiungi un elemento drive.homepageTrigger al file manifest del componente aggiuntivo per fornire una home page specifica per Drive.

In entrambi i casi, devi specificare il nome di una funzione di trigger della home page nel progetto di script del componente aggiuntivo. Questa funzione viene chiamata automaticamente per creare Home page di Drive quando necessario. Devi implementare questa funzione per creare e restituiscono un singolo Card o un array di Card: gli oggetti che compongono la home page. Alla funzione di trigger della home page viene inviato oggetto evento parametro contenente alcune informazioni generali come il parametro completamente gestita. Puoi utilizzare i dati dell'oggetto evento per personalizzare la costruzione dell'oggetto homepage.

Interfaccia contestuale di Drive per gli elementi selezionati

Google Drive si basa su un trigger contestuale per determinare quale interfaccia (se presenti) da visualizzare quando l'utente seleziona uno o più elementi di Google Drive. Quando l'attivatore si attiva, esegue la funzione di attivazione contestuale specificata drive.onItemsSelectedTrigger.runFunction nel campo manifest del componente aggiuntivo.

Per creare un'interfaccia di selezione contestuale degli elementi per Drive, devi eseguire la seguenti:

  1. Assicurati che il manifest del componente aggiuntivo includa il parametro https://www.googleapis.com/auth/drive.addons.metadata.readonly ambito

  2. Assicurati che il manifest includa un drive.onItemsSelectedTrigger .

  3. Implementare la funzione denominata nel drive.onItemsSelectedTrigger . Questa funzione accetta un oggetto evento come argomento e deve restituire un solo Card o un array di Card oggetti.

  4. Come per qualsiasi carta, devi implementare le funzioni di callback utilizzate per fornire l'interattività del widget per l'interfaccia. Ad esempio, se includi un pulsante nell'interfaccia, dovrebbe avere un allegato Azione e una funzione di callback implementata che viene eseguita quando un utente fa clic sul pulsante.

Oggetti evento

Viene creato e passato un oggetto evento. alle drive.homepageTrigger oppure drive.onItemsSelectedTrigger quando vengono richiamate queste funzioni. La funzione trigger può utilizzare le informazioni in questo oggetto evento per determinare come costruire le schede dei componenti aggiuntivi o controllare il comportamento del componente aggiuntivo.

La struttura completa degli oggetti evento è descritta in Oggetti evento. Se Drive è l'app ospitante del componente aggiuntivo, gli oggetti degli eventi contestuali includi il Oggetto evento Drive che contiene informazioni sul client specifiche di Drive.

Gli oggetti di eventi contestuali di Drive per gli attivatori di selezione degli elementi includono informazioni sugli elementi selezionati dall'utente quando l'attivatore si attiva. Quando un utente seleziona più di un elemento in Drive, uno degli elementi è considerato uno di interesse principale; questo elemento è indicato come elemento del cursore attivo.

L'esempio seguente mostra un Oggetto evento Drive che viene passato a un drive.onItemsSelectedTrigger: :

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }