Script Service

Script

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

ชั้นเรียน

ชื่อรายละเอียดแบบย่อ
AuthModeการแจกแจงที่ระบุหมวดหมู่ของบริการที่ได้รับอนุญาตซึ่ง Apps Script สามารถดำเนินการผ่านฟังก์ชันที่ทริกเกอร์
AuthorizationInfoออบเจ็กต์ที่ใช้เพื่อระบุว่าผู้ใช้ต้องให้สิทธิ์สคริปต์นี้เพื่อใช้บริการอย่างน้อย 1 อย่างหรือไม่ และเพื่อระบุ URL สําหรับกล่องโต้ตอบการให้สิทธิ์
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รับ URL การให้สิทธิ์ที่สามารถใช้เพื่อมอบสิทธิ์เข้าถึงสคริปต์

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 Forms
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รับออบเจ็กต์ที่ใช้เพื่อระบุว่าผู้ใช้ต้องให้สิทธิ์สคริปต์นี้เพื่อใช้บริการอย่างน้อย 1 รายการหรือไม่ และเพื่อระบุ URL สําหรับกล่องโต้ตอบการให้สิทธิ์
getIdentityToken()Stringรับโทเค็นข้อมูลประจำตัว 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เริ่มกระบวนการสร้างทริกเกอร์ที่ติดตั้งได้ ซึ่งจะเรียกใช้ฟังก์ชันหนึ่งๆ เมื่อทริกเกอร์ทำงาน

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 ปฏิทินทริกเกอร์ให้ทำงาน