Script Service

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Script

Usługa ta zapewnia dostęp do aktywatorów skryptów i ich publikowania.

Zajęcia

NazwaKrótki opis
AuthModeWyliczenie, które kategorie autoryzowanych usług Apps Script mogą wykonywać za pomocą aktywowanej funkcji.
AuthorizationInfoObiekt używany do określenia, czy użytkownik musi upoważnić ten skrypt do korzystania z co najmniej 1 usługi oraz podać adres URL okna dialogowego autoryzacji.
AuthorizationStatusOpis wskazujący stan autoryzacji skryptu.
CalendarTriggerBuilderKreator reguł uruchamiających kalendarz.
ClockTriggerBuilderKreator reguł zegara.
DocumentTriggerBuilderKreator reguł uruchamiających dokumenty.
EventTypeOpis określający typ wywołanego zdarzenia.
FormTriggerBuilderKreator reguł uruchamiających formularze.
InstallationSourceNumeracja, która wskazuje, jak skrypt został zainstalowany jako dodatek dla bieżącego użytkownika.
ScriptAppDostęp do skryptów i reguł, a także manipulowanie nimi.
ServiceDostęp do skryptów i manipulowanie nimi.
SpreadsheetTriggerBuilderKreator reguł uruchamiających arkusz kalkulacyjny.
StateTokenBuilderZezwala na tworzenie skryptów stanu, które mogą być używane w interfejsach API wywołania zwrotnego (np. przepływach OAuth).
TriggerWyzwalacz skryptu.
TriggerBuilderOgólny kreator reguł.
TriggerSourceOpis wskazujący źródło zdarzenia, które powoduje uruchomienie reguły.

AuthMode

Właściwości

WłaściwośćTypOpis
NONEEnumtryb, który nie pozwala uzyskać dostępu do żadnych usług, które wymagają autoryzacji;
CUSTOM_FUNCTIONEnumTryb, który pozwala na dostęp do ograniczonego podzbioru usług na potrzeby niestandardowych funkcji arkuszy kalkulacyjnych.
LIMITEDEnumTryb, który umożliwia dostęp do ograniczonego podzbioru usług.
FULLEnumTryb, który umożliwia dostęp do wszystkich usług, które wymagają autoryzacji.

AuthorizationInfo

Metody

MetodaZwracany typKrótki opis
getAuthorizationStatus()AuthorizationStatusPobiera wartość, która wskazuje, czy użytkownik musi upoważnić ten skrypt do korzystania z jednej lub wielu usług (na przykład ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringPobiera adres URL autoryzacji, którego można użyć do przyznania dostępu do skryptu.

AuthorizationStatus

Właściwości

WłaściwośćTypOpis
REQUIREDEnumUżytkownik musi upoważnić ten skrypt do korzystania z co najmniej 1 usługi.
NOT_REQUIREDEnumUżytkownik przyznał temu skryptowi wszystkie wymagane aktualnie uprawnienia.

CalendarTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy aktywator i zwraca ją.
onEventUpdated()CalendarTriggerBuilderOkreśla regułę uruchamianą po utworzeniu, zaktualizowaniu lub usunięciu wpisu w kalendarzu.

ClockTriggerBuilder

Metody

MetodaZwracany typKrótki opis
after(durationMilliseconds)ClockTriggerBuilderOkreśla minimalny czas trwania (w milisekundach) po bieżącym czasie działania reguły.
at(date)ClockTriggerBuilderOkreśla, kiedy reguła się uruchamia.
atDate(year, month, day)ClockTriggerBuilderOkreśla, że reguła jest uruchamiana w określonym dniu, domyślnie o północy (+/- 15 minut).
atHour(hour)ClockTriggerBuilderOkreśla godzinę uruchamiania reguły.
create()TriggerTworzy regułę.
everyDays(n)ClockTriggerBuilderOkreśla uruchamianie reguły co n dni.
everyHours(n)ClockTriggerBuilderOkreśla uruchamianie reguły co n godzin.
everyMinutes(n)ClockTriggerBuilderOkreśla uruchamianie reguły co n minuty.
everyWeeks(n)ClockTriggerBuilderOkreśla uruchamianie reguły co n tygodni.
inTimezone(timezone)ClockTriggerBuilderOkreśla strefę czasową dla określonych dat i godzin, w których reguła ma się uruchamiać.
nearMinute(minute)ClockTriggerBuilderOkreśla minutę, w której reguła ma się uruchomić (plus lub minus 15 minut).
onMonthDay(day)ClockTriggerBuilderOkreśla datę uruchomienia reguły.
onWeekDay(day)ClockTriggerBuilderOkreśla dzień tygodnia uruchamiania reguły.

DocumentTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy i zwraca nowy aktywator.
onOpen()DocumentTriggerBuilderOkreśla regułę, która będzie uruchamiana po otwarciu dokumentu.

EventType

Właściwości

WłaściwośćTypOpis
CLOCKEnumReguła jest uruchamiana po osiągnięciu określonego zdarzenia w określonym czasie.
ON_OPENEnumReguła jest uruchamiana po otwarciu pliku Dokumentów, Arkuszy lub Formularzy Google.
ON_EDITEnumReguła jest uruchamiana, gdy użytkownik zmodyfikuje plik Arkuszy Google (np. wpisując nową wartość w komórce, która zostanie zliczona jako zmiana zamiast zmiany).
ON_FORM_SUBMITEnumReguła uruchamia się, gdy użytkownik odpowie na formularz Google.
ON_CHANGEEnumReguła jest uruchamiana, gdy użytkownik zmieni plik Arkuszy Google (na przykład przez dodanie wiersza, który liczy się jako zmiana, a nie zmiana).
ON_EVENT_UPDATEDEnumReguła jest uruchamiana po utworzeniu, zaktualizowaniu lub usunięciu wydarzenia w określonym Kalendarzu Google.

FormTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy i zwraca nowy aktywator.
onFormSubmit()FormTriggerBuilderOkreśla regułę, która będzie się uruchamiać po przesłaniu odpowiedzi do formularza.
onOpen()FormTriggerBuilderOkreśla regułę uruchamianą po otwarciu widoku edycji formularza.

InstallationSource

Właściwości

WłaściwośćTypOpis
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumDodatek został zainstalowany przez administratora w domenie użytkownika.
NONEEnumSkrypt nie działa jako dodatek.
WEB_STORE_ADD_ONEnumUżytkownik zainstalował dodatek ze sklepu Chrome Web Store.

ScriptApp

Właściwości

WłaściwośćTypOpis
AuthModeAuthModeWyliczenie, które kategorie autoryzowanych usług Apps Script mogą wykonywać za pomocą aktywowanej funkcji.
AuthorizationStatusAuthorizationStatusOpis wskazujący stan autoryzacji skryptu.
EventTypeEventTypeOpis określający typ wywołanego zdarzenia.
InstallationSourceInstallationSourceOkreślenie, w jaki sposób skrypt został zainstalowany na urządzeniu użytkownika jako dodatek.
TriggerSourceTriggerSourceOpis wskazujący źródło zdarzenia, które powoduje uruchomienie reguły.
WeekDayWeekdayWyliczenie reprezentujące dni tygodnia.

Metody

MetodaZwracany typKrótki opis
deleteTrigger(trigger)voidUsuwa daną regułę, co powoduje jej wyłączenie.
getAuthorizationInfo(authMode)AuthorizationInfoPobiera obiekt określający, czy użytkownik musi upoważnić ten skrypt do korzystania z co najmniej jednej usługi, oraz podać URL w oknie autoryzacji.
getIdentityToken()StringPobiera token tożsamości OpenID Connect dla odpowiedniego użytkownika, jeśli przyznano zakres openid.
getInstallationSource()InstallationSourceZwraca wartość 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 przez administratora domeny u wszystkich użytkowników).
getOAuthToken()StringPobiera token dostępu OAuth 2.0 dla rzeczywistego użytkownika.
getProjectTriggers()Trigger[]Pobiera wszystkie możliwe do zainstalowania reguły powiązane z bieżącym projektem i bieżącym użytkownikiem.
getScriptId()StringPobiera unikalny identyfikator projektu skryptu.
getService()ServicePobiera obiekt używany do kontrolowania skryptu jako aplikacji internetowej.
getUserTriggers(document)Trigger[]Pobiera wszystkie możliwe do zainstalowania wyzwalacze należące do tego użytkownika w danym dokumencie tylko dla tego skryptu lub dodatku.
getUserTriggers(form)Trigger[]Pobiera wszystkie możliwe do zainstalowania reguły należące do tego użytkownika w danym formularzu tylko dla tego skryptu lub dodatku.
getUserTriggers(spreadsheet)Trigger[]Pobiera wszystkie możliwe do zainstalowania aktywatory należące do tego użytkownika w danym arkuszu kalkulacyjnym wyłącznie dla tego skryptu lub dodatku.
invalidateAuth()voidUnieważnianie autoryzacji, który musi wykonać obecny użytkownik.
newStateToken()StateTokenBuilderTworzy konstruktor tokenu stanu, którego można użyć w interfejsie API wywołania zwrotnego (np. proces OAuth).
newTrigger(functionName)TriggerBuilderRozpoczyna proces tworzenia reguły możliwej do zainstalowania, która po uruchomieniu wywołuje określoną funkcję.

Service

Metody

MetodaZwracany typKrótki opis
getUrl()StringZwraca adres URL aplikacji internetowej, jeśli została ona wdrożona. W przeciwnym razie zwraca null.
isEnabled()BooleanZwraca wartość true, jeśli skrypt jest dostępny jako aplikacja internetowa.

SpreadsheetTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy aktywator i zwraca ją.
onChange()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona, gdy użytkownik zmieni treść lub strukturę arkusza kalkulacyjnego.
onEdit()SpreadsheetTriggerBuilderOkreśla regułę, która będzie uruchamiana podczas edytowania arkusza kalkulacyjnego.
onFormSubmit()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona, gdy do arkusza kalkulacyjnego zostanie przesłany formularz.
onOpen()SpreadsheetTriggerBuilderOkreśla regułę, która będzie uruchamiana po otwarciu arkusza kalkulacyjnego.

StateTokenBuilder

Metody

MetodaZwracany typKrótki opis
createToken()StringTworzy zaszyfrowany ciąg znaków reprezentujący token stanu.
withArgument(name, value)StateTokenBuilderDodaje argument do tokena.
withMethod(method)StateTokenBuilderUstawia funkcję wywołania zwrotnego.
withTimeout(seconds)StateTokenBuilderUstawia czas (w sekundach), przez jaki token jest ważny.

Trigger

Metody

MetodaZwracany typKrótki opis
getEventType()EventTypeZwraca typ zdarzenia, które jest uruchamiane przez regułę.
getHandlerFunction()StringZwraca funkcję, która zostanie wywołana po uruchomieniu reguły.
getTriggerSource()TriggerSourceZwraca źródło zdarzeń, które będą uruchamiać regułę.
getTriggerSourceId()StringZwraca identyfikator właściwy dla danego źródła.
getUniqueId()StringZwraca unikalny identyfikator, którego można użyć do odróżniania od siebie reguł.

TriggerBuilder

Metody

MetodaZwracany typKrótki opis
forDocument(document)DocumentTriggerBuilderTworzy i zwraca element DocumentTriggerBuilder powiązany z danym dokumentem.
forDocument(key)DocumentTriggerBuilderTworzy i zwraca element DocumentTriggerBuilder powiązany z dokumentem o podanym identyfikatorze.
forForm(form)FormTriggerBuilderTworzy i zwraca element FormTriggerBuilder powiązany z danym formularzem.
forForm(key)FormTriggerBuilderTworzy i zwraca element FormTriggerBuilder powiązany z formularzem o podanym identyfikatorze.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderTworzy i zwraca element SpreadsheetTriggerBuilder powiązany z danym arkuszem kalkulacyjnym.
forSpreadsheet(key)SpreadsheetTriggerBuilderTworzy i zwraca element SpreadsheetTriggerBuilder powiązany z arkuszem kalkulacyjnym o podanym identyfikatorze.
forUserCalendar(emailId)CalendarTriggerBuilderZwraca konstruktor do tworzenia reguł kalendarza.
timeBased()ClockTriggerBuilderTworzy i zwraca ClockTriggerBuilder na potrzeby aktywatorów zależnych od czasu.

TriggerSource

Właściwości

WłaściwośćTypOpis
SPREADSHEETSEnumArkusze Google powodują uruchomienie reguły.
CLOCKEnumZdarzenie wywoływane na podstawie czasu powoduje uruchomienie reguły.
FORMSEnumFormularze Google wywołują regułę.
DOCUMENTSEnumDokumenty Google powodują uruchomienie reguły.
CALENDAREnumKalendarz Google uruchamia regułę.