Script Service

Script

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

Zajęcia

Nazwa	Krótki opis
AuthMode	Wyliczenie określające kategorie autoryzowanych usług, które Apps Script może wykonywać za pomocą aktywowanej funkcji.
AuthorizationInfo	Obiekt używany do określania, czy użytkownik musi autoryzować ten skrypt, aby korzystał z co najmniej 1 usługi, oraz podać adres URL okna autoryzacji.
AuthorizationStatus	Wyliczenie określające stan autoryzacji skryptu.
CalendarTriggerBuilder	Kreator reguł kalendarza.
ClockTriggerBuilder	Kreator wyzwalaczy zegara.
DocumentTriggerBuilder	Kreator aktywatorów dokumentów.
EventType	Wyliczenie określające typ wywołanego zdarzenia.
FormTriggerBuilder	Kreator aktywatorów formularzy.
InstallationSource	Wyliczenie wskazujące, jak skrypt został zainstalowany jako dodatek dla bieżącego użytkownika.
ScriptApp	Dostęp do publikowania skryptów i aktywatorów oraz manipulowanie nimi.
Service	Dostęp do publikowania skryptów i manipulowanie nim.
SpreadsheetTriggerBuilder	Kreator reguł w arkuszu kalkulacyjnym.
StateTokenBuilder	Zezwala skryptom na tworzenie tokenów stanu, które mogą być używane w interfejsach API wywołań zwrotnych (np. w przepływach OAuth).
Trigger	Wyzwalacz skryptu.
TriggerBuilder	Ogólny kreator aktywatorów skryptów.
TriggerSource	Wyliczenie wskazują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 ograniczonej liczby usług na potrzeby niestandardowych funkcji arkusza kalkulacyjnego.
LIMITED	Enum	Tryb, który umożliwia dostęp do ograniczonej liczby 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, aby korzystać z co najmniej 1 usługi (np. ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()	String	Pobiera URL autoryzacji, za pomocą którego można przyznać dostęp do skryptu.

AuthorizationStatus

Właściwości

Właściwość	Typ	Opis
REQUIRED	Enum	Użytkownik musi autoryzować ten skrypt, aby mógł korzystać z co najmniej 1 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 regułę i zwraca ją.
onEventUpdated()	CalendarTriggerBuilder	Określa wyzwalacz uruchamiany po utworzeniu, zaktualizowaniu lub usunięciu wpisu w kalendarzu.

ClockTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
after(durationMilliseconds)	ClockTriggerBuilder	Określa minimalny czas trwania (w milisekundach) po bieżącym czasie uruchomienia reguły.
at(date)	ClockTriggerBuilder	Określa, kiedy uruchamiana jest reguła.
atDate(year, month, day)	ClockTriggerBuilder	Określa, że reguła uruchamia się danego dnia, domyślnie w pobliżu północy (+/- 15 minut).
atHour(hour)	ClockTriggerBuilder	Określa godzinę, o której uruchamia się aktywator.
create()	Trigger	Tworzy aktywator.
everyDays(n)	ClockTriggerBuilder	Określa, że reguła uruchamia się co n dni.
everyHours(n)	ClockTriggerBuilder	Określa, że reguła uruchamia się co n godzin.
everyMinutes(n)	ClockTriggerBuilder	Określa, że aktywator uruchamia się co n min.
everyWeeks(n)	ClockTriggerBuilder	Określa, że reguła uruchamia się co n tygodnie.
inTimezone(timezone)	ClockTriggerBuilder	Określa strefę czasową dla dat i godzin uruchomienia reguły.
nearMinute(minute)	ClockTriggerBuilder	Określa minutę, w której uruchamia się reguła (plus lub minus 15 minut).
onMonthDay(day)	ClockTriggerBuilder	Określa datę w miesiącu, w którym uruchomiono regułę.
onWeekDay(day)	ClockTriggerBuilder	Określa dzień tygodnia, w którym reguła jest uruchamiana.

DocumentTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
create()	Trigger	Tworzy i zwraca nowy aktywator.
onOpen()	DocumentTriggerBuilder	Określa wyzwalacz, który uruchomi się, gdy dokument zostanie otwarty.

EventType

Właściwości

Właściwość	Typ	Opis
CLOCK	Enum	Reguła uruchamia się, gdy zdarzenie zależne od czasu osiągnie określony czas.
ON_OPEN	Enum	Reguła jest uruchamiana, gdy użytkownik otworzy plik Dokumentów, Arkuszy lub Formularzy Google.
ON_EDIT	Enum	Reguła uruchamia się, gdy użytkownik edytuje plik Arkuszy Google (np. przez wpisanie w komórce nowej wartości, co liczy się jako zmiana, a nie zmiana).
ON_FORM_SUBMIT	Enum	Reguła uruchamia się, gdy użytkownik odpowie na formularz Google.
ON_CHANGE	Enum	Reguła uruchamia się, gdy użytkownik zmieni plik Arkuszy Google (np. dodając wiersz, co liczy się jako zmiana, a nie zmiana).
ON_EVENT_UPDATED	Enum	Reguła uruchamia się, gdy wydarzenie zostanie utworzone, zaktualizowane lub usunięte w określonym Kalendarzu Google.

FormTriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
create()	Trigger	Tworzy i zwraca nowy aktywator.
onFormSubmit()	FormTriggerBuilder	Określa regułę, która uruchomi się po przesłaniu odpowiedzi w formularzu.
onOpen()	FormTriggerBuilder	Określa regułę, która uruchomi się 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 domeny użytkownika.
NONE	Enum	Skrypt nie jest uruchomiony jako dodatek.
WEB_STORE_ADD_ON	Enum	Dodatek został zainstalowany przez użytkownika ze sklepu Chrome Web Store.

ScriptApp

Właściwości

Właściwość	Typ	Opis
AuthMode	AuthMode	Wyliczenie określające kategorie autoryzowanych usług, które Apps Script może wykonywać za pomocą aktywowanej funkcji.
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 sposób, w jaki skrypt został zainstalowany u użytkownika jako dodatek.
TriggerSource	TriggerSource	Wyliczenie wskazują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 aktywator, aby nie był już uruchamiany.
getAuthorizationInfo(authMode)	AuthorizationInfo	Pobiera obiekt służący do określenia, czy użytkownik musi autoryzować ten skrypt, aby korzystał z co najmniej 1 usługi, oraz aby podać adres URL okna autoryzacji.
getIdentityToken()	String	Pobiera token tożsamości OpenID Connect dla efektywnego użytkownika, jeśli został przydzielony zakres openid.
getInstallationSource()	InstallationSource	Zwraca wartość wyliczeniową wskazującą, w jaki sposób skrypt został zainstalowany jako dodatek u bieżącego użytkownika (np. czy użytkownik zainstalował go osobiście ze sklepu Chrome Web Store lub czy administrator domeny zainstalował go dla wszystkich użytkowników).
getOAuthToken()	String	Pobiera token dostępu OAuth 2.0 dla odpowiedniego użytkownika.
getProjectTriggers()	Trigger[]	Pobiera wszystkie aktywatory do zainstalowania 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 możliwe do zainstalowania, które należą do tego użytkownika w danym dokumencie, tylko dla tego skryptu lub dodatku.
getUserTriggers(form)	Trigger[]	Pobiera wszystkie aktywatory, które można zainstalować, należące do tego użytkownika w podanej formie, tylko dla tego skryptu lub dodatku.
getUserTriggers(spreadsheet)	Trigger[]	Pobiera wszystkie aktywatory, które można zainstalować, należące do tego użytkownika w danym arkuszu kalkulacyjnym. Dotyczy to tylko tego skryptu lub dodatku.
invalidateAuth()	void	Unieważnia autoryzację użytkownika, który ma wykonać bieżący skrypt.
newStateToken()	StateTokenBuilder	Tworzy kreator dla tokena stanu, którego można używać w interfejsie API wywołania zwrotnego (np. w przepływie OAuth).
newTrigger(functionName)	TriggerBuilder	Rozpoczyna proces tworzenia konfigurowalnego aktywatora, który po uruchomieniu wywołuje określoną funkcję.

Service

Metody

Metoda	Zwracany typ	Krótki opis
getUrl()	String	Zwraca adres URL aplikacji internetowej, jeśli została 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 regułę i zwraca ją.
onChange()	SpreadsheetTriggerBuilder	Określa regułę, która uruchomi się po zmianie zawartości lub struktury arkusza kalkulacyjnego.
onEdit()	SpreadsheetTriggerBuilder	Określa regułę, która zostanie uruchomiona po wprowadzeniu zmian w arkuszu kalkulacyjnym.
onFormSubmit()	SpreadsheetTriggerBuilder	Określa regułę, która uruchomi się, gdy do arkusza kalkulacyjnego 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	Konstruuje zaszyfrowany ciąg znaków reprezentujący token stanu.
withArgument(name, value)	StateTokenBuilder	Dodaje argument do tokena.
withMethod(method)	StateTokenBuilder	Konfiguruje 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 jest wywołane przez regułę.
getHandlerFunction()	String	Zwraca funkcję, która zostanie wywołana po uruchomieniu reguły.
getTriggerSource()	TriggerSource	Zwraca źródło zdarzeń, które będą powodować uruchomienie reguły.
getTriggerSourceId()	String	Zwraca identyfikator specyficzny dla źródła.
getUniqueId()	String	Zwraca unikalny identyfikator, który umożliwia odróżnianie od siebie aktywatorów.

TriggerBuilder

Metody

Metoda	Zwracany typ	Krótki opis
forDocument(document)	DocumentTriggerBuilder	Tworzy i zwraca element DocumentTriggerBuilder powiązany z danym dokumentem.
forDocument(key)	DocumentTriggerBuilder	Tworzy i zwraca element DocumentTriggerBuilder powiązany z dokumentem o podanym identyfikatorze.
forForm(form)	FormTriggerBuilder	Tworzy i zwraca obiekt FormTriggerBuilder powiązany z podanym 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 element SpreadsheetTriggerBuilder powiązany z arkuszem kalkulacyjnym o podanym identyfikatorze.
forUserCalendar(emailId)	CalendarTriggerBuilder	Zwraca konstruktor do tworzenia aktywatorów kalendarza.
timeBased()	ClockTriggerBuilder	Tworzy i zwraca wartość ClockTriggerBuilder do tworzenia reguł opartych na czasie.

TriggerSource

Właściwości

Właściwość	Typ	Opis
SPREADSHEETS	Enum	Arkusze Google powodują uruchomienie reguły.
CLOCK	Enum	Zdarzenie na podstawie czasu powoduje uruchomienie reguły.
FORMS	Enum	Formularze Google powodują uruchomienie reguły.
DOCUMENTS	Enum	Dokumenty Google powodują uruchomienie reguły.
CALENDAR	Enum	Kalendarz Google powoduje uruchomienie reguły.