Tworzenie interfejsów Dysku Google

Dodatki Google Workspace mogą zapewniać dostosowane interfejsy, gdy użytkownik otworzy Dysk. Dzięki temu możesz dostarczać użytkownikowi dodatkowe istotne informacje, automatyzować zadania i łączyć systemy innych firm z Dyskiem.

Dostęp do interfejsu dodatku Google Workspace

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

Tworzenie interfejsu dodatku na Dysku

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

  1. Zdecyduj, czy chcesz, aby Twój dodatek miał stronę główną specyficzną dla Dysku. Zdecyduj też, czy chcesz udostępnić interfejs kontekstowy, gdy użytkownik wybierze elementy na Dysku.
  2. Dodaj odpowiednie addOns.common i addOns.drive pola do manifestu projektu skryptu dodatku, w tym wszystkie wymagane zakresy Dysku.
  3. Jeśli udostępniasz stronę główną specyficzną dla Dysku, zaimplementuj funkcję drive.homepageTrigger , aby utworzyć ten interfejs. Możesz też użyć interfejsu common.homepageTrigger w przypadku wielu hostów Google Workspace.
  4. Jeśli udostępniasz kontekstowy interfejs wyboru elementu na Dysku , musisz zaimplementować funkcję aktywatora kontekstowego drive.onItemsSelectedTrigger , aby utworzyć ten interfejs. Szczegółowe informacje znajdziesz w artykule Kontekstowy interfejs Dysku dla wybranych elementów.
  5. Zaimplementuj powiązane funkcje wywołań zwrotnych, które są potrzebne do reagowania na interakcje użytkownika z interfejsem, np. kliknięcia przycisków.

Strony główne Dysku

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

Możesz też dodać drive.homepageTrigger do manifestu dodatku, aby udostępnić stronę główną specyficzną dla Dysku.

W obu przypadkach podaj nazwę funkcji aktywatora strony głównej w projekcie skryptu dodatku. Ta funkcja jest automatycznie wywoływana w celu utworzenia strony głównej Dysku, gdy jest to potrzebne. Zaimplementuj tę funkcję, aby utworzyć i zwrócić pojedynczy Card lub tablicę obiektów Card, które tworzą stronę główną. Funkcja aktywatora strony głównej otrzymuje jako parametr obiekt zdarzenia, który zawiera ogólne informacje, takie jak platforma klienta. Użyj danych obiektu zdarzenia, aby utworzyć stronę główną.

Kontekstowy interfejs Dysku dla wybranych elementów

Dysk korzysta z aktywatora kontekstowego, aby określić, jaki interfejs (jeśli w ogóle) ma być wyświetlany, gdy użytkownik wybierze co najmniej 1 element na Dysku. Gdy aktywator zostanie uruchomiony, wykona funkcję aktywatora kontekstowego określoną w polu drive.onItemsSelectedTrigger.runFunction w manifeście dodatku .

Aby utworzyć kontekstowy interfejs wyboru elementu na Dysku:

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

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

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

  4. Podobnie jak w przypadku każdej karty, zaimplementuj wszystkie funkcje wywołań zwrotnych używane do zapewnienia interaktywności widżetu w interfejsie. Jeśli na przykład w interfejsie umieścisz przycisk, powinien on mieć dołączoną czynność i zaimplementowaną funkcję wywołania zwrotnego, która będzie wykonywana po kliknięciu przycisku.

Obiekty zdarzeń

Obiekt zdarzenia jest tworzony i przekazywany do funkcji aktywatora drive.homepageTrigger lub drive.onItemsSelectedTrigger , gdy te funkcje są wywoływane. Funkcja aktywatora używa informacji z tego obiektu zdarzenia, aby określić, jak tworzyć karty dodatku lub w inny sposób kontrolować jego działanie.

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

Kontekstowe obiekty zdarzeń Dysku w przypadku aktywatorów wyboru elementu zawierają informacje o elementach wybranych przez użytkownika, gdy aktywator zostanie uruchomiony. Gdy użytkownik wybierze więcej niż 1 element na Dysku, jeden z nich jest uznawany za element o największym znaczeniu. Ten element jest nazywany aktywnym elementem kursora.

Jeśli działanie dodatku ma dotyczyć wielu wybranych elementów, użyj informacji podanych w drive.selectedItems tablicy w obiekcie zdarzenia, aby je wszystkie zidentyfikować.

Gdy działanie dodatku ma być stosowane tylko do jednego wybranego elementu, użyj informacji podanych w polu obiektu zdarzenia, aby zidentyfikować ten element spośród wszystkich wybranych.drive.activeCursorItem Nie próbuj wywnioskować, którego elementu użyć, na podstawie drive.selectedItems tablicy.

Poniższy przykład przedstawia obiekt zdarzenia Dysku , który jest 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"
      },
      ...
    ]
  },
  ...
}