Tworzenie interfejsów Dysku Google

Dodatki do Google Workspace mogą zapewniać niestandardowe interfejsy, gdy użytkownik korzysta z Dysku Google. Dzięki temu możesz przekazywać użytkownikom dodatkowe istotne informacje, automatyzować zadania i łączyć z Dyskiem Google systemy innych firm.

Uzyskiwanie dostępu do interfejsu dodatku

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

  • 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 ją wyświetlić. Jeśli nie zdefiniowano żadnej funkcji drive.homepageTrigger, wyświetlana jest ogólna karta na stronie głównej.
  • Jeśli użytkownik wybierze co najmniej 1 element na Dysku Google, a następnie kliknie ikonę dodatku lub wybierze elementy, gdy dodatek jest otwarty, dodatek wykona odpowiednią funkcję kontekstową drive.onItemsSelectedTrigger (jeśli jest dostępna). Ta funkcja tworzy kontekstowy interfejs „wybranych elementów” na Dysku Google dodatku i zwraca go na Dysk Google, aby go wyświetlić.

Tworzenie interfejsu dodatku na Dysku

Możesz utworzyć interfejsy rozszerzające Dysk Google, wykonując te ogólne kroki:

  1. Określ, czy dodatek ma mieć stronę główną Dysku. Określ też, czy po kliknięciu przez użytkownika elementów na Dysku ma być wyświetlany interfejs kontekstowy.
  2. Dodaj odpowiednie pola addOns.common i addOns.drive do pliku manifestu projektu dodatku wraz z wymaganymi zakresami Dysku.
  3. Jeśli udostępniasz stronę główną Dysku, zaimplementuj funkcję drive.homepageTrigger, aby utworzyć ten interfejs. Możesz też używać interfejsu common.homepageTrigger dla wielu hostów Google Workspace.
  4. Jeśli udostępniasz interfejs wyboru elementów kontekstowych na Dysku, musisz zaimplementować 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 użytkownika w interfejsie, np. na kliknięcia przycisku.

Strony główne Dysku

Dysk Google obsługuje wyświetlanie stron głównych dodatków do Google Workspace. Aby wyświetlić wspólną stronę główną dodatku na Dysku Google, sprawdź, czy 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ą Dysku.

W obu przypadkach musisz podać nazwę funkcji aktywatora strony głównej w projekcie skryptu dodatku. W razie potrzeby funkcja ta jest automatycznie wywoływana do utworzenia strony głównej Dysku. Musisz wdrożyć tę funkcję, by 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 przekazuje obiekt zdarzenia jako parametr, który zawiera ogólne informacje, np. o platformie klienta. Za pomocą danych obiektu zdarzenia możesz dostosować konstrukcję strony głównej.

Interfejs kontekstowy Dysku dla wybranych elementów

Dysk Google korzysta z reguł zależnych od kontekstu, aby określić, jaki interfejs (jeśli jest dostępny) zostanie wyświetlony po wybraniu przez użytkownika co najmniej jednego elementu na Dysku Google. Po uruchomieniu aktywator wykonuje funkcję aktywatora kontekstowego określoną w polu drive.onItemsSelectedTrigger.runFunction w pliku manifestu dodatku.

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

  1. Sprawdź, czy plik manifestu dodatku zawiera 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 w polu drive.onItemsSelectedTrigger. Ta funkcja akceptuje obiekt zdarzenia jako argument i musi zwracać pojedynczy obiekt Card lub tablicę obiektów Card.

  4. Jak w przypadku każdej karty, musisz zaimplementować funkcje wywołania zwrotnego służące do zapewnienia interaktywności widżetów w interfejsie. Jeśli np. dodasz przycisk do interfejsu, powinien on mieć dołączone zdarzenie Action i zaimplementowaną funkcję wywołania zwrotnego, która jest uruchamiana po kliknięciu przycisku.

Obiekty zdarzeń

Tworzony jest obiekt zdarzenia, który jest przekazywany do funkcji drive.homepageTrigger lub drive.onItemsSelectedTrigger po ich wywołaniu. Funkcja aktywująca może wykorzystywać informacje zawarte w tym obiekcie zdarzenia do określania sposobu tworzenia kart dodatków lub kontrolowania działania dodatku.

Pełną strukturę obiektów zdarzeń opisano w sekcji Obiekty zdarzeń. Gdy Dysk jest działającą aplikacją hostującą dodatek, obiekty zdarzeń kontekstowych zawierają pole Obiekt zdarzenia Dysku, które zawiera informacje o kliencie Dysku.

Obiekty zdarzeń Dysku kontekstowego w przypadku reguł wyboru elementu zawierają informacje o elementach wybranych przez użytkownika w momencie uruchomienia reguły. Gdy użytkownik wybierze na Dysku więcej niż jeden element, jeden z nich jest uznawany za główny element, który jest nazywany aktywnym elementem kursora.

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