Tworzenie interfejsów Dysku Google

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

Dostęp do interfejsu dodatku do Google Workspace

Dodatek możesz otworzyć na Dysku, jeśli jego ikona jest widoczna 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 do Dysku

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

  1. Zdecyduj, czy dodatek ma mieć stronę główną w Dysk Google. Zdecyduj też, czy chcesz udostępnić interfejs kontekstowy, gdy użytkownik wybierze elementy Dysku.
  2. Dodaj odpowiednie pola addOns.common i addOns.drive do manifestu projektu skryptu dodatku, w tym wymagane zakresy Dysku.
  3. Jeśli udostępniasz stronę główną specyficzną dla Dysku, zaimplementuj funkcję drive.homepageTrigger do utworzenia tego interfejsu. Możesz też użyć interfejsu common.homepageTrigger w przypadku wielu hostów Google Workspace.
  4. Jeśli udostępniasz interfejs wyboru elementu kontekstowego na Dysku, musisz zaimplementować funkcję aktywatora kontekstowego drive.onItemsSelectedTrigger, aby go utworzyć. Więcej informacji znajdziesz w artykule Interfejs kontekstowy Dysku dla wybranych elementów.
  5. Zaimplementuj powiązane funkcje wywołania zwrotnego potrzebne do reagowania na interakcje użytkownika z interfejsem, takie jak kliknięcia przycisków.

Strony główne Dysku

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

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

W obu przypadkach podaj nazwę funkcji wywołującej stronę główną w projekcie skryptu dodatku. Ta funkcja jest automatycznie wywoływana w razie potrzeby do utworzenia strony głównej Dysku. Zaimplementuj tę funkcję, aby utworzyć i zwrócić pojedynczy obiekt Card lub tablicę obiektów Card, które składają się na stronę główną. Funkcja wywołująca na stronie głównej otrzymuje jako parametr obiekt zdarzenia, który zawiera pewne 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 wyzwalacza kontekstowego, aby określić, jaki interfejs (jeśli w ogóle) ma być wyświetlany, gdy użytkownik wybierze co najmniej 1 element Dysku. Gdy wywoływacz zostanie uruchomiony, wykona funkcję wywoływacza kontekstowego określoną w polu drive.onItemsSelectedTrigger.runFunction w manifeście dodatku.

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

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

  2. Upewnij się, że plik manifestu 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 obiekt Card lub tablicę obiektów Card.

  4. Podobnie jak w przypadku każdej karty zaimplementuj wszystkie funkcje wywołania zwrotnego 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ą akcję i zastosowaną funkcję wywołania zwrotnego, która będzie uruchamiana po kliknięciu przycisku.

Obiekty zdarzeń

Gdy wywoływane są funkcje wyzwalające drive.homepageTrigger lub drive.onItemsSelectedTrigger, tworzony jest obiekt zdarzenia i przekazywany do tych funkcji. Funkcja reguły używa informacji z tego obiektu zdarzenia, aby określić, jak tworzyć karty dodatkowe lub w inny sposób kontrolować ich działanie.

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

Obiekty zdarzeń kontekstowych na Dysku w przypadku reguł wyboru elementów zawierają informacje o elementach wybranych przez użytkownika, gdy reguła zostanie uruchomiona. 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 elementem aktywnego kursora.

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

Jeśli działanie dodatku powinno być stosowane tylko do jednego wybranego elementu, użyj informacji podanych w polu drive.activeCursorItem obiektu zdarzenia, aby zidentyfikować element z pełnego wyboru. Nie próbuj wywnioskować, którego elementu użyć, z tablicy drive.selectedItems.

Poniższy przykład pokazuje obiekt zdarzenia na 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"
      },
      ...
    ]
  },
  ...
}