Tworzenie interfejsów Dysku Google

Dodatki do Google Workspace zapewniają gdy użytkownik korzysta z Dysku Google. Dzięki temu użytkownik może z dodatkowymi przydatnymi informacjami, automatyzować zadania i łączyć się z innymi firmami na Dysku Google.

Uzyskiwanie dostępu do interfejsu dodatku

Możesz otworzyć dodatek do Google Workspace w: Dysku Google, jeśli jego ikona znajduje się w w prawej części interfejsu Dysku. Dodatek Google Workspace może zdefiniować interfejs strony głównej, interfejs wyboru elementów lub oba te interfejsy:

  • Jeśli użytkownik kliknie ikonę dodatku na Dysku Google, dodatek wykona odpowiednią funkcję drive.homepageTrigger (jeśli jest dostępna). Ta funkcja tworzy i zwraca kartę strony głównej, na Dysku Google, aby je wyświetlać. Jeśli nie zdefiniowano funkcji drive.homepageTrigger, wyświetla się ogólna karta strony głównej.
  • Jeśli użytkownik wybierze co najmniej 1 element na Dysku Google, a następnie kliknie ikonę dodatku lub wybierze elementy podczas otwartego dodatku, dodatek wykona odpowiednią funkcję kontekstową drive.onItemsSelectedTrigger (jeśli jest dostępna). Ta funkcja tworzy Dysk Google dodatku kontekstowe „wybrane elementy” i zwraca go na Dysk Google.

Tworzenie interfejsu dodatku do Dysku

Interfejsy Dysku Google możesz tworzyć, postępując zgodnie z tymi ogólnymi wskazówkami kroki:

  1. Określ, czy chcesz, aby dodatek był specyficzny dla Dysku. stronie głównej. Zdecyduj też, czy chcesz udostępnić interfejs kontekstowy, gdy użytkownik wybierze elementy Dysku.
  2. Dodaj odpowiednie pola addOns.commonaddOns.drive do manifestu projektu skryptu dodatku, w tym zakresów Dysku, które są wymagane.
  3. Jeśli podajesz stronę główną dla Dysku, zastosuj drive.homepageTrigger do tworzenia tego interfejsu. 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. Zaimplementować powiązane funkcje wywołania zwrotnego niezbędne do reagowania na interakcje z interfejsem, np. 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ć atrybut drive.homepageTrigger w pliku manifestu dodatku, aby udostępnić stronę główną dla Dysku.

W obu przypadkach musisz podać nazwę funkcji reguły strony głównej w projekcie skryptu dodatku. Ta funkcja jest wywoływana automatycznie, aby w razie potrzeby utworzyć stronę główną Dysku. Funkcję tę należy zaimplementować, aby skompilować zwróci jeden Card lub tablica Card obiekty składające się na stronę główną. Funkcja aktywatora strony głównej jest przekazywana w obiekt zdarzenia jako parametr zawierający ogólne informacje, np. dotyczące platformy. 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 uruchamia się, wykonuje on funkcję wyzwalacza kontekstowego wskazaną przez drive.onItemsSelectedTrigger.runFunction w pliku manifestu dodatku.

Aby utworzyć interfejs wyboru elementów kontekstowych na Dysku:

  1. Sprawdź, czy plik manifestu dodatku zawiera https://www.googleapis.com/auth/drive.addons.metadata.readonly zakres

  2. Sprawdź, czy plik manifestu zawiera 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. Tak jak w przypadku każdej karty, musisz zaimplementować funkcje wywołania zwrotnego służące do i aktywności widżetów w interfejsie. Jeśli na przykład dodasz przycisk interfejs, powinien mieć dołączony Działanie i wdrożoną funkcję wywołania zwrotnego, która jest uruchamiana 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 aktywująca może używać funkcji informacji w tym obiekcie zdarzenia, aby określić sposób tworzenia kart dodatkowych lub w inny sposób kontrolować jego działanie.

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.

Kontekstowe obiekty zdarzeń na Dysku na potrzeby reguł wyboru elementu zawierają informacje o elementach wybranych przez użytkownika w momencie uruchomienia 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 pokazuje 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"
          },
          ...
        ]
      },
      ...
    }