Script Service

Script

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

Sınıflar

AdKısa açıklama
AuthModeApps Script'in tetiklenen bir işlev aracılığıyla hangi yetkili hizmet kategorilerini yürütebileceğini tanımlayan bir sıralama.
AuthorizationInfoKullanıcının, komut dosyasının gerekli kapsamları için yetkilendirme verip vermediğini kontrol eden bir nesne.
AuthorizationStatusBir komut dosyasının yetkilendirme durumunu belirten bir sıralama.
CalendarTriggerBuilderTakvim tetikleyicileri için oluşturucu.
ClockTriggerBuilderSaat tetikleyicileri için bir oluşturucu.
DocumentTriggerBuilderDoküman tetikleyicileri için bir oluşturucu.
EventTypeTetiklenen etkinliğin türünü belirten bir sıralama.
FormTriggerBuilderForm tetikleyicileri için bir oluşturucu.
InstallationSourceKomut dosyasının mevcut kullanıcı için nasıl eklenti olarak yüklendiğini gösteren bir sıralama.
ScriptAppKomut dosyası yayınlama ve tetikleyicilere erişme ve bunları değiştirme.
ServiceKomut dosyası yayınlama özelliğine erişme ve bu özelliği kullanma.
SpreadsheetTriggerBuilderE-tablo tetikleyicileri için oluşturucu.
StateTokenBuilderKomut dosyalarının, geri çağırma API'lerinde (ör. OAuth akışları) kullanılabilecek durum jetonları oluşturmasına olanak tanır.
TriggerKomut dosyası tetikleyicisi
TriggerBuilderKomut dosyası tetikleyicileri için genel bir oluşturucu.
TriggerSourceTetikleyicinin etkinleştirilmesine neden olan etkinliğin kaynağını belirten bir sıralama.

AuthMode

Özellikler

MülkTürAçıklama
NONEEnumYetkilendirme gerektiren hizmetlere erişime izin verilmeyen bir mod.
CUSTOM_FUNCTIONEnumÖzel elektronik tablo işlevlerinde kullanılmak üzere hizmetlerin sınırlı bir alt kümesine erişime izin veren mod.
LIMITEDEnumHizmetlerin sınırlı bir alt kümesine erişime izin veren mod.
FULLEnumYetkilendirme gerektiren tüm hizmetlere erişime izin veren bir mod.

AuthorizationInfo

Yöntemler

YöntemDönüş türüKısa açıklama
getAuthorizationStatus()AuthorizationStatusKullanıcının bir veya daha fazla hizmeti (ör. ScriptApp.AuthorizationStatus.REQUIRED) kullanmak için bu komut dosyasını yetkilendirmesi gerekip gerekmediğini belirten bir değer alır.
getAuthorizationUrl()String|nullKomut dosyasına erişim izni vermek için kullanılabilecek yetkilendirme URL'sini alır.
getAuthorizedScopes()String[]|nullKomut dosyası için yetkilendirilmiş kapsamların listesini alır.

AuthorizationStatus

Özellikler

MülkTürAçıklama
REQUIREDEnumKullanıcının, bir veya daha fazla hizmeti kullanmak için bu komut dosyasını yetkilendirmesi gerekir.
NOT_REQUIREDEnumKullanıcı, bu komut dosyasına şu anda ihtiyaç duyduğu tüm yetkileri 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ışacağı, geçerli zamandan sonraki minimum süreyi (milisaniye cinsinden) belirtir.
at(date)ClockTriggerBuilderTetikleyicinin ne zaman çalışacağını belirtir.
atDate(year, month, day)ClockTriggerBuilderTetikleyicinin, varsayılan olarak gece yarısına yakın bir zamanda (+/- 15 dakika) belirtilen tarihte tetikleneceğini belirtir.
atHour(hour)ClockTriggerBuilderTetikleyicinin çalışacağı saati belirtir.
create()TriggerTetikleyiciyi oluşturur.
everyDays(n)ClockTriggerBuilderTetikleyicinin her 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 her n dakikada bir çalıştırılacağını belirtir.
everyWeeks(n)ClockTriggerBuilderTetikleyicinin her n haftada bir çalıştırılacağını belirtir.
inTimezone(timezone)ClockTriggerBuilderTetikleyicinin çalıştığı belirtilen tarihler/saat için saat dilimini belirtir.
nearMinute(minute)ClockTriggerBuilderTetikleyicinin çalışacağı dakikayı belirtir (artı veya eksi 15 dakika).
onMonthDay(day)ClockTriggerBuilderTetikleyicinin ay içinde çalışacağı tarihi belirtir.
onWeekDay(day)ClockTriggerBuilderTetikleyicinin çalışacağı 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()DocumentTriggerBuilderBelge açıldığında tetiklenecek bir tetikleyici belirtir.

EventType

Özellikler

MülkTürAçıklama
CLOCKEnumTetikleyici, zamana dayalı etkinlik belirli bir zamana ulaştığında tetiklenir.
ON_OPENEnumTetikleyici, kullanıcı Google Dokümanlar, E-Tablolar veya Formlar dosyasını açtığında etkinleşir.
ON_EDITEnumTetikleyici, kullanıcı Google E-Tablolar dosyasını düzenlediğinde (ör. bir hücreye yeni bir değer girerek) etkinleşir. Bu işlem, değişiklik yerine düzenleme olarak kabul edilir.
ON_FORM_SUBMITEnumKullanıcı bir Google Formu'nu yanıtladığında tetikleyici etkinleşir.
ON_CHANGEEnumTetikleyici, kullanıcı Google E-Tablolar dosyasını değiştirdiğinde (örneğin, satır ekleyerek) etkinleşir. Bu işlem, düzenleme yerine değişiklik olarak kabul edilir.
ON_EVENT_UPDATEDEnumTetikleyici, belirtilen Google Takvim'de bir etkinlik oluşturulduğunda, güncellendiğinde veya silindiğinde bir kez tetiklenir.

FormTriggerBuilder

Yöntemler

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

InstallationSource

Özellikler

MülkTü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üklenmiştir.

ScriptApp

Özellikler

MülkTürAçıklama
AuthModeAuthModeApps Komut Dosyası'nın tetiklenen bir işlev aracılığıyla hangi yetkili hizmet kategorilerini yürütebileceğini tanımlayan bir sıralama.
AuthorizationStatusAuthorizationStatusBir komut dosyasının yetkilendirme durumunu belirten bir sıralama.
EventTypeEventTypeTetiklenen etkinliğin türünü belirten bir sıralama.
InstallationSourceInstallationSourceKomut dosyasının kullanıcıya eklenti olarak nasıl yüklendiğini belirten bir numaralandırma.
TriggerSourceTriggerSourceTetikleyicinin etkinleştirilmesine neden olan etkinliğin kaynağını belirten bir sıralama.
WeekDayWeekdayHaftanın günlerini temsil eden bir sıralama.

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 tüm komut dosyası gereksinimleri için yetkilendirme verip vermediğini kontrol eden bir nesne alır.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoKullanıcının istenen kapsamlar için yetki verip vermediğini kontrol eden bir nesne alır.
getIdentityToken()String|nullopenid kapsamı verilmişse geçerli kullanıcı için OpenID Connect kimlik jetonu alır.
getInstallationSource()InstallationSourceKomut dosyasının mevcut kullanıcı için eklenti olarak nasıl yüklendiğini belirten bir enum değeri döndürür (örneğin, kullanıcı tarafından Chrome Web Mağazası üzerinden kişisel olarak mı yüklendiği veya bir alan yöneticisi tarafından tüm kullanıcılar için mi yüklendiği).
getOAuthToken()StringEtkili kullanıcı için OAuth 2.0 erişim jetonunu alır.
getProjectTriggers()Trigger[]Geçerli proje ve geçerli kullanıcıyla ilişkili 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 nesneyi alır.
getUserTriggers(document)Trigger[]Belirtilen dokümanda, bu komut dosyası veya eklenti için yalnızca bu kullanıcının sahip olduğu tüm yüklenebilir tetikleyicileri alır.
getUserTriggers(form)Trigger[]Belirtilen formda, bu kullanıcıya ait olan ve yalnızca bu komut dosyası veya eklenti için yüklenebilen tüm tetikleyicileri alır.
getUserTriggers(spreadsheet)Trigger[]Belirtilen e-tabloda, bu kullanıcıya ait ve yüklenebilir tüm tetikleyicileri yalnızca bu komut dosyası veya eklenti için alır.
invalidateAuth()voidGeçerli kullanıcının mevcut komut dosyasını yürütmek için sahip olduğu yetkilendirmeyi geçersiz kılar.
newStateToken()StateTokenBuilderGeri çağırma API'sinde (ör. OAuth akışı) kullanılabilecek bir durum jetonu için oluşturucu oluşturur.
newTrigger(functionName)TriggerBuilderTetiklendiğinde belirli bir işlevi çağıran, yüklenebilir bir tetikleyici oluşturma sürecini başlatır.
requireAllScopes(authMode)voidKullanıcının, komut dosyası tarafından istenen tüm kapsamlar için izin verip vermediğini doğrular.
requireScopes(authMode, oAuthScopes)voidKullanıcının istenen kapsamlar için izin verip vermediğini doğrular.

Service

Yöntemler

YöntemDönüş türüKısa açıklama
getUrl()StringDağıtılmışsa web uygulamasının URL'sini, aksi takdirde null değerini döndürür.
isEnabled()BooleanKomut dosyası 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 tetiklenecek bir tetikleyici belirtir.
onEdit()SpreadsheetTriggerBuilderE-tablo düzenlendiğinde tetiklenecek bir tetikleyici belirtir.
onFormSubmit()SpreadsheetTriggerBuilderE-tabloya form gönderildiğinde tetiklenecek bir tetikleyici belirtir.
onOpen()SpreadsheetTriggerBuilderE-tablo açıldığında tetiklenecek bir tetikleyici belirtir.

StateTokenBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
createToken()StringDurum jetonunun şifrelenmiş dize gösterimini oluşturur.
withArgument(name, value)StateTokenBuilderJetonun bağımsız değişkenini ekler.
withMethod(method)StateTokenBuilderGeri çağırma işlevi ayarlar.
withTimeout(seconds)StateTokenBuilderJetonun geçerli olacağı süreyi (saniye cinsinden) ayarlar.

Trigger

Yöntemler

YöntemDönüş türüKısa açıklama
getEventType()EventTypeTetikleyicinin etkinleştiği etkinlik türünü döndürür.
getHandlerFunction()StringTetikleyici tetiklendiğinde çağrılacak işlevi döndürür.
getTriggerSource()TriggerSourceTetikleyicinin etkinleştirilmesine neden olacak etkinliklerin kaynağını döndürür.
getTriggerSourceId()StringKaynağa özel 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)FormTriggerBuilderBelirtilen kimliğe sahip formla ilişkili 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 ClockTriggerBuilder oluşturur ve döndürür.

TriggerSource

Özellikler

MülkTürAçıklama
SPREADSHEETSEnumGoogle E-Tablolar, tetikleyicinin etkinleşmesine neden olur.
CLOCKEnumZamana dayalı bir etkinlik, tetikleyicinin etkinleştirilmesine neden olur.
FORMSEnumGoogle Formlar, tetikleyicinin etkinleşmesine neden olur.
DOCUMENTSEnumGoogle Dokümanlar, tetikleyicinin etkinleşmesine neden olur.
CALENDAREnumGoogle Takvim, tetikleyicinin etkinleşmesine neden olur.