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óły dotyczące zdarzenia, które miało miejsce. 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 za pomocą danych przekazanych w obiekcie zdarzenia.

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

Aktywatory manifestu

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

Wywoływacze manifestu są w całości zdefiniowane w manifeście dodatku do Google Workspace. Przykłady wywołań w pliku manifestu:

  • Triggery strony głównej, które tworzą i wyświetlają stronę główną dodatku.
  • Otwórz wyzwalacze wydarzenia w Kalendarzu, które wyświetlają nową kartę lub wykonują inne działania po otwarciu wydarzenia w Kalendarzu.
  • Aktualizacje wydarzeń w Kalendarzu, które wyświetlają nową kartę lub podejmują inne działania, gdy użytkownik edytuje i zapisuje wydarzenie w Kalendarzu.
  • Wyzwalacze Drive onItemsSelected, które wyświetlają nową kartę lub wykonują inne działania, gdy użytkownik wybierze co najmniej 1 plik lub folder na Dysku.
  • Triggery tworzenia wiadomości w Gmailu, które wyświetlają kartę dodatku, gdy użytkownik otworzy dodatek w oknie tworzenia wiadomości w Gmailu.
  • Kontekstowe wyzwalacze Gmaila, które wyświetlają nową kartę lub wykonują inne działania, gdy użytkownik otworzy wiadomość w Gmailu.
  • Wywoływanie funkcji Editor onFileScopeGranted, które wyświetlają nową kartę, gdy użytkownicy przyznają uprawnienia do zakresu drive.file OAuth w bieżącym dokumencie Edytora.

Na powyższej liście tylko wyzwalacze strony głównej są niekontekstowe, a pozostałe są wyzwalaczami kontekstowymi. Więcej informacji o definicjach reguł w pliku manifestu znajdziesz w sekcji Manifest.

Oprócz reguł w pliku manifestu dodatki do Google Workspace mogą też używać reguł 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. Nie mają zastosowania w żadnej innej aplikacji.
  • Są one zdefiniowane w pliku manifestu dodatku, a nie w jego kodzie, więc nie możesz używać usługi Script Apps Script do tworzenia ani modyfikowania tych wyzwalaczy.
  • Kontekstowe wyzwalacze Gmaila mogą obecnie mieć tylko kryterium unconditional. Oznacza to, że wyzwalacze kontekstowe są aktywowane w przypadku każdego e-maila, niezależnie od jego treści.
  • Każdy dodatek może mieć tylko 1 wyzwalacz danego typu na użytkownika i dokument.