Script Service

Script

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

Zajęcia

NazwaKrótki opis
AuthModeWyliczenie, które określa kategorie autoryzowanych usług, które Apps Script może wykonywać za pomocą funkcji wyzwalanej.
AuthorizationInfoObiekt, który sprawdza, czy użytkownik przyznał autoryzację w wymaganych zakresach skryptu.
AuthorizationStatusWyliczenie określające stan autoryzacji skryptu.
CalendarTriggerBuilderKreator wyzwalaczy kalendarza.
ClockTriggerBuilderKreator wyzwalaczy zegarowych.
DocumentTriggerBuilderKreator aktywatorów dokumentów.
EventTypeWyliczenie oznaczające typ wywołanego zdarzenia.
FormTriggerBuilderNarzędzie do tworzenia aktywatorów formularzy.
InstallationSourceWyliczenie wskazujące, w jaki sposób skrypt został zainstalowany jako dodatek dla bieżącego użytkownika.
ScriptAppDostęp do publikowania skryptów i aktywatorów oraz możliwość manipulowania nimi.
ServiceDostęp do publikowania skryptów i manipulowanie nim.
SpreadsheetTriggerBuilderKreator wyzwalaczy arkusza kalkulacyjnego.
StateTokenBuilderUmożliwia skryptom tworzenie tokenów stanu, które mogą być używane w interfejsach API wywołania zwrotnego (np. w przypadku przepływów OAuth).
Triggeraktywator skryptu.
TriggerBuilderOgólny konstruktor aktywatorów skryptu.
TriggerSourceWyliczenie oznaczają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 ograniczonego podzbioru usług do użycia w funkcjach niestandardowych arkusza kalkulacyjnego.
LIMITEDEnumTryb, który umożliwia dostęp do ograniczonego podzbioru usług.
FULLEnumTryb, który umożliwia dostęp do wszystkich usług wymagających autoryzacji.

AuthorizationInfo

Metody

MetodaZwracany typKrótki opis
getAuthorizationStatus()AuthorizationStatusZwraca wartość wskazującą, czy użytkownik musi autoryzować ten skrypt, aby używać co najmniej 1 usługi (np. ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()String|nullPobiera adres URL autoryzacji, którego można użyć do przyznania dostępu do skryptu.
getAuthorizedScopes()String[]|nullPobiera listę autoryzowanych zakresów skryptu.

AuthorizationStatus

Właściwości

WłaściwośćTypOpis
REQUIREDEnumUżytkownik musi zezwolić temu skryptowi na korzystanie z co najmniej jednej usługi.
NOT_REQUIREDEnumUżytkownik przyznał temu skryptowi wszystkie wymagane obecnie uprawnienia.

CalendarTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy aktywator i go zwraca.
onEventUpdated()CalendarTriggerBuilderOkreśla regułę, która uruchamia się, gdy wpis w kalendarzu zostanie utworzony, zaktualizowany lub usunięty.

ClockTriggerBuilder

Metody

MetodaZwracany typKrótki opis
after(durationMilliseconds)ClockTriggerBuilderOkreśla minimalny czas (w milisekundach) po bieżącym czasie, po którym ma zostać uruchomiony wyzwalacz.
at(date)ClockTriggerBuilderOkreśla, kiedy wyzwalacz jest uruchamiany.
atDate(year, month, day)ClockTriggerBuilderOkreśla, że reguła zostanie uruchomiona w danym dniu, domyślnie około północy (±15 minut).
atHour(hour)ClockTriggerBuilderOkreśla godzinę, o której wyzwalacz jest uruchamiany.
create()TriggerTworzy aktywator.
everyDays(n)ClockTriggerBuilderOkreśla, że wyzwalacz ma być uruchamiany co n dni.
everyHours(n)ClockTriggerBuilderOkreśla, że aktywator ma być uruchamiany co n godziny.
everyMinutes(n)ClockTriggerBuilderOkreśla, że reguła ma być uruchamiana co n minut.
everyWeeks(n)ClockTriggerBuilderOkreśla, że wyzwalacz ma być uruchamiany co n tygodni.
inTimezone(timezone)ClockTriggerBuilderOkreśla strefę czasową dla podanych dat i godzin, w których uruchamia się reguła.
nearMinute(minute)ClockTriggerBuilderOkreśla minutę, w której wyzwalacz jest uruchamiany (plus lub minus 15 minut).
onMonthDay(day)ClockTriggerBuilderOkreśla dzień miesiąca, w którym ma się uruchamiać wyzwalacz.
onWeekDay(day)ClockTriggerBuilderOkreśla dzień tygodnia, w którym wyzwalacz jest uruchamiany.

DocumentTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy i zwraca nowy warunek.
onOpen()DocumentTriggerBuilderOkreśla regułę, która zostanie uruchomiona po otwarciu dokumentu.

EventType

Właściwości

WłaściwośćTypOpis
CLOCKEnumReguła uruchamia się, gdy zdarzenie oparte na czasie osiągnie określony moment.
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. wpisuje nową wartość w komórce, co jest traktowane jako edycja, a nie zmiana).
ON_FORM_SUBMITEnumReguła jest uruchamiana, gdy użytkownik odpowie na formularz Google.
ON_CHANGEEnumReguła wyzwalająca jest uruchamiana, gdy użytkownik zmieni plik Arkuszy Google (np. doda wiersz, co jest traktowane jako zmiana, a nie edycja).
ON_EVENT_UPDATEDEnumAktywator uruchamia się, gdy w określonym Kalendarzu Google zostanie utworzone, zaktualizowane lub usunięte wydarzenie.

FormTriggerBuilder

Metody

MetodaZwracany typKrótki opis
create()TriggerTworzy i zwraca nowy warunek.
onFormSubmit()FormTriggerBuilderOkreśla regułę, która zostanie uruchomiona po przesłaniu odpowiedzi w formularzu.
onOpen()FormTriggerBuilderOkreśla regułę, która zostanie uruchomiona 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 jest uruchomiony jako dodatek.
WEB_STORE_ADD_ONEnumDodatek został zainstalowany przez użytkownika z Chrome Web Store.

ScriptApp

Właściwości

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

Metody

MetodaZwracany typKrótki opis
deleteTrigger(trigger)voidUsuwa podany wyzwalacz, aby nie był już uruchamiany.
getAuthorizationInfo(authMode)AuthorizationInfoZwraca obiekt, który sprawdza, czy użytkownik przyznał autoryzację dla wszystkich wymagań skryptu.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoPobiera obiekt, który sprawdza, czy użytkownik przyznał autoryzację w przypadku żądanych zakresów.
getIdentityToken()String|nullPobiera token tożsamości OpenID Connect dla efektywnego użytkownika, jeśli przyznano zakres openid.
getInstallationSource()InstallationSourceZwraca wartość wyliczeniową, która wskazuje, w jaki sposób skrypt został zainstalowany jako dodatek dla bieżącego użytkownika (np. czy użytkownik zainstalował go osobiście w Chrome Web Store, czy administrator domeny zainstalował go dla wszystkich użytkowników).
getOAuthToken()StringPobiera token dostępu OAuth 2.0 dla użytkownika.
getProjectTriggers()Trigger[]Pobiera wszystkie wyzwalacze, które można zainstalować, powiązane z bieżącym projektem i bieżącym użytkownikiem.
getScriptId()StringPobiera unikalny identyfikator projektu skryptu.
getService()ServiceZwraca obiekt używany do kontrolowania publikowania skryptu jako aplikacji internetowej.
getUserTriggers(document)Trigger[]Pobiera wszystkie wyzwalacze, które można zainstalować i których właścicielem jest ten użytkownik w danym dokumencie, tylko dla tego skryptu lub dodatku.
getUserTriggers(form)Trigger[]Pobiera wszystkie instalowane wyzwalacze należące do tego użytkownika w danym formularzu, tylko dla tego skryptu lub dodatku.
getUserTriggers(spreadsheet)Trigger[]Pobiera wszystkie instalowane wyzwalacze należące do tego użytkownika w danym arkuszu kalkulacyjnym, tylko dla tego skryptu lub dodatku.
invalidateAuth()voidUnieważnia autoryzację, którą użytkownik ma do wykonania bieżącego skryptu.
newStateToken()StateTokenBuilderTworzy narzędzie do tworzenia tokena stanu, którego można używać w interfejsie API wywołania zwrotnego (np. w przepływie OAuth).
newTrigger(functionName)TriggerBuilderRozpoczyna proces tworzenia aktywatora, który można zainstalować i który po uruchomieniu wywołuje daną funkcję.
requireAllScopes(authMode)voidSprawdza, czy użytkownik wyraził zgodę na wszystkie zakresy, o które prosi skrypt.
requireScopes(authMode, oAuthScopes)voidSprawdza, czy użytkownik wyraził zgodę na żądane zakresy.

Service

Metody

MetodaZwracany typKrótki opis
getUrl()StringZwraca adres URL aplikacji internetowej, jeśli została 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 go zwraca.
onChange()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona, gdy zmieni się zawartość lub struktura arkusza kalkulacyjnego.
onEdit()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona po edycji arkusza kalkulacyjnego.
onFormSubmit()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona po przesłaniu formularza do arkusza kalkulacyjnego.
onOpen()SpreadsheetTriggerBuilderOkreśla regułę, która zostanie uruchomiona 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 uruchamia regułę.
getHandlerFunction()StringZwraca funkcję, która zostanie wywołana po zadziałaniu czynnika uruchamiającego.
getTriggerSource()TriggerSourceZwraca źródło zdarzeń, które spowodują uruchomienie reguły.
getTriggerSourceId()StringZwraca identyfikator specyficzny dla źródła.
getUniqueId()StringZwraca unikalny identyfikator, który można wykorzystać do rozróżniania wyzwalaczy.

TriggerBuilder

Metody

MetodaZwracany typKrótki opis
forDocument(document)DocumentTriggerBuilderTworzy i zwraca DocumentTriggerBuilder powiązany z danym dokumentem.
forDocument(key)DocumentTriggerBuilderTworzy i zwraca obiekt DocumentTriggerBuilder powiązany z dokumentem o podanym identyfikatorze.
forForm(form)FormTriggerBuilderTworzy i zwraca obiekt FormTriggerBuilder powiązany z danym formularzem.
forForm(key)FormTriggerBuilderTworzy i zwraca FormTriggerBuilder powiązany z formularzem o podanym identyfikatorze.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderTworzy i zwraca SpreadsheetTriggerBuilder powiązany z danym arkuszem kalkulacyjnym.
forSpreadsheet(key)SpreadsheetTriggerBuilderTworzy i zwraca SpreadsheetTriggerBuilder powiązany z arkuszem o podanym identyfikatorze.
forUserCalendar(emailId)CalendarTriggerBuilderZwraca narzędzie do tworzenia wyzwalaczy kalendarza.
timeBased()ClockTriggerBuilderTworzy i zwraca obiekt ClockTriggerBuilder do tworzenia aktywatorów opartych na czasie.

TriggerSource

Właściwości

WłaściwośćTypOpis
SPREADSHEETSEnumArkusze Google powodują uruchomienie reguły.
CLOCKEnumReguła jest uruchamiana przez zdarzenie oparte na czasie.
FORMSEnumFormularze Google powodują uruchomienie wyzwalacza.
DOCUMENTSEnumDokumenty Google powodują uruchomienie reguły.
CALENDAREnumKalendarz Google powoduje uruchomienie wyzwalacza.