Script Service

Script

Layanan ini menyediakan akses ke pemicu skrip dan publikasi skrip.

Class

NamaDeskripsi singkat
AuthModeEnumerasi yang mengidentifikasi kategori layanan resmi yang dapat dieksekusi Apps Script melalui fungsi yang dipicu.
AuthorizationInfoObjek yang memeriksa apakah pengguna telah memberikan otorisasi untuk cakupan skrip yang diperlukan.
AuthorizationStatusEnumerasi yang menunjukkan status otorisasi skrip.
CalendarTriggerBuilderBuilder untuk pemicu kalender.
ClockTriggerBuilderBuilder untuk pemicu waktu.
DocumentTriggerBuilderBuilder untuk pemicu dokumen.
EventTypeEnumerasi yang menunjukkan jenis peristiwa yang dipicu.
FormTriggerBuilderBuilder untuk pemicu formulir.
InstallationSourceEnumerasi yang menunjukkan cara skrip diinstal sebagai add-on untuk pengguna saat ini.
ScriptAppMengakses dan memanipulasi publikasi dan pemicu skrip.
ServiceMengakses dan memanipulasi publikasi skrip.
SpreadsheetTriggerBuilderBuilder untuk pemicu spreadsheet.
StateTokenBuilderMengizinkan skrip membuat token status yang dapat digunakan di API callback (seperti alur OAuth).
TriggerPemicu skrip.
TriggerBuilderBuilder generik untuk pemicu skrip.
TriggerSourceEnumerasi yang menunjukkan sumber peristiwa yang menyebabkan pemicu diaktifkan.

AuthMode

Properti

PropertiJenisDeskripsi
NONEEnumMode yang tidak mengizinkan akses ke layanan apa pun yang memerlukan otorisasi.
CUSTOM_FUNCTIONEnumMode yang memungkinkan akses ke sebagian kecil layanan untuk digunakan dalam fungsi spreadsheet kustom.
LIMITEDEnumMode yang memungkinkan akses ke sebagian kecil layanan.
FULLEnumMode yang memungkinkan akses ke semua layanan yang memerlukan otorisasi.

AuthorizationInfo

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getAuthorizationStatus()AuthorizationStatusMendapatkan nilai yang menunjukkan apakah pengguna perlu mengizinkan skrip ini untuk menggunakan satu atau beberapa layanan (misalnya, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()String|nullMendapatkan URL otorisasi yang dapat digunakan untuk memberikan akses ke skrip.
getAuthorizedScopes()String[]|nullMendapatkan daftar cakupan yang diizinkan untuk skrip.

AuthorizationStatus

Properti

PropertiJenisDeskripsi
REQUIREDEnumPengguna harus mengizinkan skrip ini untuk menggunakan satu atau beberapa layanan.
NOT_REQUIREDEnumPengguna telah memberikan semua otorisasi yang saat ini diperlukan oleh skrip ini.

CalendarTriggerBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
create()TriggerMembuat pemicu dan menampilkannya.
onEventUpdated()CalendarTriggerBuilderMenentukan pemicu yang diaktifkan saat entri kalender dibuat, diperbarui, atau dihapus.

ClockTriggerBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
after(durationMilliseconds)ClockTriggerBuilderMenentukan durasi minimum (dalam milidetik) setelah waktu saat ini saat pemicu berjalan.
at(date)ClockTriggerBuilderMenentukan waktu pemicu berjalan.
atDate(year, month, day)ClockTriggerBuilderMenentukan bahwa pemicu diaktifkan pada tanggal yang ditentukan, secara default mendekati tengah malam (+/- 15 menit).
atHour(hour)ClockTriggerBuilderMenentukan jam pemicu dijalankan.
create()TriggerMembuat pemicu.
everyDays(n)ClockTriggerBuilderMenentukan untuk menjalankan pemicu setiap n hari.
everyHours(n)ClockTriggerBuilderMenentukan untuk menjalankan pemicu setiap n jam.
everyMinutes(n)ClockTriggerBuilderMenentukan untuk menjalankan pemicu setiap n menit.
everyWeeks(n)ClockTriggerBuilderMenentukan untuk menjalankan pemicu setiap n minggu.
inTimezone(timezone)ClockTriggerBuilderMenentukan zona waktu untuk tanggal/waktu yang ditentukan saat pemicu berjalan.
nearMinute(minute)ClockTriggerBuilderMenentukan menit saat pemicu berjalan (plus atau minus 15 menit).
onMonthDay(day)ClockTriggerBuilderMenentukan tanggal dalam bulan saat pemicu berjalan.
onWeekDay(day)ClockTriggerBuilderMenentukan hari dalam seminggu saat pemicu berjalan.

DocumentTriggerBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
create()TriggerMembuat dan menampilkan pemicu baru.
onOpen()DocumentTriggerBuilderMenentukan pemicu yang akan diaktifkan saat dokumen dibuka.

EventType

Properti

PropertiJenisDeskripsi
CLOCKEnumPemicu diaktifkan setelah peristiwa berbasis waktu mencapai waktu tertentu.
ON_OPENEnumPemicu diaktifkan setelah pengguna membuka file Google Dokumen, Spreadsheet, atau Formulir.
ON_EDITEnumPemicu akan diaktifkan setelah pengguna mengedit file Google Spreadsheet (misalnya, dengan memasukkan nilai baru ke dalam sel, yang dihitung sebagai pengeditan, bukan perubahan).
ON_FORM_SUBMITEnumPemicu diaktifkan setelah pengguna merespons Google Formulir.
ON_CHANGEEnumPemicu akan diaktifkan setelah pengguna mengubah file Google Spreadsheet (misalnya, dengan menambahkan baris, yang dihitung sebagai perubahan, bukan pengeditan).
ON_EVENT_UPDATEDEnumPemicu diaktifkan setelah acara dibuat, diperbarui, atau dihapus di Google Kalender yang ditentukan.

FormTriggerBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
create()TriggerMembuat dan menampilkan pemicu baru.
onFormSubmit()FormTriggerBuilderMenentukan pemicu yang akan diaktifkan saat respons dikirimkan ke formulir.
onOpen()FormTriggerBuilderMenentukan pemicu yang akan diaktifkan saat tampilan edit formulir dibuka.

InstallationSource

Properti

PropertiJenisDeskripsi
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumAdd-on diinstal oleh administrator untuk domain pengguna.
NONEEnumSkrip tidak berjalan sebagai add-on.
WEB_STORE_ADD_ONEnumAdd-on diinstal oleh pengguna dari Chrome Web Store.

ScriptApp

Properti

PropertiJenisDeskripsi
AuthModeAuthModeEnumerasi yang mengidentifikasi kategori layanan resmi yang dapat dieksekusi Apps Script melalui fungsi yang dipicu.
AuthorizationStatusAuthorizationStatusEnumerasi yang menunjukkan status otorisasi skrip.
EventTypeEventTypeEnumerasi yang menunjukkan jenis peristiwa yang dipicu.
InstallationSourceInstallationSourceEnumerasi yang menunjukkan cara skrip diinstal ke pengguna sebagai add-on.
TriggerSourceTriggerSourceEnumerasi yang menunjukkan sumber peristiwa yang menyebabkan pemicu diaktifkan.
WeekDayWeekdayEnumerasi yang merepresentasikan hari dalam seminggu.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
deleteTrigger(trigger)voidMenghapus pemicu tertentu sehingga tidak lagi berjalan.
getAuthorizationInfo(authMode)AuthorizationInfoMendapatkan objek yang memeriksa apakah pengguna telah memberikan otorisasi untuk semua persyaratan skrip.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoMendapatkan objek yang memeriksa apakah pengguna telah memberikan otorisasi untuk cakupan yang diminta.
getIdentityToken()String|nullMendapatkan token identitas OpenID Connect untuk pengguna efektif, jika cakupan openid telah diberikan.
getInstallationSource()InstallationSourceMenampilkan nilai enum yang menunjukkan cara skrip diinstal sebagai add-on untuk pengguna saat ini (misalnya, apakah pengguna menginstalnya secara pribadi melalui Chrome Web Store, atau apakah administrator domain menginstalnya untuk semua pengguna).
getOAuthToken()StringMendapatkan token akses OAuth 2.0 untuk pengguna yang efektif.
getProjectTriggers()Trigger[]Mendapatkan semua pemicu yang dapat diinstal yang terkait dengan project saat ini dan pengguna saat ini.
getScriptId()StringMendapatkan ID unik project skrip.
getService()ServiceMendapatkan objek yang digunakan untuk mengontrol publikasi skrip sebagai aplikasi web.
getUserTriggers(document)Trigger[]Mendapatkan semua pemicu yang dapat diinstal yang dimiliki oleh pengguna ini dalam dokumen tertentu, hanya untuk skrip atau add-on ini.
getUserTriggers(form)Trigger[]Mendapatkan semua pemicu yang dapat diinstal yang dimiliki oleh pengguna ini dalam formulir tertentu, hanya untuk skrip atau add-on ini.
getUserTriggers(spreadsheet)Trigger[]Mendapatkan semua pemicu yang dapat diinstal yang dimiliki oleh pengguna ini di spreadsheet tertentu, hanya untuk skrip atau add-on ini.
invalidateAuth()voidMembatalkan otorisasi yang dimiliki pengguna efektif untuk menjalankan skrip saat ini.
newStateToken()StateTokenBuilderMembuat builder untuk token status yang dapat digunakan di API callback (seperti alur OAuth).
newTrigger(functionName)TriggerBuilderMemulai proses pembuatan pemicu yang dapat diinstal yang, saat dipicu, memanggil fungsi tertentu.
requireAllScopes(authMode)voidMemvalidasi apakah pengguna telah memberikan izin untuk semua cakupan yang diminta oleh skrip.
requireScopes(authMode, oAuthScopes)voidMemvalidasi apakah pengguna telah memberikan izin untuk cakupan yang diminta.

Service

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getUrl()StringMenampilkan URL aplikasi web, jika telah di-deploy; jika tidak, menampilkan null.
isEnabled()BooleanMenampilkan true jika skrip dapat diakses sebagai aplikasi web.

SpreadsheetTriggerBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
create()TriggerMembuat pemicu dan menampilkannya.
onChange()SpreadsheetTriggerBuilderMenentukan pemicu yang akan diaktifkan saat konten atau struktur spreadsheet diubah.
onEdit()SpreadsheetTriggerBuilderMenentukan pemicu yang akan diaktifkan saat spreadsheet diedit.
onFormSubmit()SpreadsheetTriggerBuilderMenentukan pemicu yang akan diaktifkan saat spreadsheet memiliki formulir yang dikirimkan ke dalamnya.
onOpen()SpreadsheetTriggerBuilderMenentukan pemicu yang akan diaktifkan saat spreadsheet dibuka.

StateTokenBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
createToken()StringMembangun representasi string terenkripsi dari token status.
withArgument(name, value)StateTokenBuilderMenambahkan argumen ke token.
withMethod(method)StateTokenBuilderMenetapkan fungsi callback.
withTimeout(seconds)StateTokenBuilderMenetapkan durasi (dalam detik) validitas token.

Trigger

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getEventType()EventTypeMenampilkan jenis peristiwa yang memicu pemicu.
getHandlerFunction()StringMenampilkan fungsi yang akan dipanggil saat pemicu diaktifkan.
getTriggerSource()TriggerSourceMenampilkan sumber peristiwa yang akan menyebabkan pemicu diaktifkan.
getTriggerSourceId()StringMenampilkan ID khusus untuk sumber.
getUniqueId()StringMenampilkan ID unik yang dapat digunakan untuk membedakan pemicu satu sama lain.

TriggerBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
forDocument(document)DocumentTriggerBuilderMembuat dan menampilkan DocumentTriggerBuilder yang terkait dengan dokumen tertentu.
forDocument(key)DocumentTriggerBuilderMembuat dan menampilkan DocumentTriggerBuilder yang terkait dengan dokumen dengan ID yang diberikan.
forForm(form)FormTriggerBuilderMembuat dan menampilkan FormTriggerBuilder yang terkait dengan formulir yang diberikan.
forForm(key)FormTriggerBuilderMembuat dan menampilkan FormTriggerBuilder yang terkait dengan formulir dengan ID yang diberikan.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderMembuat dan menampilkan SpreadsheetTriggerBuilder yang terkait dengan spreadsheet tertentu.
forSpreadsheet(key)SpreadsheetTriggerBuilderMembuat dan menampilkan SpreadsheetTriggerBuilder yang terkait dengan spreadsheet dengan ID yang diberikan.
forUserCalendar(emailId)CalendarTriggerBuilderMenampilkan builder untuk membuat pemicu kalender.
timeBased()ClockTriggerBuilderMembuat dan menampilkan ClockTriggerBuilder untuk membuat pemicu berbasis waktu.

TriggerSource

Properti

PropertiJenisDeskripsi
SPREADSHEETSEnumGoogle Spreadsheet menyebabkan pemicu diaktifkan.
CLOCKEnumPeristiwa yang didorong waktu menyebabkan pemicu diaktifkan.
FORMSEnumGoogle Formulir menyebabkan pemicu diaktifkan.
DOCUMENTSEnumGoogle Dokumen menyebabkan pemicu diaktifkan.
CALENDAREnumGoogle Kalender menyebabkan pemicu diaktifkan.