Wyzwalacze dla dodatków do Google Workspace

Aktywatory Apps Script powodują, że określona funkcja skryptu (funkcja aktywatora) jest wykonywana za każdym razem, gdy wystąpi określone zdarzenie. Tylko niektóre zdarzenia mogą powodować uruchamianie wyzwalaczy, a każda aplikacja Google Workspace obsługuje inny zestaw zdarzeń.

Gdy reguła zostanie uruchomiona, tworzony jest obiekt zdarzenia. Ta struktura JSON zawiera szczegółowe informacje o zdarzeniu, które wystąpiło. Informacje w strukturze obiektu zdarzenia są uporządkowane w różny sposób w zależności od typu wywołania.

Po utworzeniu obiektu zdarzenia Apps Script przekazuje go jako parametr do funkcji wywołującej. Funkcja wyzwalająca to funkcja wywołania zwrotnego, którą musisz zaimplementować samodzielnie, aby podjąć odpowiednie działania w odpowiedzi na zdarzenie. Na przykład w dodatku do Google Workspace, który rozszerza Gmaila, możesz zdefiniować wyzwalacz, który tworzy nowy interfejs karty, gdy użytkownik otworzy wątek wiadomości. W tym przypadku implementujesz funkcję wywołania zwrotnego kontekstowego, aby utworzyć karty składające się na nowy interfejs, korzystając z danych przekazanych w obiekcie zdarzenia.

Na tej stronie znajdziesz wytyczne dotyczące używania wyzwalaczy w projektach dodatków do Google Workspace.

Reguły uruchamiające manifest

W przeciwieństwie do dodatków edytora dodatki do Google Workspace nie mogą używać prostych wyzwalaczy Google Apps Script. Zamiast tego używają wyzwalaczy zaprojektowanych specjalnie dla dodatków do Google Workspace: wyzwalaczy manifestu.

Wywoływacze manifestu są zdefiniowane w manifeście dodatku do Google Workspace. Przykłady:

  • Wywołania strony głównej, które tworzą i wyświetlają stronę główną dodatku.
  • Otwórz wyzwalacze wydarzenia w Kalendarzu Google, które wyświetlają nową kartę lub wykonują inne działania po otwarciu wydarzenia.
  • Aktualizacje wydarzeń w Kalendarzu, które wyświetlają nową kartę lub podejmują inne działania, gdy użytkownik edytuje i zapisuje wydarzenie.
  • Wywoływanie funkcji Google Drive onItemsSelected, które wyświetlają nową kartę lub wykonują inne działania, gdy użytkownik wybierze pliki lub foldery.
  • Wywoływacze tworzenia wiadomości w Gmailu, które wyświetlają kartę dodatku, gdy użytkownik otworzy dodatek w oknie tworzenia wiadomości.
  • Kontekstowe wyzwalacze Gmaila, które wyświetlają nową kartę lub podejmują inne działania, gdy użytkownik otworzy wiadomość.
  • Edytor wywołuje funkcje onFileScopeGranted, które wyświetlają nową kartę, gdy użytkownicy przyznają autoryzację dla drive.file zakresu OAuth w dokumencie.

Na liście tylko reguły dotyczące strony głównej są niekontekstowe, a pozostałe są kontekstowe. Więcej informacji o definicjach reguł manifestu znajdziesz w sekcji Manifest.

Oprócz wywołań z pliku manifestu dodatki do Google Workspace mogą używać wywołań instalowanych Apps Script.

Ograniczenia

Wywoływanie z pliku manifestu podlega pewnym ograniczeniom.

  • Te wyzwalacze są używane tylko w projektach dodatków do Google Workspace.
  • Są one zdefiniowane w pliku manifestu dodatku, a nie w kodzie, więc nie możesz ich tworzyć ani modyfikować za pomocą usługi Apps Script Script.
  • Wywołania kontekstowe Gmaila są aktywowane w przypadku każdej wiadomości e-mail, niezależnie od jej treści.
  • Każdy dodatek może mieć tylko 1 wyzwalacz danego typu na użytkownika i dokument.