Script Service

Script

บริการนี้ให้สิทธิ์เข้าถึงทริกเกอร์สคริปต์และการเผยแพร่สคริปต์

คลาส

ชื่อรายละเอียดแบบย่อ
AuthModeการแจงนับที่ระบุหมวดหมู่ของบริการที่ได้รับอนุญาตซึ่ง Apps Script สามารถ เรียกใช้ผ่านฟังก์ชันที่ทริกเกอร์
AuthorizationInfoออบเจ็กต์ที่ตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์สำหรับขอบเขตที่จำเป็นของสคริปต์หรือไม่
AuthorizationStatusการแจงนับที่ระบุสถานะการให้สิทธิ์ของสคริปต์
CalendarTriggerBuilderเครื่องมือสร้างทริกเกอร์ปฏิทิน
ClockTriggerBuilderเครื่องมือสร้างสำหรับทริกเกอร์นาฬิกา
DocumentTriggerBuilderเครื่องมือสร้างสำหรับทริกเกอร์เอกสาร
EventTypeการแจงนับที่ระบุประเภทของเหตุการณ์ที่ทริกเกอร์
FormTriggerBuilderเครื่องมือสร้างทริกเกอร์แบบฟอร์ม
InstallationSourceการแจงนับที่ระบุวิธีการติดตั้งสคริปต์เป็นส่วนเสริมสำหรับผู้ใช้ปัจจุบัน
ScriptAppเข้าถึงและจัดการการเผยแพร่สคริปต์และทริกเกอร์
Serviceเข้าถึงและจัดการการเผยแพร่สคริปต์
SpreadsheetTriggerBuilderเครื่องมือสร้างทริกเกอร์สเปรดชีต
StateTokenBuilderอนุญาตให้สคริปต์สร้างโทเค็นสถานะที่ใช้ใน API เรียกกลับได้ (เช่น โฟลว์ OAuth)
Triggerทริกเกอร์สคริปต์
TriggerBuilderเครื่องมือสร้างทั่วไปสำหรับทริกเกอร์สคริปต์
TriggerSourceการแจงนับที่ระบุแหล่งที่มาของเหตุการณ์ที่ทําให้ทริกเกอร์ทํางาน

AuthMode

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
NONEEnumโหมดที่ไม่อนุญาตให้เข้าถึงบริการใดๆ ที่ต้องมีการให้สิทธิ์
CUSTOM_FUNCTIONEnumโหมดที่อนุญาตให้เข้าถึงบริการบางส่วนแบบจำกัดเพื่อใช้ในฟังก์ชันสเปรดชีตที่กำหนดเอง
LIMITEDEnumโหมดที่อนุญาตให้เข้าถึงบริการบางส่วนแบบจำกัด
FULLEnumโหมดที่อนุญาตให้เข้าถึงบริการทั้งหมดที่ต้องมีการให้สิทธิ์

AuthorizationInfo

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getAuthorizationStatus()AuthorizationStatusรับค่าที่ระบุว่าผู้ใช้ต้องให้สิทธิ์สคริปต์นี้เพื่อใช้บริการอย่างน้อย 1 รายการ (เช่น ScriptApp.AuthorizationStatus.REQUIRED) หรือไม่
getAuthorizationUrl()String|nullรับ URL การให้สิทธิ์ที่ใช้ให้สิทธิ์เข้าถึงสคริปต์ได้
getAuthorizedScopes()String[]|nullรับรายการขอบเขตที่ได้รับอนุญาตสำหรับสคริปต์

AuthorizationStatus

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
REQUIREDEnumผู้ใช้ต้องให้สิทธิ์สคริปต์นี้เพื่อใช้บริการอย่างน้อย 1 รายการ
NOT_REQUIREDEnumผู้ใช้ได้ให้สิทธิ์ทั้งหมดที่สคริปต์นี้ต้องการในปัจจุบันแล้ว

CalendarTriggerBuilder

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
create()Triggerสร้างทริกเกอร์และแสดงผล
onEventUpdated()CalendarTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อมีการสร้าง อัปเดต หรือลบรายการในปฏิทิน

ClockTriggerBuilder

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
after(durationMilliseconds)ClockTriggerBuilderระบุระยะเวลาขั้นต่ำ (เป็นมิลลิวินาที) หลังจากเวลาปัจจุบันที่ทริกเกอร์จะทำงาน
at(date)ClockTriggerBuilderระบุเวลาที่ทริกเกอร์ทำงาน
atDate(year, month, day)ClockTriggerBuilderระบุว่าทริกเกอร์จะเริ่มทำงานในวันที่ที่ระบุ โดยค่าเริ่มต้นจะเริ่มทำงานใกล้กับเวลาเที่ยงคืน (+/- 15 นาที)
atHour(hour)ClockTriggerBuilderระบุชั่วโมงที่ทริกเกอร์ทำงาน
create()Triggerสร้างทริกเกอร์
everyDays(n)ClockTriggerBuilderระบุให้เรียกใช้ทริกเกอร์ทุก n วัน
everyHours(n)ClockTriggerBuilderระบุให้เรียกใช้ทริกเกอร์ทุก n ชั่วโมง
everyMinutes(n)ClockTriggerBuilderระบุให้เรียกใช้ทริกเกอร์ทุกๆ n นาที
everyWeeks(n)ClockTriggerBuilderระบุให้เรียกใช้ทริกเกอร์ทุก n สัปดาห์
inTimezone(timezone)ClockTriggerBuilderระบุเขตเวลาสำหรับวันที่/เวลาที่ระบุเมื่อทริกเกอร์ทำงาน
nearMinute(minute)ClockTriggerBuilderระบุนาทีที่ทริกเกอร์ทำงาน (บวกหรือลบ 15 นาที)
onMonthDay(day)ClockTriggerBuilderระบุวันที่ในเดือนที่จะเรียกใช้ทริกเกอร์
onWeekDay(day)ClockTriggerBuilderระบุวันในสัปดาห์ที่ทริกเกอร์ทำงาน

DocumentTriggerBuilder

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
create()Triggerสร้างและแสดงผลทริกเกอร์ใหม่
onOpen()DocumentTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อเปิดเอกสาร

EventType

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
CLOCKEnumทริกเกอร์จะเริ่มทำงานเมื่อเหตุการณ์ที่อิงตามเวลาถึงเวลาที่กำหนด
ON_OPENEnumทริกเกอร์จะทำงานเมื่อผู้ใช้เปิดไฟล์ Google เอกสาร, ชีต หรือฟอร์ม
ON_EDITEnumทริกเกอร์จะทำงานเมื่อผู้ใช้แก้ไขไฟล์ Google ชีต (เช่น ป้อนค่าใหม่ลงในเซลล์ ซึ่งถือเป็นการแก้ไขแทนการเปลี่ยนแปลง)
ON_FORM_SUBMITEnumทริกเกอร์จะทำงานเมื่อผู้ใช้ตอบแบบฟอร์มของ Google
ON_CHANGEEnumทริกเกอร์จะทำงานเมื่อผู้ใช้เปลี่ยนไฟล์ Google ชีต (เช่น โดยการเพิ่มแถว ซึ่งถือเป็นการเปลี่ยนแปลงแทนการแก้ไข)
ON_EVENT_UPDATEDEnumทริกเกอร์จะทำงานเมื่อมีการสร้าง อัปเดต หรือลบกิจกรรมใน Google ปฏิทินที่ระบุ

FormTriggerBuilder

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
create()Triggerสร้างและแสดงผลทริกเกอร์ใหม่
onFormSubmit()FormTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อมีการส่งคำตอบไปยังแบบฟอร์ม
onOpen()FormTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อเปิดมุมมองแก้ไขของแบบฟอร์ม

InstallationSource

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumผู้ดูแลระบบติดตั้งส่วนเสริมสำหรับโดเมนของผู้ใช้
NONEEnumสคริปต์ไม่ได้ทำงานเป็นส่วนเสริม
WEB_STORE_ADD_ONEnumผู้ใช้ติดตั้งส่วนเสริมจาก Chrome เว็บสโตร์

ScriptApp

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
AuthModeAuthModeการแจงนับที่ระบุหมวดหมู่ของบริการที่ได้รับอนุญาตซึ่ง Apps Script สามารถ เรียกใช้ผ่านฟังก์ชันที่ทริกเกอร์
AuthorizationStatusAuthorizationStatusการแจงนับที่ระบุสถานะการให้สิทธิ์ของสคริปต์
EventTypeEventTypeการแจงนับที่ระบุประเภทของเหตุการณ์ที่ทริกเกอร์
InstallationSourceInstallationSourceการแจงนับที่ระบุวิธีการติดตั้งสคริปต์ให้กับผู้ใช้ในรูปแบบของส่วนเสริม
TriggerSourceTriggerSourceการแจงนับที่ระบุแหล่งที่มาของเหตุการณ์ที่ทําให้ทริกเกอร์ทํางาน
WeekDayWeekdayการแจงนับที่แสดงวันในสัปดาห์

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
deleteTrigger(trigger)voidนำทริกเกอร์ที่ระบุออกเพื่อไม่ให้ทำงานอีกต่อไป
getAuthorizationInfo(authMode)AuthorizationInfoรับออบเจ็กต์ที่ตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์สำหรับข้อกำหนดของสคริปต์ทั้งหมดหรือไม่
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoรับออบเจ็กต์ที่ตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์สำหรับขอบเขตที่ขอหรือไม่
getIdentityToken()String|nullรับโทเค็นข้อมูลประจำตัว OpenID Connect สำหรับ ผู้ใช้ที่มีประสิทธิภาพ หากได้รับขอบเขต openid
getInstallationSource()InstallationSourceแสดงค่า Enum ที่ระบุวิธีติดตั้งสคริปต์เป็นส่วนเสริมสำหรับ ผู้ใช้ปัจจุบัน (เช่น ผู้ใช้ติดตั้งด้วยตนเองผ่าน Chrome เว็บสโตร์ หรือผู้ดูแลระบบโดเมนติดตั้งให้ผู้ใช้ทั้งหมด)
getOAuthToken()Stringรับโทเค็น การเข้าถึง OAuth 2.0 สำหรับผู้ใช้ที่มีผล
getProjectTriggers()Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดที่เชื่อมโยงกับโปรเจ็กต์ปัจจุบันและผู้ใช้ปัจจุบัน
getScriptId()Stringรับรหัสที่ไม่ซ้ำกันของโปรเจ็กต์สคริปต์
getService()Serviceรับออบเจ็กต์ที่ใช้เพื่อควบคุมการเผยแพร่สคริปต์เป็นเว็บแอป
getUserTriggers(document)Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดซึ่งผู้ใช้เป็นเจ้าของในเอกสารที่ระบุ สำหรับสคริปต์หรือส่วนเสริมนี้เท่านั้น
getUserTriggers(form)Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดซึ่งผู้ใช้เป็นเจ้าของในแบบฟอร์มที่ระบุ สำหรับสคริปต์หรือส่วนเสริมนี้เท่านั้น
getUserTriggers(spreadsheet)Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดซึ่งผู้ใช้เป็นเจ้าของในสเปรดชีตที่ระบุ สำหรับสคริปต์หรือส่วนเสริมนี้เท่านั้น
invalidateAuth()voidยกเลิกการให้สิทธิ์ที่ผู้ใช้ที่มีผลบังคับใช้มีในการเรียกใช้สคริปต์ปัจจุบัน
newStateToken()StateTokenBuilderสร้างเครื่องมือสร้างโทเค็นสถานะที่ใช้ใน API เรียกกลับได้ (เช่น โฟลว์ OAuth)
newTrigger(functionName)TriggerBuilderเริ่มกระบวนการสร้างทริกเกอร์ที่ติดตั้งได้ ซึ่งจะเรียกฟังก์ชันที่ระบุเมื่อทริกเกอร์ทำงาน
requireAllScopes(authMode)voidตรวจสอบว่าผู้ใช้ได้ให้ความยินยอมสำหรับขอบเขตทั้งหมดที่สคริปต์ร้องขอหรือไม่
requireScopes(authMode, oAuthScopes)voidตรวจสอบว่าผู้ใช้ให้ความยินยอมสำหรับขอบเขตที่ขอหรือไม่

Service

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getUrl()Stringแสดง URL ของเว็บแอปหากมีการติดตั้งใช้งานแล้ว หรือแสดง null หากไม่มีการติดตั้งใช้งาน
isEnabled()Booleanแสดง true หากเข้าถึงสคริปต์เป็นเว็บแอปได้

SpreadsheetTriggerBuilder

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
create()Triggerสร้างทริกเกอร์และแสดงผล
onChange()SpreadsheetTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อมีการเปลี่ยนแปลงเนื้อหาหรือโครงสร้างของสเปรดชีต
onEdit()SpreadsheetTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อมีการแก้ไขสเปรดชีต
onFormSubmit()SpreadsheetTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อมีการส่งแบบฟอร์มไปยังสเปรดชีต
onOpen()SpreadsheetTriggerBuilderระบุทริกเกอร์ที่จะเริ่มทำงานเมื่อเปิดสเปรดชีต

StateTokenBuilder

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
createToken()Stringสร้างการแสดงสตริงที่เข้ารหัสของโทเค็นสถานะ
withArgument(name, value)StateTokenBuilderเพิ่มอาร์กิวเมนต์ลงในโทเค็น
withMethod(method)StateTokenBuilderตั้งค่าฟังก์ชัน Callback
withTimeout(seconds)StateTokenBuilderตั้งค่าระยะเวลา (เป็นวินาที) ที่โทเค็นใช้งานได้

Trigger

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getEventType()EventTypeแสดงประเภทเหตุการณ์ที่ทริกเกอร์เริ่มทำงาน
getHandlerFunction()Stringแสดงผลฟังก์ชันที่จะเรียกใช้เมื่อทริกเกอร์ทำงาน
getTriggerSource()TriggerSourceแสดงผลแหล่งที่มาของเหตุการณ์ที่จะทําให้ทริกเกอร์เริ่มทํางาน
getTriggerSourceId()Stringแสดงรหัสที่เฉพาะเจาะจงกับแหล่งที่มา
getUniqueId()Stringแสดงตัวระบุที่ไม่ซ้ำกันซึ่งใช้แยกความแตกต่างระหว่างทริกเกอร์ได้

TriggerBuilder

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
forDocument(document)DocumentTriggerBuilderสร้างและแสดงผล DocumentTriggerBuilder ที่เชื่อมโยงกับเอกสารที่ระบุ
forDocument(key)DocumentTriggerBuilderสร้างและแสดง DocumentTriggerBuilder ที่เชื่อมโยงกับเอกสารที่มีรหัสที่ระบุ
forForm(form)FormTriggerBuilderสร้างและแสดงผล FormTriggerBuilder ที่เชื่อมโยงกับแบบฟอร์มที่ระบุ
forForm(key)FormTriggerBuilderสร้างและแสดง FormTriggerBuilder ที่เชื่อมโยงกับแบบฟอร์มที่มีรหัสที่ระบุ
forSpreadsheet(sheet)SpreadsheetTriggerBuilderสร้างและแสดงผล SpreadsheetTriggerBuilder ที่เชื่อมโยงกับสเปรดชีตที่ระบุ
forSpreadsheet(key)SpreadsheetTriggerBuilderสร้างและแสดงผล SpreadsheetTriggerBuilder ที่เชื่อมโยงกับสเปรดชีตที่มีรหัสที่ระบุ
forUserCalendar(emailId)CalendarTriggerBuilderแสดงผลเครื่องมือสร้างสำหรับการสร้างทริกเกอร์ปฏิทิน
timeBased()ClockTriggerBuilderสร้างและแสดงผล ClockTriggerBuilder สำหรับสร้างทริกเกอร์ตามเวลา

TriggerSource

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
SPREADSHEETSEnumGoogle ชีตทำให้ทริกเกอร์เริ่มทำงาน
CLOCKEnumเหตุการณ์ที่อิงตามเวลาจะทําให้ทริกเกอร์เริ่มทํางาน
FORMSEnumGoogle ฟอร์มทำให้ทริกเกอร์ทำงาน
DOCUMENTSEnumGoogle เอกสารทำให้ทริกเกอร์เริ่มทำงาน
CALENDAREnumGoogle ปฏิทินทำให้ทริกเกอร์ทำงาน