Class Calendar

ปฏิทิน

แสดงปฏิทินที่ผู้ใช้เป็นเจ้าของหรือติดตาม

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์
dateDateวันที่ของเหตุการณ์ (ระบบจะนับเฉพาะวัน และเวลาจะไม่มีผล)

ไปกลับ

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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์
startDateDateวันที่กิจกรรมเริ่มต้น (โดยจะใช้เฉพาะวันและไม่สนใจเวลา)
endDateDateวันที่กิจกรรมสิ้นสุด (ใช้วันเท่านั้น และไม่สนใจเวลา) วันที่สิ้นสุดไม่รวมอยู่

ไปกลับ

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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์
startDateDateวันที่กิจกรรมเริ่มต้น (โดยจะใช้เฉพาะวันและไม่สนใจเวลา)
endDateDateวันที่กิจกรรมสิ้นสุด (ใช้วันเท่านั้น และไม่สนใจเวลา) วันที่สิ้นสุดไม่รวมอยู่
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
descriptionStringคําอธิบายกิจกรรม
locationStringสถานที่จัดกิจกรรม
guestsStringรายชื่ออีเมลที่คั่นด้วยคอมมาซึ่งควรเพิ่มเป็นผู้เข้าร่วม
sendInvitesBooleanต้องการส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์
dateDateวันที่ของเหตุการณ์ (ระบบจะนับเฉพาะวัน และเวลาจะไม่มีผล)
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
descriptionStringคําอธิบายกิจกรรม
locationStringสถานที่จัดกิจกรรม
guestsStringรายชื่ออีเมลที่คั่นด้วยคอมมาซึ่งควรเพิ่มเป็นผู้เข้าร่วม
sendInvitesBooleanต้องการส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์ในชุด
startDateDateวันที่ของเหตุการณ์แรกในชุด (ใช้เฉพาะวัน และข้ามเวลา)
recurrenceEventRecurrenceการตั้งค่าการเกิดซ้ําของชุดกิจกรรม

ไปกลับ

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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์ในชุด
startDateDateวันที่ของเหตุการณ์แรกในชุด (ใช้เฉพาะวัน และข้ามเวลา)
recurrenceEventRecurrenceการตั้งค่าการเกิดซ้ําของชุดกิจกรรม
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
descriptionStringคําอธิบายเหตุการณ์ในชุด
locationStringตําแหน่งของเหตุการณ์ในชุด
guestsStringรายชื่ออีเมลที่คั่นด้วยคอมมา ซึ่งควรเพิ่มให้เป็นผู้เข้าร่วมกิจกรรมในชุด
sendInvitesBooleanจะส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์
startTimeDateวันที่และเวลาที่กิจกรรมเริ่มต้น
endTimeDateวันที่และเวลาที่กิจกรรมสิ้นสุด

ไปกลับ

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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์
startTimeDateวันที่และเวลาที่กิจกรรมเริ่มต้น
endTimeDateวันที่และเวลาที่กิจกรรมสิ้นสุด
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
descriptionStringคําอธิบายกิจกรรม
locationStringตําแหน่งของเหตุการณ์
guestsStringรายการที่คั่นด้วยคอมมาของอีเมลที่ควรเพิ่มเป็นผู้เข้าร่วม
sendInvitesBooleanจะส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
descriptionStringคําอธิบายกิจกรรมรูปแบบอิสระ

ไปกลับ

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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์ในชุด
startTimeDateวันที่และเวลาที่เหตุการณ์แรกในชุดเริ่มต้น
endTimeDateวันที่และเวลาที่เหตุการณ์แรกในชุดสิ้นสุด
recurrenceEventRecurrenceการตั้งค่าการเกิดซ้ําของชุดกิจกรรม

ไปกลับ

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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อเหตุการณ์ในชุด
startTimeDateวันที่และเวลาที่เหตุการณ์แรกในชุดเริ่มต้น
endTimeDateวันที่และเวลาที่เหตุการณ์แรกในชุดสิ้นสุด
recurrenceEventRecurrenceการตั้งค่าการเกิดซ้ําของชุดกิจกรรม
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
descriptionStringคําอธิบายเหตุการณ์ในชุด
locationStringตําแหน่งของเหตุการณ์ในชุด
guestsStringรายชื่ออีเมลที่คั่นด้วยคอมมา ซึ่งควรเพิ่มให้เป็นผู้เข้าร่วมกิจกรรมในชุด
sendInvitesBooleanจะส่งอีเมลคําเชิญหรือไม่ (ค่าเริ่มต้น: 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) จะแสดงกิจกรรมเฉพาะในปฏิทินเริ่มต้นเท่านั้น

กิจกรรมหลายรายการอาจมีรหัสเหมือนกันหากเป็นส่วนหนึ่งของชุดกิจกรรม ในกรณีนี้ วิธีนี้จะแสดงเฉพาะเหตุการณ์แรกจากชุดดังกล่าว

พารามิเตอร์

ชื่อประเภทคำอธิบาย
iCalIdStringรหัสของกิจกรรม

ไปกลับ

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) จะแสดงผลชุดกิจกรรมที่มีอยู่ในปฏิทินเริ่มต้นโดยตรงเท่านั้น

พารามิเตอร์

ชื่อประเภทคำอธิบาย
iCalIdStringรหัสชุดกิจกรรม

ไปกลับ

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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startTimeDateจุดเริ่มต้นของช่วงเวลา
endTimeDateเวลาสิ้นสุดของช่วงเวลา ไม่ครอบคลุม

ไปกลับ

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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startTimeDateจุดเริ่มต้นของช่วงเวลา
endTimeDateเวลาสิ้นสุดของช่วงเวลา ไม่ครอบคลุม
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงตามที่ระบุไว้ด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของเหตุการณ์แรกที่จะแสดง
maxIntegerจํานวนเหตุการณ์สูงสุดที่จะแสดง
authorStringอีเมลที่ใช้กรองผลลัพธ์โดยผู้สร้างกิจกรรม
searchStringคําค้นหาแบบเต็มข้อความที่ใช้กรองผลการค้นหา
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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
dateDateวันที่ในการเรียกเหตุการณ์ (ละเว้นเฉพาะวัน และเวลาจะไม่มีผล)

ไปกลับ

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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
dateDateวันที่ในการเรียกเหตุการณ์ (ละเว้นเฉพาะวัน และเวลาจะไม่มีผล)
optionsObjectตัวเลือกการกรองขั้นสูง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
startIntegerดัชนีของเหตุการณ์แรกที่จะแสดง
maxIntegerจํานวนเหตุการณ์สูงสุดที่จะแสดง
authorStringอีเมลที่ใช้กรองผลลัพธ์โดยผู้สร้างกิจกรรม
searchStringคําค้นหาแบบเต็มข้อความที่ใช้กรองผลการค้นหา
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()

ระบุว่าผู้ใช้ที่มีสิทธิ์เป็นเจ้าของปฏิทินหรือไม่

ไปกลับ

Booleantrue หากปฏิทินของผู้ใช้เป็นเจ้าของปฏิทิน false ไม่ใช่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isSelected()

กําหนดว่าจะแสดงกิจกรรมในปฏิทินในอินเทอร์เฟซผู้ใช้หรือไม่

ไปกลับ

Booleantrue หากกิจกรรมในปฏิทินแสดงในอินเทอร์เฟซผู้ใช้ false หากไม่มี

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

setColor(color)

ตั้งค่าสีปฏิทิน

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorStringสตริงสีที่เป็นตัวเลขฐาน 16 ("#rrggbb") หรือค่าจาก CalendarApp.Color

ไปกลับ

Calendar — ปฏิทินนี้สําหรับเชนธุรกิจ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setDescription(description)

ตั้งค่าคําอธิบายปฏิทิน

พารามิเตอร์

ชื่อประเภทคำอธิบาย
descriptionStringคําอธิบายปฏิทินนี้

ไปกลับ

Calendar — ปฏิทินนี้สําหรับเชนธุรกิจ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setHidden(hidden)

ตั้งค่าว่าจะให้ปฏิทินปรากฏในอินเทอร์เฟซผู้ใช้หรือไม่

พารามิเตอร์

ชื่อประเภทคำอธิบาย
hiddenBooleantrue เพื่อซ่อนปฏิทินในอินเทอร์เฟซผู้ใช้ false เพื่อแสดงปฏิทิน

ไปกลับ

Calendar — ปฏิทินนี้สําหรับเชนธุรกิจ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setName(name)

ตั้งชื่อปฏิทิน

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อใหม่

ไปกลับ

Calendar — ปฏิทินนี้สําหรับเชนธุรกิจ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setSelected(selected)

ตั้งค่าว่ากิจกรรมในปฏิทินจะปรากฏในอินเทอร์เฟซผู้ใช้หรือไม่

พารามิเตอร์

ชื่อประเภทคำอธิบาย
selectedBooleantrue เพื่อแสดงกิจกรรมในปฏิทินในอินเทอร์เฟซผู้ใช้ false เพื่อซ่อนกิจกรรม

ไปกลับ

Calendar — ปฏิทินนี้สําหรับเชนธุรกิจ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTimeZone(timeZone)

ตั้งค่าเขตเวลาของปฏิทิน

พารามิเตอร์

ชื่อประเภทคำอธิบาย
timeZoneStringเขตเวลาที่ระบุในรูปแบบ "แบบยาว" (เช่น "อเมริกา/นิว_ยอร์ก" ตามที่แสดงโดย 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