Script Service

Script

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

Zajęcia

NazwaKrótki opis
AuthModeWyliczenie określające kategorie autoryzowanych usług, które Apps Script może wykonywać za pomocą aktywowanej funkcji.
AuthorizationInfoObiekt 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.
AuthorizationStatusWyliczenie określające stan autoryzacji skryptu.
CalendarTriggerBuilderKreator reguł kalendarza.
ClockTriggerBuilderKreator wyzwalaczy zegara.
DocumentTriggerBuilderKreator aktywatorów dokumentów.
EventTypeWyliczenie określające typ wywołanego zdarzenia.
FormTriggerBuilderKreator aktywatorów formularzy.
InstallationSourceWyliczenie wskazujące, jak skrypt został zainstalowany jako dodatek dla bieżącego użytkownika.
ScriptAppDostęp do publikowania skryptów i aktywatorów oraz manipulowanie nimi.
ServiceDostęp do publikowania skryptów i manipulowanie nim.
SpreadsheetTriggerBuilderKreator reguł w arkuszu kalkulacyjnym.
StateTokenBuilderZezwala skryptom na tworzenie tokenów stanu, które mogą być używane w interfejsach API wywołań zwrotnych (np. w przepływach OAuth).
TriggerWyzwalacz skryptu.
TriggerBuilderOgólny kreator aktywatorów skryptów.
TriggerSourceWyliczenie wskazujące źródło zdarzenia, które powoduje uruchomienie reguły.

AuthMode

Właściwości

WłaściwośćTypOpis
NONEEnumTryb, który nie zezwala na dostęp do żadnych usług wymagających autoryzacji.
CUSTOM_FUNCTIONEnumTryb, który umożliwia dostęp do ograniczonej liczby usług na potrzeby niestandardowych funkcji arkusza kalkulacyjnego.
LIMITEDEnumTryb, który umożliwia dostęp do ograniczonej liczby usług.
FULLEnumTryb, który umożliwia dostęp do wszystkich usług wymagających autoryzacji.

AuthorizationInfo

Metody

MetodaZwracany typKrótki opis
getAuthorizationStatus()AuthorizationStatusPobiera wartość wskazującą, czy użytkownik musi autoryzować ten skrypt, aby korzystać z co najmniej 1 usługi (np. ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringPobiera URL autoryzacji, za pomocą którego można przyznać dostęp do skryptu.

AuthorizationStatus

Właściwości

WłaściwośćTypOpis
REQUIREDEnumUżytkownik musi autoryzować ten skrypt, aby mógł korzystać z co najmniej 1 usługi.
NOT_REQUIREDEnumUżytkownik przyznał temu skryptowi wszystkie wymagane obecnie uprawnienia.

CalendarTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy regułę i zwraca ją.
onEventUpdated()CalendarTriggerBuilderOkreśla wyzwalacz uruchamiany 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 uruchomienia reguły.
at(date)ClockTriggerBuilderOkreśla, kiedy uruchamiana jest reguła.
atDate(year, month, day)ClockTriggerBuilderOkreśla, że reguła uruchamia się danego dnia, domyślnie w pobliżu północy (+/- 15 minut).
atHour(hour)ClockTriggerBuilderOkreśla godzinę, o której uruchamia się aktywator.
create()TriggerTworzy aktywator.
everyDays(n)ClockTriggerBuilderOkreśla, że reguła uruchamia się co n dni.
everyHours(n)ClockTriggerBuilderOkreśla, że reguła uruchamia się co n godzin.
everyMinutes(n)ClockTriggerBuilderOkreśla, że aktywator uruchamia się co n min.
everyWeeks(n)ClockTriggerBuilderOkreśla, że reguła uruchamia się co n tygodnie.
inTimezone(timezone)ClockTriggerBuilderOkreśla strefę czasową dla dat i godzin uruchomienia reguły.
nearMinute(minute)ClockTriggerBuilderOkreśla minutę, w której uruchamia się reguła (plus lub minus 15 minut).
onMonthDay(day)ClockTriggerBuilderOkreśla datę w miesiącu, w którym uruchomiono regułę.
onWeekDay(day)ClockTriggerBuilderOkreśla dzień tygodnia, w którym reguła jest uruchamiana.

DocumentTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy i zwraca nowy aktywator.
onOpen()DocumentTriggerBuilderOkreśla wyzwalacz, który uruchomi się, gdy dokument zostanie otwarty.

EventType

Właściwości

WłaściwośćTypOpis
CLOCKEnumReguła uruchamia się, gdy zdarzenie zależne od czasu osiągnie określony czas.
ON_OPENEnumReguła jest uruchamiana, gdy użytkownik otworzy plik Dokumentów, Arkuszy lub Formularzy Google.
ON_EDITEnumReguł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_SUBMITEnumReguła uruchamia się, gdy użytkownik odpowie na formularz Google.
ON_CHANGEEnumReguła uruchamia się, gdy użytkownik zmieni plik Arkuszy Google (np. dodając wiersz, co liczy się jako zmiana, a nie zmiana).
ON_EVENT_UPDATEDEnumReguła uruchamia się, gdy wydarzenie zostanie utworzone, zaktualizowane lub usunięte w określonym Kalendarzu Google.

FormTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy i zwraca nowy aktywator.
onFormSubmit()FormTriggerBuilderOkreśla regułę, która uruchomi się po przesłaniu odpowiedzi w formularzu.
onOpen()FormTriggerBuilderOkreśla regułę, która uruchomi się po otwarciu widoku edycji formularza.

InstallationSource

Właściwości

WłaściwośćTypOpis
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumDodatek został zainstalowany przez administratora domeny użytkownika.
NONEEnumSkrypt nie jest uruchomiony jako dodatek.
WEB_STORE_ADD_ONEnumDodatek został zainstalowany przez użytkownika ze sklepu Chrome Web Store.

ScriptApp

Właściwości

WłaściwośćTypOpis
AuthModeAuthModeWyliczenie określające kategorie autoryzowanych usług, które Apps Script może wykonywać za pomocą aktywowanej funkcji.
AuthorizationStatusAuthorizationStatusWyliczenie określające stan autoryzacji skryptu.
EventTypeEventTypeWyliczenie określające typ wywołanego zdarzenia.
InstallationSourceInstallationSourceWyliczenie określające sposób, w jaki skrypt został zainstalowany u użytkownika jako dodatek.
TriggerSourceTriggerSourceWyliczenie wskazujące źródło zdarzenia, które powoduje uruchomienie reguły.
WeekDayWeekdayWyliczenie reprezentujące dni tygodnia.

Metody

MetodaZwracany typKrótki opis
deleteTrigger(trigger)voidUsuwa dany aktywator, aby nie był już uruchamiany.
getAuthorizationInfo(authMode)AuthorizationInfoPobiera 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()StringPobiera token tożsamości OpenID Connect dla efektywnego użytkownika, jeśli został przydzielony zakres openid.
getInstallationSource()InstallationSourceZwraca 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()StringPobiera 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()StringPobiera unikalny identyfikator projektu skryptu.
getService()ServicePobiera 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()voidUnieważnia autoryzację użytkownika, który ma wykonać bieżący skrypt.
newStateToken()StateTokenBuilderTworzy kreator dla tokena stanu, którego można używać w interfejsie API wywołania zwrotnego (np. w przepływie OAuth).
newTrigger(functionName)TriggerBuilderRozpoczyna proces tworzenia konfigurowalnego aktywatora, który po uruchomieniu wywołuje określoną funkcję.

Service

Metody

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

SpreadsheetTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy regułę i zwraca ją.
onChange()SpreadsheetTriggerBuilderOkreśla regułę, która uruchomi się po zmianie zawartości lub struktury arkusza kalkulacyjnego.
onEdit()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona po wprowadzeniu zmian w arkuszu kalkulacyjnym.
onFormSubmit()SpreadsheetTriggerBuilderOkreśla regułę, która uruchomi się, gdy do arkusza kalkulacyjnego zostanie przesłany formularz.
onOpen()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona po otwarciu arkusza kalkulacyjnego.

StateTokenBuilder

Metody

MetodaZwracany typKrótki opis
createToken()StringKonstruuje zaszyfrowany ciąg znaków reprezentujący token stanu.
withArgument(name, value)StateTokenBuilderDodaje argument do tokena.
withMethod(method)StateTokenBuilderKonfiguruje 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 wywołane przez regułę.
getHandlerFunction()StringZwraca funkcję, która zostanie wywołana po uruchomieniu reguły.
getTriggerSource()TriggerSourceZwraca źródło zdarzeń, które będą powodować uruchomienie reguły.
getTriggerSourceId()StringZwraca identyfikator specyficzny dla źródła.
getUniqueId()StringZwraca unikalny identyfikator, który umożliwia odróżnianie od siebie aktywatorów.

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 obiekt FormTriggerBuilder powiązany z podanym formularzem.
forForm(key)FormTriggerBuilderTworzy i zwraca obiekt 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 aktywatorów kalendarza.
timeBased()ClockTriggerBuilderTworzy i zwraca wartość ClockTriggerBuilder do tworzenia reguł opartych na czasie.

TriggerSource

Właściwości

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