บริการนี้ทําให้เข้าถึงทริกเกอร์สคริปต์และการเผยแพร่สคริปต์ได้
ชั้นเรียน
| ชื่อ | รายละเอียดแบบย่อ |
|---|---|
AuthMode | การแจกแจง ซึ่งระบุว่าหมวดหมู่ใดของบริการ Apps Script ที่ได้รับอนุญาต สามารถเรียกใช้ผ่านฟังก์ชันที่ทริกเกอร์ |
AuthorizationInfo | ออบเจ็กต์ที่ใช้ในการกําหนดว่าผู้ใช้ต้องให้สิทธิ์สคริปต์นี้ใช้บริการอย่างน้อย 1 รายการหรือไม่ และระบุ URL ของกล่องโต้ตอบการให้สิทธิ์ |
AuthorizationStatus | การแจกแจงที่แสดงถึงสถานะการอนุมัติของสคริปต์ |
CalendarTriggerBuilder | เครื่องมือสร้างสําหรับทริกเกอร์ปฏิทิน |
ClockTriggerBuilder | เครื่องมือสร้างทริกเกอร์นาฬิกา |
DocumentTriggerBuilder | เครื่องมือสร้างทริกเกอร์เอกสาร |
EventType | การแจกแจงที่แสดงถึงประเภทเหตุการณ์ที่ทริกเกอร์ |
FormTriggerBuilder | เครื่องมือสร้างทริกเกอร์แบบฟอร์ม |
InstallationSource | การแจงนับที่ระบุว่าจะติดตั้งสคริปต์เป็นส่วนเสริมของผู้ใช้ปัจจุบันอย่างไร |
ScriptApp | เข้าถึงและจัดการการเผยแพร่สคริปต์และทริกเกอร์ |
Service | เข้าถึงและจัดการการเผยแพร่สคริปต์ |
SpreadsheetTriggerBuilder | เครื่องมือสร้างสําหรับทริกเกอร์สเปรดชีต |
StateTokenBuilder | อนุญาตให้สคริปต์สร้างโทเค็นสถานะที่สามารถใช้ใน API โค้ดเรียกกลับ (เช่น ขั้นตอน OAuth) |
Trigger | ทริกเกอร์สคริปต์ |
TriggerBuilder | เครื่องมือสร้างทั่วไปสําหรับทริกเกอร์สคริปต์ |
TriggerSource | การแจกแจงที่แสดงถึงแหล่งที่มาของเหตุการณ์ที่ทําให้ทริกเกอร์เริ่มทํางาน |
AuthMode
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
NONE | Enum | โหมดที่ไม่อนุญาตให้เข้าถึงบริการใดๆ ที่ต้องมีการให้สิทธิ์ |
CUSTOM_FUNCTION | Enum | โหมดที่อนุญาตให้เข้าถึงบริการย่อยบางส่วนเพื่อใช้ในฟังก์ชันสเปรดชีตที่กําหนดเอง |
LIMITED | Enum | โหมดที่ให้สิทธิ์เข้าถึงกลุ่มย่อยของบริการที่จํากัด |
FULL | Enum | โหมดที่อนุญาตให้เข้าถึงบริการทั้งหมดที่ต้องให้สิทธิ์ |
AuthorizationInfo
เมธอด
| วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
|---|---|---|
getAuthorizationStatus() | AuthorizationStatus | ได้รับค่าที่บอกว่าผู้ใช้ต้องให้สิทธิ์สคริปต์นี้ใช้บริการอย่างน้อย 1 รายการหรือไม่ (เช่น ScriptApp.AuthorizationStatus.REQUIRED) |
getAuthorizationUrl() | String | รับ URL การให้สิทธิ์ที่ใช้ให้สิทธิ์เข้าถึงสคริปต์ได้ |
AuthorizationStatus
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
REQUIRED | Enum | ผู้ใช้ต้องให้สิทธิ์สคริปต์นี้ในการใช้อย่างน้อย 1 บริการ |
NOT_REQUIRED | Enum | ผู้ใช้ให้สิทธิ์สคริปต์นี้ทั้งหมดที่จําเป็นในปัจจุบันแล้ว |
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
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
CLOCK | Enum | ทริกเกอร์จะเริ่มทํางานเมื่อเหตุการณ์ตามเวลาเกิดขึ้นในเวลาที่เฉพาะเจาะจง |
ON_OPEN | Enum | ทริกเกอร์จะเริ่มทํางานเมื่อผู้ใช้เปิดไฟล์ Google เอกสาร ชีต หรือฟอร์ม |
ON_EDIT | Enum | ทริกเกอร์จะเริ่มทํางานเมื่อผู้ใช้แก้ไขไฟล์ Google ชีต (เช่น การป้อนค่าใหม่ลงในเซลล์ ซึ่งจะนับเป็นการแก้ไข ไม่ใช่การเปลี่ยนแปลง) |
ON_FORM_SUBMIT | Enum | ทริกเกอร์จะเริ่มทํางานเมื่อผู้ใช้ตอบกลับแบบฟอร์มใน Google ฟอร์ม |
ON_CHANGE | Enum | ทริกเกอร์จะเริ่มทํางานเมื่อผู้ใช้เปลี่ยนไฟล์ Google ชีต (เช่น โดยการเพิ่มแถว ซึ่งจะนับเป็นการเปลี่ยนแปลง ไม่ใช่การแก้ไข) |
ON_EVENT_UPDATED | Enum | ทริกเกอร์จะเริ่มทํางานเมื่อมีการสร้าง อัปเดต หรือลบกิจกรรมใน Google ปฏิทินที่ระบุ |
FormTriggerBuilder
เมธอด
| วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
|---|---|---|
create() | Trigger | สร้างและแสดงผลทริกเกอร์ใหม่ |
onFormSubmit() | FormTriggerBuilder | ระบุทริกเกอร์ที่จะเริ่มทํางานเมื่อมีการส่งคําตอบไปยังแบบฟอร์ม |
onOpen() | FormTriggerBuilder | ระบุทริกเกอร์ที่จะเริ่มทํางานเมื่อมีการเปิดมุมมองการแก้ไขของแบบฟอร์ม |
InstallationSource
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
APPS_MARKETPLACE_DOMAIN_ADD_ON | Enum | ผู้ดูแลระบบติดตั้งส่วนเสริมสําหรับโดเมนของผู้ใช้แล้ว |
NONE | Enum | สคริปต์ไม่ทํางานเป็นส่วนเสริม |
WEB_STORE_ADD_ON | Enum | ผู้ใช้ติดตั้งส่วนเสริมจาก Chrome เว็บสโตร์ |
ScriptApp
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
AuthMode | AuthMode | การแจกแจง ซึ่งระบุว่าหมวดหมู่ใดของบริการ Apps Script ที่ได้รับอนุญาต สามารถเรียกใช้ผ่านฟังก์ชันที่ทริกเกอร์ |
AuthorizationStatus | AuthorizationStatus | การแจกแจงที่แสดงถึงสถานะการอนุมัติของสคริปต์ |
EventType | EventType | การแจกแจงที่แสดงถึงประเภทเหตุการณ์ที่ทริกเกอร์ |
InstallationSource | InstallationSource | การแจกแจงที่แสดงถึงวิธีการติดตั้งสคริปต์ให้กับผู้ใช้เป็นส่วนเสริม |
TriggerSource | TriggerSource | การแจกแจงที่แสดงถึงแหล่งที่มาของเหตุการณ์ที่ทําให้ทริกเกอร์เริ่มทํางาน |
WeekDay | Weekday | การแจกแจงการแจกแจงวันของสัปดาห์ |
เมธอด
| วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
|---|---|---|
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
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
SPREADSHEETS | Enum | Google ชีตจะทําให้ทริกเกอร์เริ่มทํางาน |
CLOCK | Enum | เหตุการณ์ที่ขับเคลื่อนด้วยเวลาทําให้ทริกเกอร์เริ่มทํางาน |
FORMS | Enum | Google ฟอร์มจะทําให้ทริกเกอร์เริ่มทํางาน |
DOCUMENTS | Enum | Google เอกสารจะทําให้ทริกเกอร์เริ่มทํางาน |
CALENDAR | Enum | Google ปฏิทินจะทําให้ทริกเกอร์เริ่มทํางาน |