Script Service

Script

Bu hizmet, komut dosyası tetikleyicilerine ve komut dosyası yayınlamaya erişim sağlar.

Sınıflar

AdKısa açıklama
AuthModeTetiklenen bir işlev aracılığıyla Apps Komut Dosyası'nın hangi yetkili hizmet kategorilerini yürütebileceğini tanımlayan bir numaralandırma.
AuthorizationInfoKullanıcının bir veya daha fazla hizmeti kullanmak üzere bu komut dosyasını yetkilendirmesi gerekip gerekmediğini belirlemek ve yetkilendirme iletişim kutusunun URL'sini sağlamak için kullanılan bir nesne.
AuthorizationStatusKomut dosyasının yetkilendirme durumunu belirten bir numaralandırma.
CalendarTriggerBuilderTakvim tetikleyicileri için oluşturucu.
ClockTriggerBuilderSaat tetikleyicileri için bir oluşturucu.
DocumentTriggerBuilderDoküman tetikleyicileri için oluşturucu.
EventTypeTetiklenen etkinliğin türünü belirten bir numaralandırma.
FormTriggerBuilderForm tetikleyicileri için bir oluşturucu.
InstallationSourceKomut dosyasının geçerli kullanıcı için eklenti olarak nasıl yüklendiğini belirten bir numaralandırma.
ScriptAppKomut dosyası yayınlama ve tetikleyicilerine erişme ve bunları değiştirme.
ServiceKomut dosyası yayınlamaya erişme ve bunları değiştirme.
SpreadsheetTriggerBuilderE-tablo tetikleyicileri için oluşturucu.
StateTokenBuilderKomut dosyalarının, geri çağırma API'lerinde (OAuth akışları gibi) kullanılabilecek durum jetonları oluşturmasına izin verir.
TriggerKomut dosyası tetikleyicisi.
TriggerBuilderKomut dosyası tetikleyicileri için genel bir oluşturucu.
TriggerSourceTetikleyicinin etkinleşmesine neden olan etkinliğin kaynağını belirten bir numaralandırma.

AuthMode

Özellikler

ÖzellikTürAçıklama
NONEEnumYetkilendirme gerektiren hizmetlere erişime izin vermeyen bir mod.
CUSTOM_FUNCTIONEnumÖzel e-tablo işlevlerinde kullanılmak üzere sınırlı bir hizmet alt kümesine erişim sağlayan mod.
LIMITEDEnumSınırlı bir hizmet alt kümesine erişim sağlayan mod.
FULLEnumYetkilendirme gerektiren tüm hizmetlere erişim sağlayan bir mod.

AuthorizationInfo

Yöntemler

YöntemDönüş türüKısa açıklama
getAuthorizationStatus()AuthorizationStatusKullanıcının bir veya daha fazla hizmeti (örneğin, ScriptApp.AuthorizationStatus.REQUIRED) kullanması için bu komut dosyasını yetkilendirmesi gerekip gerekmediğini belirten bir değer alır.
getAuthorizationUrl()StringKomut dosyasına erişim vermek için kullanılabilecek yetkilendirme URL'sini alır.

AuthorizationStatus

Özellikler

ÖzellikTürAçıklama
REQUIREDEnumKullanıcının bir veya daha fazla hizmeti kullanması için bu komut dosyasını yetkilendirmesi gerekir.
NOT_REQUIREDEnumKullanıcı, bu komut dosyasına şu anda ihtiyaç duyduğu tüm yetkilendirmeyi verdi.

CalendarTriggerBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
create()TriggerTetikleyiciyi oluşturur ve döndürür.
onEventUpdated()CalendarTriggerBuilderBir takvim girişi oluşturulduğunda, güncellendiğinde veya silindiğinde etkinleşen bir tetikleyiciyi belirtir.

ClockTriggerBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
after(durationMilliseconds)ClockTriggerBuilderTetikleyicinin çalıştığı geçerli saatten sonraki minimum süreyi (milisaniye cinsinden) belirtir.
at(date)ClockTriggerBuilderTetikleyicinin ne zaman çalışacağını belirtir.
atDate(year, month, day)ClockTriggerBuilderTetikleyicinin belirtilen tarihte, varsayılan olarak gece yarısına yakın bir yerde (+/- 15 dakika) etkinleşeceğini belirtir.
atHour(hour)ClockTriggerBuilderTetikleyicinin çalışacağı saati belirtir.
create()TriggerTetikleyiciyi oluşturur.
everyDays(n)ClockTriggerBuilderTetikleyicinin n günde bir çalıştırılacağını belirtir.
everyHours(n)ClockTriggerBuilderTetikleyicinin her n saatte bir çalıştırılacağını belirtir.
everyMinutes(n)ClockTriggerBuilderTetikleyicinin n dakikada bir çalıştırılacağını belirtir.
everyWeeks(n)ClockTriggerBuilderTetikleyicinin n haftada bir çalıştırılacağını belirtir.
inTimezone(timezone)ClockTriggerBuilderTetikleyici çalıştığında belirtilen tarihler/saat için saat dilimini belirtir.
nearMinute(minute)ClockTriggerBuilderTetikleyicinin çalıştırılacağı dakikayı (artı veya eksi 15 dakika) belirtir.
onMonthDay(day)ClockTriggerBuilderTetikleyicinin çalıştığı ayda tarihi belirtir.
onWeekDay(day)ClockTriggerBuilderTetikleyicinin çalıştığı haftanın gününü belirtir.

DocumentTriggerBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
create()TriggerYeni tetikleyiciyi oluşturur ve döndürür.
onOpen()DocumentTriggerBuilderDoküman açıldığında etkinleşecek bir tetikleyici belirtir.

EventType

Özellikler

ÖzellikTürAçıklama
CLOCKEnumZamana bağlı etkinlik belirli bir zamana ulaştığında tetikleyici etkinleşir.
ON_OPENEnumKullanıcı Google Dokümanlar, E-Tablolar veya Formlar dosyasını açtığında tetikleyici etkinleşir.
ON_EDITEnumTetikleyici, kullanıcı Google E-Tablolar dosyasını düzenlediğinde etkinleşir (örneğin, hücreye yeni bir değer girerek bu işlem değişiklik yerine düzenleme olarak sayılır).
ON_FORM_SUBMITEnumKullanıcı, bir Google Formuna yanıt verdiğinde tetikleyici etkinleşir.
ON_CHANGEEnumKullanıcı Google E-Tablolar dosyasını değiştirdiğinde (örneğin, bir düzenleme yerine değişiklik olarak sayılan bir satır ekleyerek) tetikleyici etkinleşir.
ON_EVENT_UPDATEDEnumBelirtilen Google Takvim'de bir etkinlik oluşturulduğunda, güncellendiğinde veya silindiğinde tetikleyici etkinleşir.

FormTriggerBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
create()TriggerYeni tetikleyiciyi oluşturur ve döndürür.
onFormSubmit()FormTriggerBuilderForma bir yanıt gönderildiğinde etkinleşecek bir tetikleyiciyi belirtir.
onOpen()FormTriggerBuilderFormun düzenleme görünümü açıldığında etkinleşecek bir tetikleyici belirtir.

InstallationSource

Özellikler

ÖzellikTürAçıklama
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumEklenti, kullanıcının alanı için yönetici tarafından yüklendi.
NONEEnumKomut dosyası eklenti olarak çalışmıyor.
WEB_STORE_ADD_ONEnumEklenti, kullanıcı tarafından Chrome Web Mağazası'ndan yüklendi.

ScriptApp

Özellikler

ÖzellikTürAçıklama
AuthModeAuthModeTetiklenen bir işlev aracılığıyla Apps Komut Dosyası'nın hangi yetkili hizmet kategorilerini yürütebileceğini tanımlayan bir numaralandırma.
AuthorizationStatusAuthorizationStatusKomut dosyasının yetkilendirme durumunu belirten bir numaralandırma.
EventTypeEventTypeTetiklenen etkinliğin türünü belirten bir numaralandırma.
InstallationSourceInstallationSourceKomut dosyasının kullanıcıya nasıl eklenti olarak yüklendiğini belirten bir numaralandırma.
TriggerSourceTriggerSourceTetikleyicinin etkinleşmesine neden olan etkinliğin kaynağını belirten bir numaralandırma.
WeekDayWeekdayHaftanın günlerini temsil eden bir numaralandırma.

Yöntemler

YöntemDönüş türüKısa açıklama
deleteTrigger(trigger)voidBelirtilen tetikleyiciyi kaldırarak artık çalışmamasını sağlar.
getAuthorizationInfo(authMode)AuthorizationInfoKullanıcının bir veya daha fazla hizmeti kullanmak üzere bu komut dosyasını yetkilendirmesi gerekip gerekmediğini belirlemek ve yetkilendirme iletişim kutusunun URL'sini sağlamak için kullanılan bir nesne alır.
getIdentityToken()Stringopenid kapsamı verilmişse etkili kullanıcı için bir OpenID Connect kimlik jetonu alır.
getInstallationSource()InstallationSourceKomut dosyasının geçerli kullanıcı için eklenti olarak nasıl yüklendiğini (örneğin, kullanıcının komut dosyasını Chrome Web Mağazası üzerinden şahsen yükleyip yüklemediğini veya bir alan yöneticisinin tüm kullanıcılar için yükleyip yüklemediğini) belirten bir sıralama değeri döndürür.
getOAuthToken()StringEtkili kullanıcı için OAuth 2.0 erişim jetonunu alır.
getProjectTriggers()Trigger[]Mevcut proje ve geçerli kullanıcıyla ilişkilendirilmiş tüm yüklenebilir tetikleyicileri alır.
getScriptId()StringKomut dosyası projesinin benzersiz kimliğini alır.
getService()ServiceKomut dosyasının web uygulaması olarak yayınlanmasını kontrol etmek için kullanılan bir nesne alır.
getUserTriggers(document)Trigger[]Belirtilen dokümanda, bu kullanıcının sahip olduğu tüm yüklenebilir tetikleyicileri yalnızca bu komut dosyası veya eklenti için alır.
getUserTriggers(form)Trigger[]Bu kullanıcının sahip olduğu, belirtilen formda (yalnızca bu komut dosyası veya eklenti için) tüm yüklenebilir tetikleyicileri alır.
getUserTriggers(spreadsheet)Trigger[]Belirtilen e-tabloda, bu kullanıcının sahip olduğu tüm yüklenebilir tetikleyicileri yalnızca bu komut dosyası veya eklenti için alır.
invalidateAuth()voidEtkili kullanıcının mevcut komut dosyasını çalıştırmak için sahip olduğu yetkilendirmeyi geçersiz kılar.
newStateToken()StateTokenBuilderGeri çağırma API'lerinde (OAuth akışı gibi) kullanılabilecek bir durum jetonu için derleyici oluşturur.
newTrigger(functionName)TriggerBuilderTetiklendiğinde belirli bir işlevi çağıran yüklenebilir bir tetikleyici oluşturma sürecini başlatır.

Service

Yöntemler

YöntemDönüş türüKısa açıklama
getUrl()StringDağıtıldıysa web uygulamasının URL'sini; aksi takdirde null değerini döndürür.
isEnabled()BooleanKomut dosyasına bir web uygulaması olarak erişilebiliyorsa true değerini döndürür.

SpreadsheetTriggerBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
create()TriggerTetikleyiciyi oluşturur ve döndürür.
onChange()SpreadsheetTriggerBuilderE-tablonun içeriği veya yapısı değiştirildiğinde etkinleşecek bir tetikleyici belirtir.
onEdit()SpreadsheetTriggerBuilderE-tablo düzenlendiğinde etkinleşecek bir tetikleyiciyi belirtir.
onFormSubmit()SpreadsheetTriggerBuilderE-tabloda ona bir form gönderildiğinde etkinleşecek bir tetikleyiciyi belirtir.
onOpen()SpreadsheetTriggerBuilderE-tablo açıldığında etkinleşecek bir tetikleyiciyi belirtir.

StateTokenBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
createToken()StringDurum jetonunun şifrelenmiş bir dize temsilini oluşturur.
withArgument(name, value)StateTokenBuilderJetona bir bağımsız değişken ekler.
withMethod(method)StateTokenBuilderBir geri çağırma işlevi ayarlar.
withTimeout(seconds)StateTokenBuilderJetonun geçerli olduğu süreyi (saniye cinsinden) ayarlar.

Trigger

Yöntemler

YöntemDönüş türüKısa açıklama
getEventType()EventTypeTetikleyicinin etkinleştirdiği etkinlik türünü döndürür.
getHandlerFunction()StringTetikleyici etkinleştiğinde çağrılacak işlevi döndürür.
getTriggerSource()TriggerSourceTetikleyicinin etkinleşmesine neden olacak etkinliklerin kaynağını döndürür.
getTriggerSourceId()StringKaynağa özgü kimliği döndürür.
getUniqueId()StringTetikleyicileri birbirinden ayırt etmek için kullanılabilecek benzersiz bir tanımlayıcı döndürür.

TriggerBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
forDocument(document)DocumentTriggerBuilderBelirtilen dokümana bağlı bir DocumentTriggerBuilder oluşturur ve döndürür.
forDocument(key)DocumentTriggerBuilderBelirtilen kimliğe sahip dokümana bağlı bir DocumentTriggerBuilder oluşturur ve döndürür.
forForm(form)FormTriggerBuilderBelirtilen forma bağlı bir FormTriggerBuilder oluşturur ve döndürür.
forForm(key)FormTriggerBuilderVerilen kimliğe sahip forma bağlı bir FormTriggerBuilder oluşturur ve döndürür.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderBelirtilen e-tabloya bağlı bir SpreadsheetTriggerBuilder oluşturur ve döndürür.
forSpreadsheet(key)SpreadsheetTriggerBuilderBelirtilen kimliğe sahip e-tabloya bağlı bir SpreadsheetTriggerBuilder oluşturur ve döndürür.
forUserCalendar(emailId)CalendarTriggerBuilderTakvim tetikleyicileri oluşturmak için bir oluşturucu döndürür.
timeBased()ClockTriggerBuilderZamana dayalı tetikleyiciler oluşturmak için bir ClockTriggerBuilder oluşturur ve döndürür.

TriggerSource

Özellikler

ÖzellikTürAçıklama
SPREADSHEETSEnumGoogle E-Tablolar, tetikleyicinin etkinleşmesine neden olur.
CLOCKEnumZamana bağlı bir olay, tetikleyicinin etkinleşmesine neden olur.
FORMSEnumGoogle Formlar, tetikleyicinin etkinleşmesine neden olur.
DOCUMENTSEnumGoogle Dokümanlar, tetikleyicinin etkinleşmesine neden olur.
CALENDAREnumGoogle Takvim, tetikleyicinin etkinleşmesine neden olur.