Script Service

Script

Ta usługa zapewnia dostęp do aktywatorów skryptu i publikowania skryptu.

Zajęcia

Nazwa	Krótki opis
AuthMode	Wyliczenie określające, które kategorie autoryzowanych usług może wykonywać Apps Script za pomocą funkcji wywołanej.
AuthorizationInfo	Obiekt, który sprawdza, czy użytkownik udzielił upoważnienia do wymaganych zakresów skryptu.
AuthorizationStatus	Wyliczenie określające stan autoryzacji skryptu.
CalendarTriggerBuilder	Kreator reguł kalendarza.
ClockTriggerBuilder	Kreator aktywatorów zegarowych.
DocumentTriggerBuilder	Kreator aktywatorów dokumentów.
EventType	Wyliczenie określające typ wywołanego zdarzenia.
FormTriggerBuilder	Narzędzie do tworzenia wyzwalaczy formularzy.
InstallationSource	Wyliczenie wskazujące, w jaki sposób skrypt został zainstalowany jako dodatek dla bieżącego użytkownika.
ScriptApp	Dostęp do publikowania skryptu i jego aktywatorów oraz możliwość ich modyfikowania.
Service	Dostęp do publikowania skryptów i modyfikowanie go.
SpreadsheetTriggerBuilder	Kreator reguł arkuszy kalkulacyjnych.
StateTokenBuilder	Umożliwia skryptom tworzenie tokenów stanu, które można używać w interfejsach wywołania zwrotnego (np. w procesach OAuth).
Trigger	Aktywator skryptu.
TriggerBuilder	Ogólny kreator aktywatorów skryptu.
TriggerSource	Wyliczenie określające źródło zdarzenia, które powoduje uruchomienie reguły.

AuthMode

Właściwości

Właściwość	Typ	Opis
NONE	Enum	Tryb, który nie zezwala na dostęp do żadnych usług wymagających autoryzacji.
CUSTOM_FUNCTION	Enum	Tryb, który umożliwia dostęp do ograniczonego podzbioru usług na potrzeby niestandardowych funkcji arkusza kalkulacyjnego.
LIMITED	Enum	Tryb, który umożliwia dostęp do ograniczonego podzbioru usług.
FULL	Enum	Tryb, który umożliwia dostęp do wszystkich usług wymagających autoryzacji.

AuthorizationInfo

Metody

Metoda	Zwracany typ	Krótki opis
getAuthorizationStatus()	AuthorizationStatus	Pobiera wartość wskazującą, czy użytkownik musi autoryzować ten skrypt do korzystania z co najmniej 1 usługi (na przykład ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()	String	Pobiera adres URL autoryzacji, którego można użyć do przyznania dostępu do skryptu.
getAuthorizedScopes()	String[]	Pobiera listę autoryzowanych zakresów skryptu.

AuthorizationStatus

Właściwości

Właściwość	Typ	Opis
REQUIRED	Enum	Użytkownik musi autoryzować ten skrypt do korzystania z co najmniej jednej usługi.
NOT_REQUIRED	Enum	Użytkownik przyznał temu skryptowi wszystkie wymagane obecnie uprawnienia.

CalendarTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
create()	Trigger	Tworzy i zwraca parametr.
onEventUpdated()	CalendarTriggerBuilder	Określa regułę, która uruchamia tag, gdy wpis w kalendarzu zostanie utworzony, zaktualizowany lub usunięty.

ClockTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
after(durationMilliseconds)	ClockTriggerBuilder	Określa minimalny czas (w milisekundach) po bieżącym czasie, przez jaki ma działać reguła.
at(date)	ClockTriggerBuilder	Określa, kiedy ma być uruchamiany.
atDate(year, month, day)	ClockTriggerBuilder	Określa, że reguła jest uruchamiany w określonym dniu, domyślnie w pobliżu północy (+/- 15 minut).
atHour(hour)	ClockTriggerBuilder	Określa godzinę, o której ma działać.
create()	Trigger	Tworzy aktywator.
everyDays(n)	ClockTriggerBuilder	Określa, że wyzwalacz ma być uruchamiany co n dni.
everyHours(n)	ClockTriggerBuilder	Określa, że ma być uruchamiany co n godzin.
everyMinutes(n)	ClockTriggerBuilder	Określa, że reguła ma być uruchamiana co n minut.
everyWeeks(n)	ClockTriggerBuilder	Określa, że ma on być uruchamiany co n tygodni.
inTimezone(timezone)	ClockTriggerBuilder	Określa strefę czasową dla określonych dat/godzin, w których ma działać reguła.
nearMinute(minute)	ClockTriggerBuilder	Określa minutę, o której ma być uruchamiany (z dokładnością do 15 minut).
onMonthDay(day)	ClockTriggerBuilder	Określa datę w miesiącu, w którym ma być uruchamiany.
onWeekDay(day)	ClockTriggerBuilder	Określa dzień tygodnia, w którym ma być wykonywany.

DocumentTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
create()	Trigger	Tworzy i zwraca nową regułę.
onOpen()	DocumentTriggerBuilder	Określa regułę, która zostanie uruchomiona po otwarciu dokumentu.

EventType

Właściwości

Właściwość	Typ	Opis
CLOCK	Enum	Wyzwalacz uruchamia się, gdy zdarzenie czasowe osiągnie określony czas.
ON_OPEN	Enum	Reguła jest uruchamiany, gdy użytkownik otworzy plik Dokumentów, Arkuszy lub Formularzy Google.
ON_EDIT	Enum	Wyzwalacz uruchamia się, gdy użytkownik zmodyfikuje plik Arkuszy Google (np. wpisując nową wartość w komórce, co jest traktowane jako zmiana, a nie edycja).
ON_FORM_SUBMIT	Enum	Wyzwalacz jest uruchamiany, gdy użytkownik odpowie na formularz Google.
ON_CHANGE	Enum	Reguła jest wywoływana, gdy użytkownik zmieni plik Arkuszy Google (np. dodając wiersz, który jest traktowany jako zmiana, a nie jako edycja).
ON_EVENT_UPDATED	Enum	Aktywator jest uruchamiany, gdy w określonym Kalendarzu Google zostanie utworzone, zaktualizowane lub usunięte wydarzenie.

FormTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
create()	Trigger	Tworzy i zwraca nową regułę.
onFormSubmit()	FormTriggerBuilder	Określa regułę, która zostanie uruchomiona, gdy do formularza zostanie przesłana odpowiedź.
onOpen()	FormTriggerBuilder	Określa regułę, która zostanie uruchomiona po otwarciu widoku edycji formularza.

InstallationSource

Właściwości

Właściwość	Typ	Opis
APPS_MARKETPLACE_DOMAIN_ADD_ON	Enum	Dodatek został zainstalowany przez administratora w domenie użytkownika.
NONE	Enum	Skrypt nie jest uruchamiany jako dodatek.
WEB_STORE_ADD_ON	Enum	Użytkownik zainstalował dodatek ze sklepu Chrome Web Store.

ScriptApp

Właściwości

Właściwość	Typ	Opis
AuthMode	AuthMode	Wyliczenie określające, które kategorie autoryzowanych usług może wykonywać Apps Script za pomocą funkcji wywołanej.
AuthorizationStatus	AuthorizationStatus	Wyliczenie określające stan autoryzacji skryptu.
EventType	EventType	Wyliczenie określające typ wywołanego zdarzenia.
InstallationSource	InstallationSource	Wyliczenie określające, jak skrypt został zainstalowany u użytkownika jako dodatek.
TriggerSource	TriggerSource	Wyliczenie określające źródło zdarzenia, które powoduje uruchomienie reguły.
WeekDay	Weekday	Wyliczenie reprezentujące dni tygodnia.

Metody

Metoda	Zwracany typ	Krótki opis
deleteTrigger(trigger)	void	Usuwa dany regułę, aby nie była już wykonywana.
getAuthorizationInfo(authMode)	AuthorizationInfo	Pobiera obiekt, który sprawdza, czy użytkownik udzielił uprawnień do wszystkich wymagań skryptu.
getAuthorizationInfo(authMode, oAuthScopes)	AuthorizationInfo	Pobiera obiekt, który sprawdza, czy użytkownik udzielił autoryzacji dla żądanych zakresów.
getIdentityToken()	String	Pobiera token tożsamości OpenID Connect dla skutecznego użytkownika, jeśli zakres openid został przyznany.
getInstallationSource()	InstallationSource	Zwraca wartość typu enum, która wskazuje, jak skrypt został zainstalowany jako dodatek dla bieżącego użytkownika (np. czy użytkownik zainstalował go osobiście w Chrome Web Store czy też administrator domeny zainstalował go dla wszystkich użytkowników).
getOAuthToken()	String	Pobiera token dostępu OAuth 2.0 dla skutecznego użytkownika.
getProjectTriggers()	Trigger[]	Pobiera wszystkie instalowalne wyzwalacze powiązane z bieżącym projektem i bieżącym użytkownikiem.
getScriptId()	String	Pobiera unikalny identyfikator projektu skryptu.
getService()	Service	Pobiera obiekt służący do kontrolowania publikowania skryptu jako aplikacji internetowej.
getUserTriggers(document)	Trigger[]	Pobiera wszystkie wyzwalacze, które można zainstalować, należące do tego użytkownika w danym dokumencie, tylko w przypadku tego skryptu lub tego dodatku.
getUserTriggers(form)	Trigger[]	Pobiera wszystkie wyzwalacze, które można zainstalować, należące do tego użytkownika w danym formularzu, tylko w przypadku tego skryptu lub dodatku.
getUserTriggers(spreadsheet)	Trigger[]	Pobiera wszystkie wyzwalacze, które można zainstalować, należące do tego użytkownika w danym arkuszu kalkulacyjnym, tylko w przypadku tego skryptu lub dodatku.
invalidateAuth()	void	unieważnia autoryzację, którą użytkownik ma do wykonania bieżącego skryptu;
newStateToken()	StateTokenBuilder	Tworzy kreator tokenu stanu, który można używać w interfejsie wywołania zwrotnego (np. w procesie OAuth).
newTrigger(functionName)	TriggerBuilder	Rozpoczyna proces tworzenia instalowanego aktywatora, który po uruchomieniu wywołuje określoną funkcję.
requireAllScopes(authMode)	void	Sprawdzanie, czy użytkownik wyraził zgodę na wszystkie zakresy wymagane przez skrypt.
requireScopes(authMode, oAuthScopes)	void	Sprawdzanie, czy użytkownik wyraził zgodę na wymagane zakresy.

Service

Metody

Metoda	Zwracany typ	Krótki opis
getUrl()	String	Zwraca adres URL aplikacji internetowej, jeśli została ona wdrożona, w przeciwnym razie zwraca wartość null.
isEnabled()	Boolean	Zwraca wartość true, jeśli skrypt jest dostępny jako aplikacja internetowa.

SpreadsheetTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
create()	Trigger	Tworzy i zwraca parametr.
onChange()	SpreadsheetTriggerBuilder	Określa regułę, która zostanie uruchomiona, gdy zmieni się zawartość lub struktura arkusza kalkulacyjnego.
onEdit()	SpreadsheetTriggerBuilder	Określa regułę, która zostanie uruchomiona, gdy arkusz kalkulacyjny zostanie zmodyfikowany.
onFormSubmit()	SpreadsheetTriggerBuilder	Określa regułę, która zostanie uruchomiona, gdy w arkuszu zostanie przesłany formularz.
onOpen()	SpreadsheetTriggerBuilder	Określa regułę, która zostanie uruchomiona po otwarciu arkusza kalkulacyjnego.

StateTokenBuilder

Metody

Metoda	Zwracany typ	Krótki opis
createToken()	String	Tworzy zaszyfrowany ciąg znaków reprezentujący token stanu.
withArgument(name, value)	StateTokenBuilder	Dodaje argument do tokena.
withMethod(method)	StateTokenBuilder	Ustawia funkcję wywołania zwrotnego.
withTimeout(seconds)	StateTokenBuilder	Ustawia czas (w sekundach), przez jaki token jest ważny.

Trigger

Metody

Metoda	Zwracany typ	Krótki opis
getEventType()	EventType	Zwraca typ zdarzenia, które uruchamia regułę.
getHandlerFunction()	String	Zwraca funkcję, która zostanie wywołana po zadziałaniu czynnika uruchamiającego.
getTriggerSource()	TriggerSource	Zwraca źródło zdarzeń, które uruchamiają regułę.
getTriggerSourceId()	String	Zwraca identyfikator źródła.
getUniqueId()	String	Zwraca unikalny identyfikator, który umożliwia odróżnianie od siebie poszczególnych wyzwalaczy.

TriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
forDocument(document)	DocumentTriggerBuilder	Tworzy i zwraca obiekt DocumentTriggerBuilder powiązany z danym dokumentem.
forDocument(key)	DocumentTriggerBuilder	Tworzy i zwraca obiekt DocumentTriggerBuilder powiązany z dokumentem o podanym identyfikatorze.
forForm(form)	FormTriggerBuilder	Tworzy i zwraca FormTriggerBuilder powiązany z danym formularzem.
forForm(key)	FormTriggerBuilder	Tworzy i zwraca obiekt FormTriggerBuilder powiązany z formularzem o podanym identyfikatorze.
forSpreadsheet(sheet)	SpreadsheetTriggerBuilder	Tworzy i zwraca element SpreadsheetTriggerBuilder powiązany z danym arkuszem kalkulacyjnym.
forSpreadsheet(key)	SpreadsheetTriggerBuilder	Tworzy i zwraca obiekt SpreadsheetTriggerBuilder powiązany z arkuszem kalkulacyjnym o podanym identyfikatorze.
forUserCalendar(emailId)	CalendarTriggerBuilder	Zwraca kreator do tworzenia wyzwalaczy kalendarza.
timeBased()	ClockTriggerBuilder	Tworzy i zwraca obiekt ClockTriggerBuilder do tworzenia aktywatorów opartych na czasie.

TriggerSource

Właściwości

Właściwość	Typ	Opis
SPREADSHEETS	Enum	Arkusze Google uruchamiają regułę.
CLOCK	Enum	Reguła jest uruchamiana przez zdarzenie czasowe.
FORMS	Enum	Formularz Google powoduje uruchomienie reguły.
DOCUMENTS	Enum	Dokumenty Google uruchamiają regułę.
CALENDAR	Enum	Kalendarz Google powoduje uruchomienie reguły.