Tworzenie interfejsów Dysku Google

Dodatki do Google Workspace umożliwiają korzystanie z niestandardowych interfejsów, gdy użytkownik korzysta z Dysku Google. Dzięki temu możesz przekazywać użytkownikom dodatkowe informacje, automatyzować zadania i łączyć systemy innych firm z Dyskiem Google.

Dostęp do interfejsu dodatku

Możesz otworzyć dodatek do Google Workspace na Dysku Google, jeśli jego ikona znajduje się w kolumnie ikony po prawej stronie interfejsu Dysku. Dodatek do Google Workspace może definiować interfejs strony głównej, interfejs wyboru elementu lub oba te elementy:

  • Jeśli użytkownik kliknie ikonę dodatku na Dysku Google, dodatek uruchomi odpowiednią funkcję drive.homepageTrigger (jeśli jest dostępna). Ta funkcja tworzy i zwraca kartę strony głównej na Dysk Google w celu wyświetlenia. Jeśli nie zdefiniowano żadnej 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 ten element, gdy dodatek jest otwarty, dodatek uruchomi odpowiednią funkcję kontekstową drive.onItemsSelectedTrigger (jeśli jest dostępna). Ta funkcja tworzy kontekstowy interfejs wybranych elementów dodatku Google i zwraca go na Dysk Google w celu wyświetlenia.

Tworzenie interfejsu dodatku w Dysku

Możesz tworzyć interfejsy, które rozszerzają Dysk Google, wykonując te czynności:

  1. Określ, czy dodatek ma mieć stronę główną przeznaczoną dla Dysku. Zdecyduj też, czy chcesz udostępnić interfejs kontekstowy, gdy użytkownik wybierze elementy na Dysku.
  2. Dodaj odpowiednie pola addOns.common i addOns.drive do pliku manifestu projektu skryptu, w tym wszystkich zakresów Dysku.
  3. Jeśli udostępniasz stronę główną Dysku, zaimplementuj funkcję drive.homepageTrigger, aby utworzyć ten interfejs. Możesz też użyć interfejsu common.homepageTrigger na potrzeby wielu hostów Google Workspace.
  4. Jeśli udostępniasz interfejs kontekstowego wyboru elementu na Dysku, musisz skompilować funkcję aktywatora kontekstowego drive.onItemsSelectedTrigger, aby utworzyć ten interfejs. Więcej informacji znajdziesz w sekcji Interfejs kontekstowy Dysku dla wybranych elementów.
  5. Zaimplementuj powiązane funkcje wywołania zwrotnego niezbędne do reagowania na interakcje interfejsu użytkownika, takie jak kliknięcia przycisków.

Strona główna Dysku

Dysk Google obsługuje wyświetlanie stron głównych dodatku 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ć plik drive.homepageTrigger do pliku manifestu dodatku, aby udostępnić stronę główną Dysku.

W obu przypadkach musisz podać nazwę funkcji aktywatora strony głównej w projekcie skryptu dodatku. Ta funkcja jest automatycznie wywoływana w celu utworzenia strony głównej Dysku. Musisz wdrożyć 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 aktywatora strony głównej jest przekazywana jako parametr zdarzenia jako parametr zawierający ogólne informacje, takie jak platforma klienta. Za pomocą danych obiektu zdarzenia możesz dostosować konstrukcję strony głównej.

Interfejs kontekstowy Dysku dla wybranych elementów

Dysk Google korzysta z kontekstowego aktywatora do określania, który interfejs (jeśli istnieje) ma być wyświetlany, gdy użytkownik wybierze co najmniej jeden element z Dysku Google. Po uruchomieniu aktywatora uruchomi funkcję kontekstową określoną w polu drive.onItemsSelectedTrigger.runFunction w pliku manifestu dodatku.

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

  1. Upewnij się, że w pliku manifestu dodatku znajduje się https://www.googleapis.com/auth/drive.addons.metadata.readonly zakres

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

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

  4. Tak jak w przypadku każdej karty, musisz zaimplementować wszelkie funkcje wywołania zwrotnego służące do zapewnienia interaktywności widżetów dla interfejsu. Na przykład przycisk w interfejsie powinien zawierać dołączone działanie oraz wdrożoną funkcję wywołania zwrotnego, która działa po kliknięciu przycisku.

Obiekty zdarzeń

Zostanie utworzony obiekt zdarzenia i przekazany do funkcji drive.homepageTrigger lub drive.onItemsSelectedTrigger po wywołaniu tych funkcji. Funkcja aktywatora może użyć informacji z tego obiektu zdarzenia do określenia, jak tworzyć karty dodatkowe lub w inny sposób kontrolować działanie dodatku.

Pełną strukturę obiektów zdarzeń opisano w sekcji Obiekty zdarzeń. Gdy Dysk jest aplikacją hosta hosta dodatku, obiekty zdarzeń kontekstowych zawierają pole Dysk zdarzenia, które zawiera informacje dotyczące klienta.

Obiekty zdarzeń na Dysku związanych z regułami wyboru elementów zawierają informacje o elementach wybranych przez użytkownika po uruchomieniu reguły. Gdy użytkownik wybiera na Dysku więcej niż 1 element, jeden z nich jest uznawany za podstawowy. Jest on nazywany aktywnym kursorem kursora.

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"
          },
          ...
        ]
      },
      ...
    }