Creazione delle interfacce di Google Drive

I componenti aggiuntivi di Google Workspace possono fornire interfacce personalizzate quando l'utente utilizza Google Drive. In questo modo puoi fornire all'utente informazioni aggiuntive pertinenti, automatizzare le attività e connettere sistemi di terze parti a Google Drive.

Accedere all'interfaccia utente del componente aggiuntivo

Puoi aprire un componente aggiuntivo di Google Workspace in Google Drive se la sua icona viene visualizzata nella colonna delle icone sul lato destro dell'interfaccia utente di Drive. Un componente aggiuntivo di Google Workspace può definire un'interfaccia della home page, un'interfaccia di selezione degli elementi o entrambe:

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

Creazione dell'interfaccia del componente aggiuntivo Drive

Per creare interfacce che estendono Google Drive, segui questi passaggi generali:

  1. Decidi se vuoi che il componente aggiuntivo abbia una home page specifica di Drive. Decidi anche se vuoi fornire un'interfaccia contestuale per quando l'utente seleziona gli elementi di Drive.
  2. Aggiungi i campi addOns.common e addOns.drive appropriati al manifest del progetto di script del componente aggiuntivo, inclusi gli ambiti di Drive richiesti.
  3. Se fornisci una home page specifica di Drive, implementa la funzione drive.homepageTrigger per creare questa interfaccia. Puoi anche scegliere di utilizzare l'interfaccia common.homepageTrigger per più host Google Workspace.
  4. Se fornisci un'interfaccia di selezione degli elementi contestuali di Drive, devi implementare una funzione di trigger contestuale drive.onItemsSelectedTrigger per creare questa interfaccia. Per maggiori dettagli, consulta Interfaccia contestuale di Drive per gli elementi selezionati.
  5. Implementa le funzioni di callback associate necessarie per rispondere alle interazioni dell'utente con l'interfaccia utente, ad esempio i clic sui pulsanti.

Home page di Drive

Google Drive supporta la visualizzazione delle home page dei componenti aggiuntivi di Google Workspace. Per mostrare la home page comune del componente aggiuntivo in Google Drive, assicurati che nel manifest del componente aggiuntivo sia presente un campo addOns.drive.

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

In entrambi i casi, devi fornire il nome di una funzione di attivazione della home page nel progetto di script del componente aggiuntivo. Questa funzione viene chiamata automaticamente per creare la home page di Drive quando è necessario. Devi implementare questa funzione per creare e restituire un singolo oggetto Card o un array di oggetti Card che compongono la home page. Alla funzione di attivazione della home page viene passato un oggetto evento come parametro che contiene alcune informazioni generali, ad esempio la piattaforma del client. Puoi utilizzare i dati dell'oggetto evento per personalizzare la creazione della home page.

Interfaccia contestuale di Drive per gli elementi selezionati

Google Drive si basa su un trigger contestuale per determinare quale interfaccia (se presente) visualizzare quando l'utente seleziona uno o più elementi di Google Drive. Quando viene attivato il trigger, viene eseguita la funzione di trigger contestuale specificata dal campo drive.onItemsSelectedTrigger.runFunction nel manifest del componente aggiuntivo.

Per creare un'interfaccia di selezione degli elementi contestuali per Drive, devi svolgere le seguenti operazioni:

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

  2. Assicurati che il manifest includa una sezione drive.onItemsSelectedTrigger.

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

  4. Come per qualsiasi scheda, devi implementare le funzioni di callback utilizzate per fornire l'interattività dei widget per l'interfaccia. Ad esempio, se includi un pulsante nell'interfaccia, deve avere un'azione allegata e una funzione di callback implementata che viene eseguita quando si fa clic sul pulsante.

Oggetti evento

Viene creato e trasmesso un oggetto evento alla funzione di trigger drive.homepageTrigger o drive.onItemsSelectedTrigger quando queste funzioni vengono chiamate. La funzione di attivazione può utilizzare le informazioni contenute in questo oggetto evento per determinare come costruire le schede dei componenti aggiuntivi o controllare in altro modo il comportamento del componente aggiuntivo.

La struttura completa degli oggetti evento è descritta in Oggetti evento. Quando Drive è l'app host del componente aggiuntivo, gli oggetti evento contestuali includono il campo Oggetto evento Drive che contiene informazioni specifiche del client Drive.

Gli oggetti evento contestuali di Drive per gli attivatori di selezione degli elementi includono informazioni sugli elementi selezionati dall'utente quando viene attivato l'attivatore. Quando un utente seleziona più di un elemento in Drive, uno degli elementi viene considerato di interesse principale; questo elemento viene chiamato elemento del cursore attivo.

L'esempio seguente mostra un oggetto evento Drive che viene passato a una funzione 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"
          },
          ...
        ]
      },
      ...
    }