Tworzenie interfejsów Dysku Google

Dodatki Google Workspace mogą zapewniać niestandardowe interfejsy, gdy użytkownik korzysta z Dysku Google. Dzięki temu możesz udostępnić użytkownikowi dodatkowe informacje, zautomatyzować zadania i połączyć systemy innych firm z Dyskiem Google.

Otwieranie interfejsu dodatku

Dodatek Google Workspace możesz otworzyć na Dysku Google, jeśli jego ikona pojawi się w kolumnie z ikonami po prawej stronie interfejsu użytkownika Dysku. Dodatek Google Workspace może definiować interfejs strony głównej, interfejs wyboru elementu lub oba te interfejsy:

Tworzenie interfejsu dodatku do Dysku

Aby tworzyć interfejsy rozszerzające Dysk Google, wykonaj te ogólne czynności:

  1. Zdecyduj, czy Twój dodatek ma mieć stronę główną na Dysku. Zdecyduj też, czy chcesz udostępnić interfejs kontekstowy, gdy użytkownik wybierze elementy Dysku.
  2. Dodaj odpowiednie pola addOns.common i addOns.drive do manifest projektu skryptu dodatku, w tym wymagane zakresy Dysku.
  3. Jeśli udostępniasz stronę główną w usłudze Dysk, użyj funkcji drive.homepageTrigger, aby utworzyć ten interfejs. Możesz też użyć interfejsu common.homepageTrigger dla wielu hostów Google Workspace.
  4. Jeśli udostępniasz interfejs do wybierania elementów na podstawie kontekstu na Dysku, musisz zaimplementować funkcję drive.onItemsSelectedTrigger, aby utworzyć ten interfejs. Więcej informacji znajdziesz w interfejsie kontekstowym Dysku.
  5. Wdrożyć powiązane funkcje wywołania zwrotnego, które są potrzebne do reagowania na interakcje użytkownika z interfejsem użytkownika, takie jak kliknięcia przycisków.

Strony główne Dysku

Dysk Google obsługuje wyświetlanie stron głównych dodatków Google Workspace. Aby wyświetlić wspólną stronę główną dodatku na Dysku Google, upewnij się, że w pliku manifestu dodatku jest pole addOns.drive.

Możesz też dodać do pliku manifestu dodatku element drive.homepageTrigger, aby wyświetlać stronę główną na Dysku.

W obu przypadkach musisz podać nazwę funkcji reguły strony głównej w projekcie skryptu dodatku. Ta funkcja jest automatycznie wywoływana, aby w razie potrzeby utworzyć stronę główną Dysku. Musisz zaimplementować tę funkcję, aby utworzyć i zwrócić pojedynczy obiekt Card lub tablicę obiektów Card, które tworzą stronę główną. Funkcja reguły strony głównej otrzymuje obiekt zdarzenia jako parametr, który zawiera ogólne informacje, takie jak platforma klienta. Dane obiektu zdarzenia możesz wykorzystać do dostosowania tworzenia strony głównej.

Interfejs kontekstowy Dysku dla wybranych elementów

Dysk Google korzysta z wyzwalacza kontekstowego, aby określić, jaki interfejs (jeśli w ogóle) ma się wyświetlić, gdy użytkownik wybierze co najmniej 1 element Dysku Google. Gdy wyzwalacz zostanie uruchomiony, wykona funkcję wyzwalacza kontekstowego określoną przez pole drive.onItemsSelectedTrigger.runFunction w manifest dodatku.

Aby utworzyć interfejs wyboru elementów kontekstowych na Dysku, wykonaj te czynności:

  1. Upewnij się, że plik manifestu dodatku zawiera pole https://www.googleapis.com/auth/drive.addons.metadata.readonly zakres

  2. Upewnij się, że manifest zawiera sekcję drive.onItemsSelectedTrigger.

  3. Wdroż funkcję o nazwie podanej w polu drive.onItemsSelectedTrigger. Ta funkcja przyjmuje jako argument obiekt zdarzenia i musi zwracać pojedynczy obiekt Card lub tablicę obiektów Card.

  4. Podobnie jak w przypadku innych kart, musisz zaimplementować funkcje wywołania zwrotnego, które umożliwią interakcję z widżetem w interfejsie. Jeśli na przykład dodasz do interfejsu przycisk, powinien on mieć przypisaną działanie i zaimplementowaną funkcję wywołania zwrotnego, która będzie wykonywana po kliknięciu przycisku.

Obiekty zdarzeń

Podczas wywołania tych funkcji tworzony jest obiekt zdarzenia i przekazywany do funkcji drive.homepageTrigger lub drive.onItemsSelectedTrigger. Funkcja reguły może używać informacji z tego obiektu zdarzenia do określania sposobu tworzenia kart dodatku lub do kontrolowania zachowania dodatku.

Pełna struktura obiektów zdarzeń jest opisana w artykule Obiekty zdarzenia. Gdy Dysk jest hostującą aplikacją dodatku, obiekty zdarzeń kontekstowych zawierają pole obiektu zdarzenia na Dysku, które zawiera informacje o kliencie dotyczące Dysku.

Obiekty zdarzeń kontekstowych Dysku w przypadku reguł wyboru produktu zawierają informacje o elementach wybranych przez użytkownika w momencie wywołania reguły. Gdy użytkownik wybierze więcej niż 1 element na Dysku, jeden z nich zostanie uznany za element o największym znaczeniu. Taki element jest nazywany elementem aktywnym kursora.

Ten przykład przedstawia obiekt zdarzenia z Drive przekazywany do funkcji 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"
          },
          ...
        ]
      },
      ...
    }