Google Drive-Oberflächen erstellen

Mit Google Workspace-Add-ons können Sie wenn der Nutzer Google Drive verwendet. So können Sie dem Nutzer zusätzliche relevante Informationen abrufen, Aufgaben automatisieren und auf Google Drive übertragen.

Auf die Add-on-UI zugreifen

Sie können ein Google Workspace-Add-on in Google Drive öffnen, wenn das Symbol in der Symbolspalte rechts in der Drive-Benutzeroberfläche angezeigt wird. A Das Google Workspace-Add-on kann eine Startseitenoberfläche, eine Oberfläche zur Elementauswahl oder beides definieren:

  • Wenn ein Nutzer in Google Drive auf das Add-on-Symbol klickt, wird das Add-on ausgeführt, das entsprechende drive.homepageTrigger (falls vorhanden). Diese Funktion erstellt eine Startseitenkarte und gibt sie zurück. zur Anzeige in Google Drive. Wenn keine drive.homepageTrigger-Funktion definiert ist, wird stattdessen eine generische Startseitenkarte angezeigt.
  • Wenn der Nutzer ein oder mehrere Elemente in Google Drive auswählt und dann auf das Add-on klickt oder Elemente auswählen, während das Add-on geöffnet ist, führt das Add-on die entsprechenden drive.onItemsSelectedTrigger Kontextfunktion (falls vorhanden). Mit dieser Funktion wird das Google Drive-Konto des Add-ons erstellt. Kontextbezogene "Elemente ausgewählt" Schnittstelle und zur Ansicht an Google Drive zurückgegeben.

Benutzeroberfläche des Add-ons für Google Drive erstellen

So erstellen Sie Oberflächen, die Google Drive erweitern:

  1. Entscheiden Sie, ob das Add-on ein Drive-spezifisches Startseite. Legen Sie auch fest, ob Sie eine kontextbezogene Benutzeroberfläche für den Fall bereitstellen möchten, dass der Nutzer Drive-Elemente auswählt.
  2. Fügen Sie dem Manifest des Add-on-Scripts die entsprechenden Felder addOns.common und addOns.drive hinzu, einschließlich aller erforderlichen Drive-Bereiche.
  3. Wenn Sie eine Drive-spezifische Startseite bereitstellen, implementieren Sie die Funktion drive.homepageTrigger, um diese Benutzeroberfläche zu erstellen. Sie können auch die common.homepageTrigger für mehrere Google Workspace-Hosts.
  4. Wenn Sie eine Benutzeroberfläche für die kontextbezogene Elementauswahl in Google Drive bereitstellen, müssen Sie eine drive.onItemsSelectedTrigger-Kontexttriggerfunktion implementieren, um diese Benutzeroberfläche zu erstellen. Weitere Informationen .
  5. Implementieren Sie die zugehörigen Callback-Funktionen, die erforderlich sind, um auf die UI-Interaktionen des Nutzers zu reagieren, z. B. auf Klicks auf Schaltflächen.

Drive-Startseiten

In Google Drive können Startseiten von Google Workspace-Add-ons angezeigt werden. Damit die Startseite Ihres Add-ons in Google Drive angezeigt wird, ist ein addOns.drive-Feld im Manifest des Add-ons.

Alternativ können Sie drive.homepageTrigger auf das Add-on-Manifest, um eine Drive-spezifische Startseite bereitzustellen.

In beiden Fällen müssen Sie den Namen einer Startseiten-Triggerfunktion in Ihrem das Skriptprojekt des Add-ons. Diese Funktion wird automatisch aufgerufen, um den Drive-Startseite bei Bedarf Sie müssen diese Funktion implementieren, um eine einzelne Card oder ein Array von Card Objekte, aus denen die Startseite besteht. An die Triggerfunktion für die Startseite wird ein Ereignisobjekt als Parameter, der einige allgemeine Informationen enthält, wie z. B. die Plattform. Mit den Daten des Ereignisobjekts können Sie die Erstellung der Startseite anpassen.

Kontextbezogene Benutzeroberfläche für ausgewählte Elemente

In Google Drive wird anhand eines kontextbezogenen Auslösers festgelegt, welche Benutzeroberfläche angezeigt wird, wenn der Nutzer ein oder mehrere Google Drive-Elemente auswählt. Wenn der Parameter ausgelöst wird, führt er die kontextabhängige Triggerfunktion aus, die vom drive.onItemsSelectedTrigger.runFunction im Manifest des Add-ons.

So erstellen Sie eine Oberfläche zur kontextbezogenen Elementauswahl in Drive: Folgendes:

  1. Achten Sie darauf, dass das Manifest des Add-ons Folgendes enthält: https://www.googleapis.com/auth/drive.addons.metadata.readonly Umfang

  2. Achten Sie darauf, dass das Manifest Folgendes enthält: drive.onItemsSelectedTrigger .

  3. Implementieren Sie die im drive.onItemsSelectedTrigger ein. Diese Funktion akzeptiert ein Ereignisobjekt als Argument und es muss entweder eine Card-Objekt oder ein Array von Card-Objekten

  4. Wie bei jeder Karte musst du alle Callback-Funktionen implementieren, die verwendet werden, um Widget-Interaktivität für die Benutzeroberfläche. Wenn Sie beispielsweise eine Schaltfläche in der Benutzeroberfläche sollte ein angehängtes Aktion und eine implementierte Callback-Funktion, die ausgeführt wird, wenn auf die Schaltfläche geklickt wird.

Ereignisobjekte

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

Die vollständige Struktur der Ereignisobjekte wird unter Ereignisobjekte: Wenn Drive die Host-App des Add-ons ist, enthalten kontextbezogene Ereignisobjekte das Feld Drive-Ereignisobjekt, das Drive-spezifische Kundeninformationen enthält.

Kontextbezogene Drive-Ereignisobjekte für Auslöser für die Elementauswahl enthalten Informationen die der Nutzer beim Auslösen des Triggers ausgewählt hat. Wenn ein Nutzer mehrere Elemente in Drive auswählt, wird eines der Elemente als eines der folgenden Elemente angesehen: primäres Interesse wird dieses Element als aktives Cursor-Element bezeichnet.

Das folgende Beispiel zeigt eine Drive-Ereignisobjekt das an eine 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"
          },
          ...
        ]
      },
      ...
    }