แสดงปฏิทินที่ผู้ใช้เป็นเจ้าของหรือติดตาม
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
createAllDayEvent(title, date) | CalendarEvent | สร้างกิจกรรมใหม่ตลอดทั้งวัน |
createAllDayEvent(title, startDate, endDate) | CalendarEvent | สร้างกิจกรรมที่เกิดขึ้นตลอดวันใหม่ที่ครอบคลุมเวลาหลายวันได้ |
createAllDayEvent(title, startDate, endDate, options) | CalendarEvent | สร้างกิจกรรมที่เกิดขึ้นตลอดวันใหม่ที่ครอบคลุมเวลาหลายวันได้ |
createAllDayEvent(title, date, options) | CalendarEvent | สร้างกิจกรรมใหม่ตลอดทั้งวัน |
createAllDayEventSeries(title, startDate, recurrence) | CalendarEventSeries | สร้างชุดกิจกรรมใหม่สําหรับทั้งวัน |
createAllDayEventSeries(title, startDate, recurrence, options) | CalendarEventSeries | สร้างชุดกิจกรรมใหม่สําหรับทั้งวัน |
createEvent(title, startTime, endTime) | CalendarEvent | สร้างกิจกรรมใหม่ |
createEvent(title, startTime, endTime, options) | CalendarEvent | สร้างกิจกรรมใหม่ |
createEventFromDescription(description) | CalendarEvent | สร้างกิจกรรมจากคําอธิบายรูปแบบอิสระ |
createEventSeries(title, startTime, endTime, recurrence) | CalendarEventSeries | สร้างชุดเหตุการณ์ใหม่ |
createEventSeries(title, startTime, endTime, recurrence, options) | CalendarEventSeries | สร้างชุดเหตุการณ์ใหม่ |
deleteCalendar() | void | ลบปฏิทินถาวร |
getColor() | String | รับข้อมูลสีของปฏิทิน |
getDescription() | String | รับคําอธิบายปฏิทิน |
getEventById(iCalId) | CalendarEvent | รับเหตุการณ์ด้วยรหัสที่กําหนด |
getEventSeriesById(iCalId) | CalendarEventSeries | รับชุดกิจกรรมด้วยรหัสที่ระบุ |
getEvents(startTime, endTime) | CalendarEvent[] | รับเหตุการณ์ทั้งหมดที่เกิดขึ้นภายในช่วงเวลาที่ระบุ |
getEvents(startTime, endTime, options) | CalendarEvent[] | รับเหตุการณ์ทั้งหมดที่เกิดขึ้นภายในช่วงเวลาที่กําหนดและตรงตามเกณฑ์ที่ระบุ |
getEventsForDay(date) | CalendarEvent[] | รับเหตุการณ์ทั้งหมดที่เกิดขึ้นในวันที่ระบุ |
getEventsForDay(date, options) | CalendarEvent[] | รับเหตุการณ์ทั้งหมดที่เกิดขึ้นในวันที่ที่ระบุและตรงตามเกณฑ์ที่ระบุ |
getId() | String | รับรหัสปฏิทิน |
getName() | String | ดาวน์โหลดชื่อปฏิทิน |
getTimeZone() | String | รับเขตเวลาของปฏิทิน |
isHidden() | Boolean | ระบุว่าปฏิทินซ่อนอยู่ในอินเทอร์เฟซผู้ใช้หรือไม่ |
isMyPrimaryCalendar() | Boolean | ระบุว่าปฏิทินเป็นปฏิทินเริ่มต้นสําหรับผู้ใช้ที่มีประสิทธิภาพหรือไม่ |
isOwnedByMe() | Boolean | ระบุว่าผู้ใช้ที่มีสิทธิ์เป็นเจ้าของปฏิทินหรือไม่ |
isSelected() | Boolean | กําหนดว่าจะแสดงกิจกรรมในปฏิทินในอินเทอร์เฟซผู้ใช้หรือไม่ |
setColor(color) | Calendar | ตั้งค่าสีปฏิทิน |
setDescription(description) | Calendar | ตั้งค่าคําอธิบายปฏิทิน |
setHidden(hidden) | Calendar | ตั้งค่าว่าจะให้ปฏิทินปรากฏในอินเทอร์เฟซผู้ใช้หรือไม่ |
setName(name) | Calendar | ตั้งชื่อปฏิทิน |
setSelected(selected) | Calendar | ตั้งค่าว่ากิจกรรมในปฏิทินจะปรากฏในอินเทอร์เฟซผู้ใช้หรือไม่ |
setTimeZone(timeZone) | Calendar | ตั้งค่าเขตเวลาของปฏิทิน |
unsubscribeFromCalendar() | void | ยกเลิกการสมัครรับอีเมลของผู้ใช้ |
เอกสารโดยละเอียด
createAllDayEvent(title, date)
สร้างกิจกรรมใหม่ตลอดทั้งวัน
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969')); Logger.log('Event ID: ' + event.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ |
date | Date | วันที่ของเหตุการณ์ (ระบบจะนับเฉพาะวัน และเวลาจะไม่มีผล) |
ไปกลับ
CalendarEvent
— กิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
สร้างกิจกรรมที่เกิดขึ้นตลอดวันใหม่ที่ครอบคลุมเวลาหลายวันได้
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969')); Logger.log('Event ID: ' + event.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ |
startDate | Date | วันที่กิจกรรมเริ่มต้น (โดยจะใช้เฉพาะวันและไม่สนใจเวลา) |
endDate | Date | วันที่กิจกรรมสิ้นสุด (ใช้วันเท่านั้น และไม่สนใจเวลา) วันที่สิ้นสุดไม่รวมอยู่ |
ไปกลับ
CalendarEvent
— กิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
สร้างกิจกรรมที่เกิดขึ้นตลอดวันใหม่ที่ครอบคลุมเวลาหลายวันได้
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}); Logger.log('Event ID: ' + event.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ |
startDate | Date | วันที่กิจกรรมเริ่มต้น (โดยจะใช้เฉพาะวันและไม่สนใจเวลา) |
endDate | Date | วันที่กิจกรรมสิ้นสุด (ใช้วันเท่านั้น และไม่สนใจเวลา) วันที่สิ้นสุดไม่รวมอยู่ |
options | Object | ออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง |
พารามิเตอร์ขั้นสูง
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
description | String | คําอธิบายกิจกรรม |
location | String | สถานที่จัดกิจกรรม |
guests | String | รายชื่ออีเมลที่คั่นด้วยคอมมาซึ่งควรเพิ่มเป็นผู้เข้าร่วม |
sendInvites | Boolean | ต้องการส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: false ) |
ไปกลับ
CalendarEvent
— กิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
สร้างกิจกรรมใหม่ตลอดทั้งวัน
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ |
date | Date | วันที่ของเหตุการณ์ (ระบบจะนับเฉพาะวัน และเวลาจะไม่มีผล) |
options | Object | ออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง |
พารามิเตอร์ขั้นสูง
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
description | String | คําอธิบายกิจกรรม |
location | String | สถานที่จัดกิจกรรม |
guests | String | รายชื่ออีเมลที่คั่นด้วยคอมมาซึ่งควรเพิ่มเป็นผู้เข้าร่วม |
sendInvites | Boolean | ต้องการส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: false ) |
ไปกลับ
CalendarEvent
— กิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
สร้างชุดกิจกรรมใหม่สําหรับทั้งวัน
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ในชุด |
startDate | Date | วันที่ของเหตุการณ์แรกในชุด (ใช้เฉพาะวัน และข้ามเวลา) |
recurrence | EventRecurrence | การตั้งค่าการเกิดซ้ําของชุดกิจกรรม |
ไปกลับ
CalendarEventSeries
— ชุดกิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
สร้างชุดกิจกรรมใหม่สําหรับทั้งวัน
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}); Logger.log('Event Series ID: ' + eventSeries.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ในชุด |
startDate | Date | วันที่ของเหตุการณ์แรกในชุด (ใช้เฉพาะวัน และข้ามเวลา) |
recurrence | EventRecurrence | การตั้งค่าการเกิดซ้ําของชุดกิจกรรม |
options | Object | ออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง |
พารามิเตอร์ขั้นสูง
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
description | String | คําอธิบายเหตุการณ์ในชุด |
location | String | ตําแหน่งของเหตุการณ์ในชุด |
guests | String | รายชื่ออีเมลที่คั่นด้วยคอมมา ซึ่งควรเพิ่มให้เป็นผู้เข้าร่วมกิจกรรมในชุด |
sendInvites | Boolean | จะส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: false ) |
ไปกลับ
CalendarEventSeries
— ชุดกิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
สร้างกิจกรรมใหม่
หากไม่ได้ระบุเขตเวลา ระบบจะตีความค่าเวลาในบริบทของเขตเวลาของสคริปต์ ซึ่งอาจแตกต่างจากเขตเวลาของปฏิทิน
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC')); Logger.log('Event ID: ' + event.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ |
startTime | Date | วันที่และเวลาที่กิจกรรมเริ่มต้น |
endTime | Date | วันที่และเวลาที่กิจกรรมสิ้นสุด |
ไปกลับ
CalendarEvent
— กิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
สร้างกิจกรรมใหม่
หากไม่ได้ระบุเขตเวลา ระบบจะตีความค่าเวลาในบริบทของเขตเวลาของสคริปต์ ซึ่งอาจแตกต่างจากเขตเวลาของปฏิทิน
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ |
startTime | Date | วันที่และเวลาที่กิจกรรมเริ่มต้น |
endTime | Date | วันที่และเวลาที่กิจกรรมสิ้นสุด |
options | Object | ออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง |
พารามิเตอร์ขั้นสูง
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
description | String | คําอธิบายกิจกรรม |
location | String | ตําแหน่งของเหตุการณ์ |
guests | String | รายการที่คั่นด้วยคอมมาของอีเมลที่ควรเพิ่มเป็นผู้เข้าร่วม |
sendInvites | Boolean | จะส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: false ) |
ไปกลับ
CalendarEvent
— กิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventFromDescription(description)
สร้างกิจกรรมจากคําอธิบายรูปแบบอิสระ
คําอธิบายควรใช้รูปแบบเดียวกับฟีเจอร์ "เพิ่มด่วน" ของ UI
// Creates a new event and logs its ID. var event = CalendarApp.getDefaultCalendar() .createEventFromDescription('Lunch with Mary, Friday at 1PM'); Logger.log('Event ID: ' + event.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
description | String | คําอธิบายกิจกรรมรูปแบบอิสระ |
ไปกลับ
CalendarEvent
— กิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
สร้างชุดเหตุการณ์ใหม่
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ในชุด |
startTime | Date | วันที่และเวลาที่เหตุการณ์แรกในชุดเริ่มต้น |
endTime | Date | วันที่และเวลาที่เหตุการณ์แรกในชุดสิ้นสุด |
recurrence | EventRecurrence | การตั้งค่าการเกิดซ้ําของชุดกิจกรรม |
ไปกลับ
CalendarEventSeries
— ชุดกิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
สร้างชุดเหตุการณ์ใหม่
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}); Logger.log('Event Series ID: ' + eventSeries.getId());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
title | String | ชื่อเหตุการณ์ในชุด |
startTime | Date | วันที่และเวลาที่เหตุการณ์แรกในชุดเริ่มต้น |
endTime | Date | วันที่และเวลาที่เหตุการณ์แรกในชุดสิ้นสุด |
recurrence | EventRecurrence | การตั้งค่าการเกิดซ้ําของชุดกิจกรรม |
options | Object | ออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง |
พารามิเตอร์ขั้นสูง
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
description | String | คําอธิบายเหตุการณ์ในชุด |
location | String | ตําแหน่งของเหตุการณ์ในชุด |
guests | String | รายชื่ออีเมลที่คั่นด้วยคอมมา ซึ่งควรเพิ่มให้เป็นผู้เข้าร่วมกิจกรรมในชุด |
sendInvites | Boolean | จะส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: false ) |
ไปกลับ
CalendarEventSeries
— ชุดกิจกรรมที่สร้างขึ้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
deleteCalendar()
ลบปฏิทินถาวร ผู้ใช้จะลบได้เฉพาะปฏิทินของตนเองเท่านั้น
ผ้าคลุม
Error
— หากเป็นปฏิทินที่นําเข้า
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getColor()
รับข้อมูลสีของปฏิทิน
ไปกลับ
String
— สตริงสีที่เป็นตัวเลขฐาน 16 ("#rrggbb")
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDescription()
รับคําอธิบายปฏิทิน
ไปกลับ
String
— คําอธิบายปฏิทินนี้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventById(iCalId)
รับเหตุการณ์ด้วยรหัสที่กําหนด หากชุดปฏิทินเป็นของปฏิทินอื่นที่ไม่ใช่ปฏิทินเริ่มต้น คุณจะต้องเรียกใช้วิธีการนี้จากปฏิทินนั้น การโทร CalendarApp.getEventById(iCalId)
จะแสดงกิจกรรมเฉพาะในปฏิทินเริ่มต้นเท่านั้น
กิจกรรมหลายรายการอาจมีรหัสเหมือนกันหากเป็นส่วนหนึ่งของชุดกิจกรรม ในกรณีนี้ วิธีนี้จะแสดงเฉพาะเหตุการณ์แรกจากชุดดังกล่าว
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
iCalId | String | รหัสของกิจกรรม |
ไปกลับ
CalendarEvent
— กิจกรรมที่มีรหัสที่ระบุ หรือ null
หากไม่มีกิจกรรมหรือผู้ใช้เข้าถึงไม่ได้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventSeriesById(iCalId)
รับชุดกิจกรรมด้วยรหัสที่กําหนด หากรหัสที่ระบุเป็นของ CalendarEvent
เดียว ระบบจะแสดงผล CalendarEventSeries
ด้วยเหตุการณ์เดียวในชุด โปรดทราบว่าหากชุดกิจกรรมเป็นของปฏิทินอื่นที่ไม่ใช่ปฏิทินเริ่มต้น ระบบจะเรียกใช้เมธอดนี้จาก Calendar
นั้น โดยการเรียกใช้ CalendarApp.getEventSeriesById(iCalId)
จะแสดงผลชุดกิจกรรมที่มีอยู่ในปฏิทินเริ่มต้นโดยตรงเท่านั้น
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
iCalId | String | รหัสชุดกิจกรรม |
ไปกลับ
CalendarEventSeries
- ชุดหนังสือที่มีรหัสที่กําหนดไว้ หรือ null
หากชุดหนังสือไม่มีอยู่หรือผู้ใช้เข้าถึงชุดหนังสือไม่ได้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime)
รับเหตุการณ์ทั้งหมดที่เกิดขึ้นภายในช่วงเวลาที่ระบุ
วิธีนี้จะแสดงเหตุการณ์ที่เริ่มต้นในระหว่างระยะเวลาที่ระบุ สิ้นสุดระหว่างระยะเวลา หรือครอบคลุมช่วงเวลาดังกล่าว หากไม่ได้ระบุเขตเวลา ระบบจะตีความค่าเวลาในบริบทของเขตเวลาของสคริปต์ ซึ่งอาจแตกต่างจากเขตเวลาของปฏิทิน
// Determines how many events are happening in the next two hours. var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log('Number of events: ' + events.length);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
startTime | Date | จุดเริ่มต้นของช่วงเวลา |
endTime | Date | เวลาสิ้นสุดของช่วงเวลา ไม่ครอบคลุม |
ไปกลับ
CalendarEvent[]
— เหตุการณ์ที่เกิดขึ้นในช่วงเวลานั้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime, options)
รับเหตุการณ์ทั้งหมดที่เกิดขึ้นภายในช่วงเวลาที่กําหนดและตรงตามเกณฑ์ที่ระบุ
วิธีนี้จะแสดงเหตุการณ์ที่เริ่มต้นในระหว่างระยะเวลาที่กําหนด สิ้นสุดในระหว่างระยะเวลา หรือครอบคลุมช่วงเวลานั้นๆ หากไม่ได้ระบุเขตเวลา ระบบจะตีความค่าเวลาในบริบทของเขตเวลาของสคริปต์ ซึ่งอาจแตกต่างจากเขตเวลาของปฏิทิน
โปรดทราบว่าการกรองใน author
, search
หรือ statusFilters
จะเกิดขึ้นหลังจากใช้ start
และ max
ซึ่งหมายความว่าจํานวนเหตุการณ์ที่ได้กลับมาอาจน้อยกว่า max
แม้ว่าเหตุการณ์เพิ่มเติมจะเป็นไปตามเกณฑ์ก็ตาม
// Determines how many events are happening in the next two hours that contain the term // "meeting". var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
startTime | Date | จุดเริ่มต้นของช่วงเวลา |
endTime | Date | เวลาสิ้นสุดของช่วงเวลา ไม่ครอบคลุม |
options | Object | ออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง |
พารามิเตอร์ขั้นสูง
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
start | Integer | ดัชนีของเหตุการณ์แรกที่จะแสดง |
max | Integer | จํานวนเหตุการณ์สูงสุดที่จะแสดง |
author | String | อีเมลที่ใช้กรองผลลัพธ์โดยผู้สร้างกิจกรรม |
search | String | คําค้นหาแบบเต็มข้อความที่ใช้กรองผลการค้นหา |
statusFilters[] | GuestStatus | อาร์เรย์ของสถานะที่ใช้กรองผลการค้นหา |
ไปกลับ
CalendarEvent[]
— เหตุการณ์ที่เกิดขึ้นในช่วงเวลาและตรงกับเกณฑ์
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date)
รับเหตุการณ์ทั้งหมดที่เกิดขึ้นในวันที่ระบุ
วิธีนี้จะแสดงผลกิจกรรมหากเริ่มต้นระหว่างวัน สิ้นสุดระหว่างวัน หรือครอบคลุมวันนั้น
โปรดทราบว่าระบบจะใช้เฉพาะส่วนวันที่ของออบเจ็กต์วันที่เท่านั้น และระบบจะข้ามส่วนเวลา ระบบจะตีความวันที่เป็นเที่ยงคืนของวันนั้นถึงเที่ยงคืนของวันถัดไปในเขตเวลาของปฏิทิน
// Determines how many events are happening today. var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log('Number of events: ' + events.length);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
date | Date | วันที่ในการเรียกเหตุการณ์ (ละเว้นเฉพาะวัน และเวลาจะไม่มีผล) |
ไปกลับ
CalendarEvent[]
— เหตุการณ์ที่เกิดขึ้นในวันที่ที่ระบุ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date, options)
รับเหตุการณ์ทั้งหมดที่เกิดขึ้นในวันที่ที่ระบุและตรงตามเกณฑ์ที่ระบุ
วิธีนี้จะแสดงผลกิจกรรมหากเริ่มต้นระหว่างวัน สิ้นสุดระหว่างวัน หรือครอบคลุมวันนั้น
โปรดทราบว่าระบบจะใช้เฉพาะส่วนวันที่ของออบเจ็กต์วันที่เท่านั้น และระบบจะข้ามส่วนเวลา ระบบจะตีความวันที่เป็นเที่ยงคืนของวันนั้นถึงเที่ยงคืนของวันถัดไปในเขตเวลาของปฏิทิน
โปรดทราบว่าการกรองใน author
, search
หรือ statusFilters
จะเกิดขึ้นหลังจากใช้ start
และ max
ซึ่งหมายความว่าจํานวนเหตุการณ์ที่ได้กลับมาอาจน้อยกว่า max
แม้ว่าเหตุการณ์เพิ่มเติมจะเป็นไปตามเกณฑ์ก็ตาม
// Determines how many events are happening today and contain the term "meeting". var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
date | Date | วันที่ในการเรียกเหตุการณ์ (ละเว้นเฉพาะวัน และเวลาจะไม่มีผล) |
options | Object | ตัวเลือกการกรองขั้นสูง |
พารามิเตอร์ขั้นสูง
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
start | Integer | ดัชนีของเหตุการณ์แรกที่จะแสดง |
max | Integer | จํานวนเหตุการณ์สูงสุดที่จะแสดง |
author | String | อีเมลที่ใช้กรองผลลัพธ์โดยผู้สร้างกิจกรรม |
search | String | คําค้นหาแบบเต็มข้อความที่ใช้กรองผลการค้นหา |
statusFilters[] | GuestStatus | อาร์เรย์ของสถานะที่ใช้กรองผลการค้นหา |
ไปกลับ
CalendarEvent[]
— เหตุการณ์ที่เกิดขึ้นในวันที่ที่ระบุและตรงกับเกณฑ์
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getId()
รับรหัสปฏิทิน รหัสสําหรับปฏิทินเริ่มต้นของผู้ใช้คืออีเมล
ไปกลับ
String
— รหัสของปฏิทิน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getName()
ดาวน์โหลดชื่อปฏิทิน
ไปกลับ
String
— ชื่อปฏิทินนี้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTimeZone()
รับเขตเวลาของปฏิทิน
ไปกลับ
String
— เขตเวลา ที่ระบุในรูปแบบ "แบบยาว" (เช่น "อเมริกา/นิว_ยอร์ก" ตามที่แสดงอยู่ใน Joda.org)
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isHidden()
ระบุว่าปฏิทินซ่อนอยู่ในอินเทอร์เฟซผู้ใช้หรือไม่
ไปกลับ
Boolean
- true
หากซ่อนปฏิทินไว้ในอินเทอร์เฟซผู้ใช้ false
หรือไม่
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isMyPrimaryCalendar()
ระบุว่าปฏิทินเป็นปฏิทินเริ่มต้นสําหรับผู้ใช้ที่มีประสิทธิภาพหรือไม่
ไปกลับ
Boolean
- true
หากปฏิทินเป็นปฏิทินเริ่มต้นสําหรับผู้ใช้ที่มีประสิทธิภาพ false
ถ้าไม่ใช่
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isOwnedByMe()
ระบุว่าผู้ใช้ที่มีสิทธิ์เป็นเจ้าของปฏิทินหรือไม่
ไปกลับ
Boolean
— true
หากปฏิทินของผู้ใช้เป็นเจ้าของปฏิทิน false
ไม่ใช่
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isSelected()
กําหนดว่าจะแสดงกิจกรรมในปฏิทินในอินเทอร์เฟซผู้ใช้หรือไม่
ไปกลับ
Boolean
— true
หากกิจกรรมในปฏิทินแสดงในอินเทอร์เฟซผู้ใช้ false
หากไม่มี
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setColor(color)
ตั้งค่าสีปฏิทิน
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
color | String | สตริงสีที่เป็นตัวเลขฐาน 16 ("#rrggbb") หรือค่าจาก CalendarApp.Color |
ไปกลับ
Calendar
— ปฏิทินนี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
ตั้งค่าคําอธิบายปฏิทิน
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
description | String | คําอธิบายปฏิทินนี้ |
ไปกลับ
Calendar
— ปฏิทินนี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setHidden(hidden)
ตั้งค่าว่าจะให้ปฏิทินปรากฏในอินเทอร์เฟซผู้ใช้หรือไม่
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
hidden | Boolean | true เพื่อซ่อนปฏิทินในอินเทอร์เฟซผู้ใช้ false เพื่อแสดงปฏิทิน |
ไปกลับ
Calendar
— ปฏิทินนี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setName(name)
ตั้งชื่อปฏิทิน
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
name | String | ชื่อใหม่ |
ไปกลับ
Calendar
— ปฏิทินนี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
ตั้งค่าว่ากิจกรรมในปฏิทินจะปรากฏในอินเทอร์เฟซผู้ใช้หรือไม่
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
selected | Boolean | true เพื่อแสดงกิจกรรมในปฏิทินในอินเทอร์เฟซผู้ใช้ false เพื่อซ่อนกิจกรรม |
ไปกลับ
Calendar
— ปฏิทินนี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
ตั้งค่าเขตเวลาของปฏิทิน
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
timeZone | String | เขตเวลาที่ระบุในรูปแบบ "แบบยาว" (เช่น "อเมริกา/นิว_ยอร์ก" ตามที่แสดงโดย Joda.org) |
ไปกลับ
Calendar
— ปฏิทินนี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
unsubscribeFromCalendar()
ยกเลิกการสมัครรับอีเมลของผู้ใช้ ผู้ใช้ยกเลิกการสมัครจากปฏิทินที่ตนเองเป็นเจ้าของไม่ได้
ผ้าคลุม
Error
— หากเป็นปฏิทินที่เป็นเจ้าของ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds