Script Service

สคริปต์

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

ชั้นเรียน

ชื่อรายละเอียดแบบย่อ
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 ฟอร์ม
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ตั้งค่าฟังก์ชันเรียกกลับ
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 ปฏิทินจะทําให้ทริกเกอร์เริ่มทํางาน