Tworzenie interfejsów Kalendarza Google

Google Workspace Dodatki mogą dostarczać dostosowane interfejsy, gdy użytkownik wyświetla lub edytuje kalendarze i wydarzenia w Kalendarzu. Dzięki temu uzyskasz dodatkowe informacje, zautomatyzujesz zadania i połączysz systemy innych firm z Kalendarzem Google.

Podczas tworzenia interfejsu dodatku do Kalendarza Google możesz podać stronę główną. Możesz użyć tej samej strony głównej dla wielu hostów lub projektować konkretną Kalendarz Google.

Dodatek może też zdefiniować interfejs wyświetlany po otwarciu wydarzenia w Kalendarzu.

Dostęp do interfejsu dodatku

W zależności od sposobu otwarcia dodatek Google Workspace może zdefiniować interfejs strony głównej, interfejs Kalendarza, interfejs wyboru załączników lub wszystkie te 3 elementy:

  • Jeśli użytkownik kliknie ikonę dodatku w widoku kalendarza, usługa uruchomi odpowiednią funkcję calendar.homepageTrigger (jeśli istnieje). Ta funkcja tworzy i zwraca kartę strony głównej w Kalendarzu Google, aby ją wyświetlić. Jeśli nie zdefiniowano funkcji calendar.homepageTrigger, wyświetla się ogólna karta strony głównej.
  • Jeśli użytkownik otworzy wydarzenie w Kalendarzu, a następnie kliknie ikonę dodatku lub gdy dodatek zostanie otwarty, gdy użytkownik otworzy wydarzenie, dodatek wykonuje funkcję eventOpenTrigger (jeśli istnieje). Ta funkcja tworzy interfejs wydarzenia w Kalendarzu dodatku i wraca do Kalendarza Google, aby go wyświetlić.
  • Jeśli dodatek definiuje funkcję eventAttachmentTrigger, jest on wyświetlany jako dostawca załącznika, gdy użytkownik kliknie Dodaj załącznik podczas edytowania wydarzenia w Kalendarzu. Gdy wybierzesz dodatek, funkcja eventAttachmentTrigger skompiluje interfejs wyboru dodatku i zwróci go do Kalendarza Google w celu wyświetlenia.

Tworzenie interfejsu Kalendarza w dodatku

Kalendarz możesz rozszerzyć za pomocą dodatku Google Workspace , wykonując te czynności:

  1. Określ, czy dodatek ma mieć stronę główną Kalendarza. Zdecyduj też, czy chcesz udostępnić interfejs niestandardowy podczas edycji wydarzeń w Kalendarzu.
  2. Dodaj odpowiednie pola addOns.common i addOns.calendar do pliku manifestu dodatkowego skryptu, w tym wszelkich wymaganych zakresów.
  3. Jeśli udostępniasz stronę główną w Kalendarzu, zaimplementuj funkcję calendar.homepageTrigger, aby utworzyć ten interfejs. Możesz też użyć interfejsu common.homepageTrigger na potrzeby wielu Google Workspace hostów.
  4. Jeśli udostępniasz interfejs wydarzenia w kalendarzu, musisz zaimplementować funkcję calendar.eventOpenTrigger, by utworzyć ten interfejs. Szczegółowe informacje znajdziesz w artykule Przedłużanie interfejsu wydarzenia w Kalendarzu.
  5. Zaimplementuj powiązane funkcje wywołania zwrotnego niezbędne do reakcji na interakcje z interfejsem użytkownika, takie jak kliknięcia przycisków.

Strony główne kalendarza

Kalendarz Google obsługuje Google Workspace strony główne dodatków. Aby pokazać wspólną stronę główną dodatku w Kalendarzu Google, po prostu upewnij się, że w pliku manifestu dodatku znajduje się pole addOns.calendar.

Możesz też dodać do pliku manifestu dodatku calendar.homepageTrigger, aby udostępnić stronę główną powiązaną z Kalendarzem.

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

Rozszerzenie interfejsu wydarzenia w Kalendarzu

Kalendarz Google używa kontekstowego kontekstu do określenia, który interfejs (jeśli istnieje) wyświetla się, gdy użytkownik edytuje wydarzenie w Kalendarzu. Po wywołaniu funkcja uruchamia kontekstową funkcję aktywatora określoną w polu calendar.eventOpenTrigger w pliku manifestu dodatku.

Musisz zaimplementować funkcję nazwaną w polu calendar.eventOpenTrigger. Ta funkcja akceptuje argument zdarzenia jako argument i musi zwracać pojedynczy obiekt Card lub tablicę obiektów Card, aby Kalendarz był wyświetlany, gdy użytkownik ma otwarte wydarzenie.

Obiekty zdarzenia

Obiekt zdarzenia jest tworzony i przekazywany do funkcji aktywatora kontekstu calendar.eventOpenTrigger, gdy użytkownik otwiera wydarzenie w Kalendarzu. Funkcja aktywatora może użyć informacji z tego obiektu zdarzenia, aby określić sposób tworzenia kart dodatkowych lub kontrolować jego działanie. Obiekty zdarzeń są też tworzone i przekazywane do funkcji homepageTrigger po pierwszym uruchomieniu dodatku oraz po kliknięciu lub wybraniu interaktywnych widżetów.

Pełną strukturę obiektów zdarzeń znajdziesz w sekcji Obiekty zdarzeń. Gdy Kalendarz jest aplikacją hostującą dodatek, obiekty kontekstowe uruchamiające aktywator i widżet interakcji obejmują pole Obiekt wydarzenia w Kalendarzu, który zawiera informacje o kliencie związane z Kalendarzem.

Aktualizowanie wydarzeń w Kalendarzu

Oprócz kontekstu kontekstowego calendar.eventOpenTrigger, który uruchamia się, gdy użytkownik otwiera wydarzenie w Kalendarzu do edytowania, możesz też zdefiniować metodę calendar.eventUpdateTrigger, która będzie się uruchamiać, gdy użytkownik zaktualizuje i zapisze wydarzenie w Kalendarzu. Uruchamia się tylko wtedy, gdy użytkownik wprowadzi co najmniej jedną z tych zmian:

  • Dodaje co najmniej jednego uczestnika.
  • Usuwa co najmniej jednego uczestnika.
  • Dodaje lub przełącza się na inne rozwiązanie do prowadzenia rozmów wideo.

Po uruchomieniu aktywator wykonuje funkcję określoną w polu manifestu calendar.eventUpdateTrigger. Funkcja jest wykonywana przed zapisaniem zmiany z Kalendarza.

calendar.eventUpdateTrigger służy zwykle do wykonywania co najmniej 1 z tych czynności:

  • Aktualizowanie interfejsu wydarzenia w Kalendarzu w reakcji na zmiany wprowadzone w Kalendarzu przez użytkownika.
  • synchronizować dane wydarzeń z Kalendarza z systemem innej firmy, na przykład z systemem do obsługi rozmów wideo, który jest połączony z Kalendarzem Google;

Jeśli chcesz, aby dodatek wprowadzał zmiany w wydarzeniach w Kalendarzu (np. na liście uczestników), musisz ustawić w polu pliku manifestu calendar.currentEventAccess wartość WRITE lub READ_WRITE. Aby ten dodatek był dostępny, dodatek musi mieć https://www.googleapis.com/auth/calendar.addons.current.event.writezakres.

Dodawanie rozwiązań konferencyjnych

Rozwiązania konferencyjne to opcje rozmów wideo innych firm, które użytkownicy mogą dołączać do wydarzeń w Kalendarzu Google. Dokumentacja zewnętrznego rozwiązania do obsługi rozmów wideo zawiera szczegółowe informacje o tym, jak utworzyć dodatek dodający nowe rozwiązania do rozmów wideo. Nie trzeba tworzyć interfejsu tego typu, ponieważ dodane rozwiązania pojawiają się po prostu w menu interfejsu Kalendarza Google.