Obiekty zdarzeń

Proste aktywatory i aktywatory z możliwością zainstalowania umożliwiają Apps Script automatyczne uruchamianie funkcji po wystąpieniu określonego zdarzenia. Gdy aktywator zostanie uruchomiony, Apps Script przekazuje do funkcji obiekt zdarzenia jako argument, zwykle o nazwie e. Obiekt zdarzenia zawiera informacje o kontekście, który spowodował wywołanie wyzwalacza. Na przykład poniższy przykładowy kod pokazuje prosty onEdit(e)wyzwalacz skryptu Arkuszy Google, który używa obiektu zdarzenia do określenia, która komórka została zmodyfikowana.

function onEdit(e){
  // Set a comment on the edited cell to indicate when it was changed.
  var range = e.range;
  range.setNote('Last modified: ' + new Date());
}

Na tej stronie znajdziesz szczegółowe informacje o polach w obiekcie zdarzenia dla różnych typów reguł.

Zdarzenia wywoływane przez aktywatory z możliwością zainstalowania zawierają symboltriggerUid, który identyfikuje aktywator, który wywołał zdarzenie. Jest to przydatne w przypadku skryptów, które mają wiele reguł instalowanych.

Zdarzenia Arkuszy Google

Różne wyzwalacze specyficzne dla Arkuszy Google umożliwiają skryptom reagowanie na działania użytkownika w arkuszu kalkulacyjnym.

Otwórz (proste i możliwe do zainstalowania)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. LIMITED
source	Obiekt Spreadsheet, który reprezentuje plik Arkuszy Google, z którym jest powiązany skrypt. Spreadsheet
triggerUid	Identyfikator reguły, która wywołała to zdarzenie (tylko reguły, które można zainstalować). 4034124084959907503
user	Obiekt User reprezentujący aktywnego użytkownika, jeśli jest dostępny (w zależności od złożonego zestawu ograniczeń bezpieczeństwa). [e-mail]

Zmień (z możliwością zainstalowania)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. FULL
changeType	Rodzaj zmiany (EDIT, INSERT_ROW, INSERT_COLUMN, REMOVE_ROW, REMOVE_COLUMN, INSERT_GRID, REMOVE_GRID, FORMAT lub OTHER). INSERT_ROW
source	Spreadsheet obiekt reprezentujący plik Arkuszy Google, z którym jest powiązany skrypt. Spreadsheet
triggerUid	Identyfikator reguły, która wywołała to zdarzenie. 4034124084959907503
user	Obiekt User reprezentujący aktywnego użytkownika, jeśli jest dostępny (w zależności od złożonego zestawu ograniczeń bezpieczeństwa). [e-mail]

Edytuj (proste i możliwe do zainstalowania)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. LIMITED
oldValue	Wartość komórki przed edycją (jeśli taka istnieje). Dostępne tylko wtedy, gdy edytowany zakres to pojedyncza komórka. Wartość będzie nieokreślona, jeśli komórka nie zawierała wcześniej żadnych treści. 1234
range	Obiekt Range reprezentujący edytowaną komórkę lub zakres komórek. Range
source	Obiekt Spreadsheet, który reprezentuje plik Arkuszy Google, z którym jest powiązany skrypt. Spreadsheet
triggerUid	Identyfikator reguły, która wywołała to zdarzenie (tylko reguły, które można zainstalować). 4034124084959907503
user	Obiekt User reprezentujący aktywnego użytkownika, jeśli jest dostępny (w zależności od złożonego zestawu ograniczeń bezpieczeństwa). [e-mail]
value	Nowa wartość komórki po edycji. Dostępne tylko wtedy, gdy edytowany zakres to pojedyncza komórka. 10

Przesłanie formularza (z możliwością zainstalowania)
Uwaga: używaj tej reguły przesyłania formularza z SpreadsheetTriggerBuilder.
authMode	Wartość z wyliczenia ScriptApp.AuthMode. FULL
namedValues	Obiekt zawierający nazwy pytań i wartości z przesłanego formularza. { 'First Name': ['Jane'], 'Timestamp': ['6/7/2015 20:54:13'], 'Last Name': ['Doe'] }
range	Obiekt Range reprezentujący edytowaną komórkę lub zakres komórek. Range
triggerUid	Identyfikator reguły, która wywołała to zdarzenie. 4034124084959907503
values	Tablica z wartościami w kolejności, w jakiej występują w arkuszu kalkulacyjnym. ['2015/05/04 15:00', '[e-mail]', 'Bob', '27', 'Bill', '28', 'Susan', '25']

Zdarzenia w Dokumentach Google

Wywoływacze umożliwiają Dokumentom Google reagowanie, gdy użytkownik otwiera dokument.

Otwórz (proste i możliwe do zainstalowania)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. LIMITED
source	Obiekt Document reprezentujący plik Dokumentów Google, z którym jest powiązany skrypt. Document
triggerUid	Identyfikator reguły, która wywołała to zdarzenie (tylko reguły, które można zainstalować). 4034124084959907503
user	Obiekt User reprezentujący aktywnego użytkownika, jeśli jest dostępny (w zależności od złożonego zestawu ograniczeń bezpieczeństwa). [e-mail]

Zdarzenia w Prezentacjach Google

Reguły umożliwiają Prezentacjom Google reagowanie, gdy użytkownik otwiera prezentację.

Otwórz (prosty)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. LIMITED
source	Obiekt Presentation reprezentujący plik Prezentacji Google, z którym jest powiązany skrypt. Presentation
user	Obiekt User reprezentujący aktywnego użytkownika, jeśli jest dostępny (w zależności od złożonego zestawu ograniczeń bezpieczeństwa). [e-mail]

Zdarzenia Formularzy Google

Wywoływacze specyficzne dla Formularzy Google umożliwiają skryptom reagowanie na zmiany w formularzu lub przesłanie odpowiedzi przez użytkownika.

Otwórz * (prosty i możliwy do zainstalowania)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. LIMITED
source	Obiekt Form reprezentujący plik Formularzy Google, z którym jest powiązany skrypt. Form
triggerUid	Identyfikator reguły, która wywołała to zdarzenie (tylko reguły, które można zainstalować). 4034124084959907503
user	Obiekt User reprezentujący aktywnego użytkownika, jeśli jest dostępny (w zależności od złożonego zestawu ograniczeń bezpieczeństwa). [e-mail]

* To zdarzenie nie występuje, gdy użytkownik otwiera formularz, aby na niego odpowiedzieć, ale gdy edytujący otwiera formularz, aby go zmodyfikować.

Przesłanie formularza (z możliwością zainstalowania)
Uwaga: używaj tej reguły przesyłania formularza z FormTriggerBuilder.
authMode	Wartość z wyliczenia ScriptApp.AuthMode. FULL
response	Obiekt FormResponse reprezentujący odpowiedź użytkownika na formularz jako całość. FormResponse
source	Obiekt Form reprezentujący plik Formularzy Google, z którym jest powiązany skrypt. Form
triggerUid	Identyfikator reguły, która wywołała to zdarzenie. 4034124084959907503

wydarzeniach w Kalendarzu Google;

Triggery Kalendarza są uruchamiane, gdy wydarzenia w kalendarzu użytkownika zostaną zaktualizowane (utworzone, edytowane lub usunięte).

Te wyzwalacze nie informują, które zdarzenie uległo zmianie ani w jaki sposób. Oznacza to, że kod musi wykonać przyrostową operację synchronizacji, aby uwzględnić ostatnie zmiany w kalendarzu. Pełny opis tej procedury znajdziesz w przewodniku po synchronizowaniu zasobów w interfejsie Calendar API.

Aby zsynchronizować Kalendarz w Apps Script, wykonaj te czynności:

1. Włącz usługę zaawansowaną Kalendarza w projekcie skryptu. Wbudowana usługa Kalendarz nie jest wystarczająca w tym przypadku.
2. Określ, które kalendarze mają być synchronizowane. W przypadku każdego takiego kalendarza wykonaj początkową synchronizację za pomocą metody Events.list() usługi zaawansowanej Kalendarza.
3. Wynik pierwszej synchronizacji zwraca symbol nextSyncToken dla tego kalendarza. Zapisz ten token do późniejszego użycia.
4. Gdy uruchomi się wyzwalacz Apps Script EventUpdated wskazujący zmianę wydarzenia w kalendarzu, wykonaj synchronizację przyrostową w przypadku kalendarza, którego dotyczy zmiana, używając zapisanego nextSyncToken. Jest to w zasadzie kolejne żądanie Events.list() z parametrem nextSyncToken, który ogranicza odpowiedź tylko do zdarzeń, które uległy zmianie od czasu ostatniej synchronizacji.
5. Sprawdź odpowiedź synchronizacji, aby dowiedzieć się, które zdarzenia zostały zaktualizowane, i odpowiednio zareagować w kodzie. Możesz na przykład zarejestrować zmianę, zaktualizować arkusz kalkulacyjny, wysłać powiadomienia e-mail lub wykonać inne działania.
6. Zaktualizuj nextSyncToken zapisany dla tego kalendarza, używając wartości zwróconej przez żądanie synchronizacji przyrostowej. Wymusza to, aby następna operacja synchronizacji zwracała tylko najnowsze zmiany.

Uwaga: czasami serwer unieważnia tokeny synchronizacji, co powoduje błąd 410. W takim przypadku kod powinien przeprowadzić pełną synchronizację i zastąpić wszystkie przechowywane zsynchronizowane dane i tokeny dotyczące tego kalendarza.

EventUpdated (z możliwością zainstalowania)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. FULL
calendarId	Identyfikator tekstowy kalendarza, w którym nastąpiła aktualizacja wydarzenia. [e-mail]
triggerUid	Identyfikator reguły, która wywołała to zdarzenie. 4034124084959907503

Zdarzenia dodatków do Google Workspace

onInstall()Wywoływacz uruchamia się automatycznie, gdy użytkownik zainstaluje dodatek.

Zainstaluj (prosty)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. FULL

Zdarzenia w aplikacji Google Chat

Więcej informacji o obiektach zdarzeń w Google Chat znajdziesz w artykule Otrzymywanie odpowiedzi na interakcje z aplikacją Google Chat.

Wydarzenia oparte na czasie

Reguły oparte na czasie (nazywane też regułami zegarowymi) umożliwiają wykonywanie skryptów o określonej godzinie lub w regularnych odstępach czasu.

Uruchamiane o określonej godzinie (możliwe do zainstalowania)
authMode	Wartość z wyliczenia ScriptApp.AuthMode. FULL
day-of-month	Od 1 do 31. Ponieważ nazwa tej właściwości zawiera łączniki, należy uzyskiwać do niej dostęp za pomocą notacji e['day-of-month'], a nie notacji z kropką. 31
day-of-week	Od 1 (poniedziałek) do 7 (niedziela). Ponieważ nazwa tej właściwości zawiera łączniki, należy uzyskiwać do niej dostęp za pomocą notacji e['day-of-week'], a nie notacji z kropką. 7
hour	Od 0 do 23. 23
minute	Od 0 do 59. 59
month	Od 1 do 12. 12
second	Od 0 do 59. 59
timezone	Strefa czasowa. UTC
triggerUid	Identyfikator reguły, która wywołała to zdarzenie. 4034124084959907503
week-of-year	Od 1 do 52. Ponieważ nazwa tej właściwości zawiera łączniki, należy uzyskiwać do niej dostęp za pomocą notacji e['week-of-year'], a nie notacji z kropką. 52
year	Rok. 2015