Google Drive-Oberflächen erstellen

Add-ons für Google Workspace können angepasste Benutzeroberflächen bereitstellen, wenn der Nutzer Google Drive verwendet. So können Sie dem Nutzer zusätzliche relevante Informationen zur Verfügung stellen, Aufgaben automatisieren und Drittanbietersysteme mit Google Drive verbinden.

Auf die Add-on-Benutzeroberfläche zugreifen

Sie können ein Google Workspace-Add-on in Google Drive öffnen, wenn das zugehörige Symbol in der Symbolspalte auf der rechten Seite der Drive-Benutzeroberfläche angezeigt wird. Ein Google Workspace-Add-on kann eine Startseitenoberfläche, eine Elementauswahloberfläche oder beides definieren:

  • Wenn ein Nutzer in Google Drive auf das Add-on-Symbol klickt, führt das Add-on die entsprechende drive.homepageTrigger Funktion aus (falls vorhanden). Diese Funktion erstellt eine Startseitenkarte und gibt sie zur Anzeige an Google Drive zurück. Wenn keine drive.homepageTrigger Funktion definiert ist, wird stattdessen eine generische Startseitenkarte angezeigt.
  • Wenn der Nutzer in Google Drive ein oder mehrere Elemente auswählt und dann auf das Add-on Symbol klickt oder Elemente auswählt, während das Add-on geöffnet ist, führt das Add-on die entsprechende drive.onItemsSelectedTrigger kontextbezogene Funktion aus (falls vorhanden). Diese Funktion erstellt die kontextbezogene Benutzeroberfläche „Elemente ausgewählt“ des Add-ons für Google Drive und gibt sie zur Anzeige an Google Drive zurück.

Drive-Benutzeroberfläche des Add-ons erstellen

Sie können Benutzeroberflächen erstellen, die Google Drive erweitern. Führen Sie dazu die folgenden allgemeinen Schritte aus:

  1. Entscheiden Sie, ob Ihr Add-on eine Drive-spezifische Startseite haben soll. Entscheiden Sie auch, ob Sie eine kontextbezogene Benutzeroberfläche bereitstellen möchten, wenn der Nutzer Drive-Elemente auswählt.
  2. Fügen Sie dem Manifest des Add-on-Skriptprojekts die entsprechenden addOns.common und addOns.drive Felder hinzu, einschließlich aller erforderlichen Drive-Bereiche.
  3. Wenn Sie eine Drive-spezifische Startseite, implementieren Sie die drive.homepageTrigger Funktion, um diese Benutzeroberfläche zu erstellen. Sie können die common.homepageTrigger Benutzeroberfläche auch für mehrere Google Workspace-Hosts verwenden.
  4. Wenn Sie eine kontextbezogene Benutzeroberfläche für die Elementauswahl in Drive bereitstellen, müssen Sie eine drive.onItemsSelectedTrigger kontextbezogene Triggerfunktion implementieren, um diese Benutzeroberfläche zu erstellen. Weitere Informationen finden Sie unter Kontextbezogene Benutzeroberfläche für ausgewählte Elemente in Drive) .
  5. Implementieren Sie die zugehörigen Callback-Funktionen, die erforderlich sind, um auf die Benutzeroberflächeninteraktionen des Nutzers zu reagieren, z. B. auf Schaltflächenklicks.

Drive-Startseiten

Google Drive unterstützt die Anzeige von Google Workspace-Add-on Startseiten. Wenn Sie die allgemeine Startseite Ihres Add-ons in Google Drive anzeigen möchten, muss sich im Manifest des Add-ons ein addOns.drive Feld befinden.

Alternativ können Sie dem Add-on-Manifest ein drive.homepageTrigger hinzufügen, um eine Drive-spezifische Startseite bereitzustellen.

In beiden Fällen müssen Sie den Namen einer Startseiten-Triggerfunktion im Skriptprojekt Ihres Add-ons angeben. Diese Funktion wird automatisch aufgerufen, um die Drive-Startseite zu erstellen, wenn sie benötigt wird. Sie müssen diese Funktion implementieren, um eine einzelne Card oder ein Array von Card Objekten zu erstellen und zurückzugeben, aus denen die Startseite besteht. An die Startseiten-Triggerfunktion wird ein Ereignisobjekt als Parameter übergeben, das einige allgemeine Informationen wie die Plattform des Clients enthält. Sie können die Daten des Ereignisobjekts verwenden, um die Erstellung der Startseite anzupassen.

Kontextbezogene Benutzeroberfläche für ausgewählte Elemente in Drive

Google Drive verwendet einen kontextbezogenen Trigger, um zu bestimmen, welche Benutzeroberfläche (falls vorhanden) angezeigt werden soll, wenn der Nutzer ein oder mehrere Google Drive-Elemente auswählt. Wenn der Trigger ausgelöst wird, führt er die kontextbezogene Triggerfunktion aus, die im drive.onItemsSelectedTrigger.runFunction Feld im Add-on-Manifest angegeben ist.

So erstellen Sie eine kontextbezogene Benutzeroberfläche für die Elementauswahl in Drive:

  1. Das Manifest des Add-ons muss den https://www.googleapis.com/auth/drive.addons.metadata.readonly Bereich enthalten.

  2. Das Manifest muss einen drive.onItemsSelectedTrigger Abschnitt enthalten.

  3. Implementieren Sie die Funktion, die im drive.onItemsSelectedTrigger Feld angegeben ist. Diese Funktion akzeptiert ein Ereignisobjekt als Argument und muss entweder ein einzelnes Card-Objekt oder ein Array von Card-Objekten zurückgeben.

  4. Wie bei jeder Karte müssen Sie alle Callback-Funktionen implementieren, die verwendet werden, um die Widget-Interaktivität für die Benutzeroberfläche bereitzustellen. Wenn Sie beispielsweise eine Schaltfläche in die Benutzeroberfläche einfügen, sollte sie eine angehängte Aktion und eine implementierte Callback-Funktion haben, die ausgeführt wird, wenn auf die Schaltfläche geklickt wird.

Ereignisobjekte

Ein Ereignisobjekt wird erstellt und an die drive.homepageTrigger oder drive.onItemsSelectedTrigger Triggerfunktion übergeben, wenn diese Funktionen aufgerufen werden. Die Triggerfunktion kann anhand der Informationen in diesem Ereignisobjekt bestimmen, wie Add-on-Karten erstellt werden oder wie das Add-on-Verhalten gesteuert wird.

Die vollständige Struktur von Ereignisobjekten wird unter Ereignisobjekte beschrieben. Wenn Drive die Host-App des Add-ons ist, enthalten kontextbezogene Ereignisobjekte das Feld „Drive-Ereignisobjekt“ , das Drive-spezifische Clientinformationen enthält.

Kontextbezogene Drive-Ereignisobjekte für Trigger zur Elementauswahl enthalten Informationen zu den Elementen, die der Nutzer ausgewählt hat, als der Trigger ausgelöst wurde. Wenn ein Nutzer in Drive mehrere Elemente auswählt, wird eines der Elemente als primär relevant betrachtet. Dieses Element wird als aktives Cursor-Element bezeichnet.

Das folgende Beispiel zeigt ein Drive-Ereignisobjekt , das an eine drive.onItemsSelectedTrigger -Funktion übergeben wird:

    {
      "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"
          },
          ...
        ]
      },
      ...
    }