Dodatki do Google Workspace mogą udostępniać dostosowane interfejsy, gdy użytkownik wyświetla lub edytuje kalendarze i wydarzenia w Kalendarzu. Dzięki temu możesz przekazywać użytkownikowi dodatkowe istotne informacje, automatyzować zadania i łączyć systemy innych firm z Kalendarzem.
Podczas tworzenia interfejsu dodatku do Google Workspace dla Kalendarza możesz podać stronę główną. Możesz używać tej samej strony głównej w przypadku wielu hostów lub zaprojektować specjalną stronę dla Kalendarza.
Dodatek może też definiować interfejs, który pojawia się, gdy użytkownik ma otwarte wydarzenie w Kalendarzu.
Dostęp do interfejsu dodatku
Interfejs użytkownika może wyświetlać się na kilka sposobów w zależności od kontekstu. Na przykład dodatek może zdefiniować interfejs strony głównej, interfejs wydarzenia w Kalendarzu, interfejs wyboru załączników lub wszystkie 3 interfejsy:
- Jeśli użytkownik kliknie ikonę dodatku w widoku kalendarza, dodatek wykona odpowiednią funkcję
calendar.homepageTrigger(jeśli jest dostępna). Ta funkcja tworzy i zwraca kartę strony głównej do wyświetlenia w Kalendarzu. Jeśli nie zdefiniowano funkcjicalendar.homepageTrigger, wyświetli się ogólna karta strony głównej. - Jeśli użytkownik otworzy wydarzenie w Kalendarzu, a następnie kliknie ikonę dodatku lub jeśli dodatek jest otwarty, gdy użytkownik otwiera wydarzenie, dodatek wykona odpowiednią funkcję
eventOpenTrigger(jeśli jest dostępna). Ta funkcja tworzy interfejs wydarzenia w Kalendarzu dodatku i zwraca go do Kalendarza w celu wyświetlenia. - Jeśli dodatek definiuje funkcję
eventAttachmentTrigger, dodatek pojawia się jako dostawca załączników, gdy użytkownik kliknie Dodaj załącznik podczas edytowania wydarzenia w Kalendarzu. Gdy dodatek zostanie wybrany, funkcjaeventAttachmentTriggertworzy interfejs wyboru załączników dodatku i zwraca go do Kalendarza w celu wyświetlenia.
Tworzenie interfejsu dodatku do Kalendarza
Aby utworzyć interfejs, wykonaj te czynności. Aby rozszerzyć funkcje Kalendarza za pomocą dodatku do Google Workspace:
- Zdecyduj, czy chcesz, aby dodatek miał stronę główną przeznaczoną specjalnie dla Kalendarza. Zdecyduj też, czy chcesz udostępniać interfejs niestandardowy, gdy użytkownik edytuje wydarzenia w Kalendarzu.
- Dodaj odpowiednie pola
addOns.commoniaddOns.calendardo projektu skryptu dodatku manifestu, w tym wymagane zakresy. - Jeśli udostępniasz stronę główną Kalendarza, zaimplementuj funkcję
calendar.homepageTrigger, aby utworzyć ten interfejs. Możesz też użyć interfejsucommon.homepageTriggerw przypadku wielu aplikacji hosta. - Jeśli udostępniasz interfejs wydarzenia w Kalendarzu, zaimplementuj funkcję
calendar.eventOpenTriggerdo jego utworzenia. Szczegółowe informacje znajdziesz w artykule Rozszerzanie interfejsu wydarzenia w Kalendarzu. - 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 kalendarzy
dodatki obsługują wyświetlanie stron głównych dodatków do Google Workspace. Aby wyświetlić wspólną stronę główną dodatku w Kalendarzu, upewnij się, że w pliku manifestu dodatku znajduje się pole addOns.calendar.
Możesz też dodać calendar.homepageTrigger do pliku manifestu dodatku, aby udostępnić stronę główną
specyficzną dla Kalendarza.
W obu przypadkach musisz podać nazwę funkcji wywołującej stronę główną w projekcie skryptu dodatku. Ta funkcja jest wywoływana automatycznie w celu utworzenia strony głównej Kalendarza, gdy jest to potrzebne. 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 ogólne informacje, takie jak platforma klienta. Używaj danych obiektu zdarzenia, aby dostosowywać sposób tworzenia strony głównej.
Rozszerzanie interfejsu wydarzenia w Kalendarzu
Kalendarz korzysta z wyzwalacza kontekstowego, aby określić, jaki interfejs (jeśli w ogóle) ma być wyświetlany, gdy użytkownik edytuje wydarzenie w Kalendarzu. Gdy wyzwalacz zostanie uruchomiony, wykona funkcję wyzwalacza kontekstowego określoną w polu calendar.eventOpenTrigger w pliku manifestu dodatku.
Zaimplementuj funkcję o nazwie podanej w polu
calendar.eventOpenTrigger. Ta funkcja przyjmuje jako argument obiekt zdarzenia i musi zwracać pojedynczy obiekt Card lub tablicę obiektów Card, które Kalendarz ma wyświetlać, gdy użytkownik ma otwarte wydarzenie.
Obiekty zdarzeń
Gdy użytkownik otworzy wydarzenie w Kalendarzu, zostanie utworzony obiekt zdarzenia i przekazany do funkcji aktywatora kontekstowego calendar.eventOpenTrigger.
Funkcja wywołująca może używać informacji z tego obiektu zdarzenia, aby określać, jak tworzyć karty dodatku lub kontrolować jego działanie. Obiekty zdarzeń są też tworzone i przekazywane do funkcji homepageTrigger, gdy dodatek jest otwierany po raz pierwszy oraz gdy użytkownik klika lub wybiera interaktywne widżety.
Pełna struktura obiektów zdarzeń jest opisana w sekcji Obiekty zdarzeń. Gdy aplikacją hostującą dodatek jest Kalendarz, obiekty zdarzeń wyzwalacza kontekstowego i interakcji z widżetem zawierają pole obiektu wydarzenia w Kalendarzu, które zawiera informacje o kliencie specyficzne dla Kalendarza.
Aktualizowanie wydarzeń w Kalendarzu
Oprócz reguły kontekstowejcalendar.eventOpenTrigger, która jest wywoływana, gdy użytkownik otwiera wydarzenie w Kalendarzu w celu edycji, możesz też zdefiniować regułęcalendar.eventUpdateTrigger, która jest wywoływana, gdy użytkownik aktualizuje i zapisuje wydarzenie w Kalendarzu.
Ten czynnik uruchamiający jest aktywowany tylko wtedy, gdy użytkownik wprowadzi co najmniej jedną z tych zmian:
- Dodaje co najmniej jednego uczestnika.
- Usuwa co najmniej jednego uczestnika.
- Dodaje inne rozwiązanie do obsługi rozmów wideo lub przełącza się na nie.
Gdy ta reguła zostanie uruchomiona, wykona funkcję reguły określoną w polu manifestu calendar.eventUpdateTrigger. Funkcja jest wykonywana przed zapisaniem zmian w wydarzeniu w Kalendarzu.
Element
calendar.eventUpdateTrigger
jest zwykle używany do co najmniej jednego z tych celów:
- Aktualizowanie interfejsu wydarzenia w Kalendarzu dodatku w odpowiedzi na zmiany wprowadzone przez użytkownika w wydarzeniu w Kalendarzu.
- synchronizować dane wydarzeń w Kalendarzu z systemem innej firmy, np. z systemem do obsługi konferencji połączonym z Kalendarzem.
Jeśli dodatek ma wprowadzać zmiany w danych wydarzenia w Kalendarzu (np. na liście uczestników), ustaw pole manifestu dodatkucalendar.currentEventAccess na WRITE lub READ_WRITE. Wymaga to również, aby dodatek miał https://www.googleapis.com/auth/calendar.addons.current.event.write
zakres.
Dodawanie rozwiązań do obsługi rozmów wideo
Jeśli korzystasz z systemu do obsługi rozmów innej firmy, możesz zintegrować go z Kalendarzem, dodając rozwiązania do obsługi rozmów. Ta funkcja była wcześniej dostępna w wersji beta jako dodatki do rozmów wideo w Kalendarzu.
Rozwiązania do obsługi rozmów wideo to opcje rozmów wideo innych firm, które użytkownicy mogą dodawać do wydarzeń w Kalendarzu. W dokumentacji Omówienie konferencji innych firm znajdziesz szczegółowe informacje o tym, jak utworzyć dodatek, który dodaje nowe rozwiązania do obsługi rozmów wideo. W przypadku tego typu rozszerzenia nie musisz tworzyć interfejsu. Dodane rozwiązania pojawiają się jako opcje w menu interfejsu wydarzenia w kalendarzu.