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