Class CalendarApp

CalendarApp

อนุญาตให้สคริปต์อ่านและอัปเดต Google ปฏิทินของผู้ใช้ ชั้นเรียนนี้ให้การเข้าถึงโดยตรง ในปฏิทินเริ่มต้นของผู้ใช้ และสามารถเรียกปฏิทินเพิ่มเติมที่ ผู้ใช้เป็นเจ้าของหรือสมัครสมาชิก

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
ColorColorenum ที่แสดงสีที่มีชื่อซึ่งมีอยู่ในบริการปฏิทิน
EventColorEventColorenum ที่แสดงสีของกิจกรรมที่ตั้งชื่อแล้วในบริการปฏิทิน
GuestStatusGuestStatusenum ที่แสดงสถานะของผู้เข้าร่วมในกิจกรรม
MonthMonthEnum ที่แทนเดือนของปี
VisibilityVisibilityEnum ที่แทนการมองเห็นกิจกรรม
WeekdayWeekdayEnum ที่แทนวันของสัปดาห์

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
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สร้างชุดกิจกรรมตลอดทั้งวันใหม่
createCalendar(name)Calendarสร้างปฏิทินใหม่ที่ผู้ใช้เป็นเจ้าของ
createCalendar(name, options)Calendarสร้างปฏิทินใหม่ที่ผู้ใช้เป็นเจ้าของ
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สร้างชุดกิจกรรมใหม่
getAllCalendars()Calendar[]รับปฏิทินทั้งหมดที่ผู้ใช้เป็นเจ้าของหรือติดตาม
getAllOwnedCalendars()Calendar[]รับปฏิทินทั้งหมดที่ผู้ใช้เป็นเจ้าของ
getCalendarById(id)Calendarเรียกดูปฏิทินตามรหัสที่ระบุ
getCalendarsByName(name)Calendar[]รับปฏิทินทั้งหมดที่มีชื่อที่ระบุซึ่งผู้ใช้เป็นเจ้าของหรือติดตามอยู่
getColor()Stringดูสีของปฏิทิน
getDefaultCalendar()Calendarรับปฏิทินเริ่มต้นของผู้ใช้
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รับชื่อปฏิทิน
getOwnedCalendarById(id)Calendarรับปฏิทินที่มีรหัสที่ระบุ หากผู้ใช้เป็นเจ้าของ
getOwnedCalendarsByName(name)Calendar[]รับปฏิทินทั้งหมดที่มีชื่อที่ระบุซึ่งผู้ใช้เป็นเจ้าของ
getTimeZone()Stringรับข้อมูลเขตเวลาของปฏิทิน
isHidden()Booleanกำหนดว่าจะซ่อนปฏิทินในอินเทอร์เฟซผู้ใช้หรือไม่
isMyPrimaryCalendar()Booleanกำหนดว่าปฏิทินนั้นเป็นปฏิทินหลักสำหรับผู้ใช้ที่มีประสิทธิภาพหรือไม่
isOwnedByMe()Booleanกำหนดว่าคุณเป็นเจ้าของปฏิทินหรือไม่
isSelected()Booleanกำหนดว่ากิจกรรมของปฏิทินจะแสดงในอินเทอร์เฟซผู้ใช้หรือไม่
newRecurrence()EventRecurrenceสร้างออบเจ็กต์การเกิดซ้ำใหม่ ซึ่งสามารถใช้สร้างกฎสำหรับการเกิดซ้ำของกิจกรรม
setColor(color)Calendarตั้งค่าสีของปฏิทิน
setDescription(description)Calendarตั้งค่าคำอธิบายของปฏิทิน
setHidden(hidden)Calendarตั้งค่าว่าจะให้ปฏิทินปรากฏในอินเทอร์เฟซผู้ใช้หรือไม่
setName(name)Calendarตั้งชื่อของปฏิทิน
setSelected(selected)Calendarตั้งค่าว่าจะให้แสดงกิจกรรมของปฏิทินในอินเทอร์เฟซผู้ใช้หรือไม่
setTimeZone(timeZone)Calendarตั้งค่าเขตเวลาของปฏิทิน
subscribeToCalendar(id)Calendarสมัครรับข้อมูลปฏิทินของผู้ใช้ด้วยรหัสที่กำหนด หากผู้ใช้สมัครรับข้อมูลได้
subscribeToCalendar(id, options)Calendarสมัครรับข้อมูลปฏิทินของผู้ใช้ด้วยรหัสที่กำหนด หากผู้ใช้สมัครรับข้อมูลได้

เอกสารโดยละเอียด

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 — กิจกรรมที่สร้าง

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — กิจกรรมที่สร้าง

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — กิจกรรมที่สร้าง

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — กิจกรรมที่สร้าง

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — ชุดกิจกรรมที่สร้างขึ้น

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — ชุดกิจกรรมที่สร้างขึ้น

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

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

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

createCalendar(name)

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

// Creates a new calendar named "Travel Plans".
var calendar = CalendarApp.createCalendar('Travel Plans');
Logger.log('Created the calendar "%s", with the ID "%s".',
    calendar.getName(), calendar.getId());

พารามิเตอร์

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

รีเทิร์น

Calendar — ปฏิทินที่สร้างใหม่

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

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

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

createCalendar(name, options)

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

// Creates a new calendar named "Travel Plans" with a summary and color.
var calendar = CalendarApp.createCalendar('Travel Plans', {
  summary: 'A calendar to plan my travel schedule.',
  color: CalendarApp.Color.BLUE
});
Logger.log('Created the calendar "%s", with the ID "%s".',
    calendar.getName(), calendar.getId());

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
locationStringสถานที่ของปฏิทิน
summaryStringคำอธิบายของปฏิทิน
timeZoneStringเขตเวลาที่จะตั้งค่าปฏิทิน โดยระบุเป็น "long" รูปแบบ (เช่น "อเมริกา/New_York" ตามที่แสดงโดย Joda.org)
colorStringสตริงสีเลขฐานสิบหก ("#rrggbb") หรือค่าจาก CalendarApp.Colors
hiddenBooleanซ่อนปฏิทินในอินเทอร์เฟซผู้ใช้หรือไม่ (ค่าเริ่มต้น: false)
selectedBooleanกิจกรรมของปฏิทินแสดงต่อผู้ใช้หรือไม่ อินเทอร์เฟซ (ค่าเริ่มต้น: true)

รีเทิร์น

Calendar — ปฏิทินที่สร้างใหม่

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — กิจกรรมที่สร้าง

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — กิจกรรมที่สร้าง

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — กิจกรรมที่สร้าง

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — ชุดกิจกรรมที่สร้างขึ้น

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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 — ชุดกิจกรรมที่สร้างขึ้น

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

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

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

getAllCalendars()

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

// Determines how many calendars the user can access.
var calendars = CalendarApp.getAllCalendars();
Logger.log('This user owns or is subscribed to %s calendars.',
    calendars.length);

รีเทิร์น

Calendar[] — ปฏิทินทั้งหมดที่ผู้ใช้เข้าถึงได้

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

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

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

getAllOwnedCalendars()

รับปฏิทินทั้งหมดที่ผู้ใช้เป็นเจ้าของ

// Determines how many calendars the user owns.
var calendars = CalendarApp.getAllOwnedCalendars();
Logger.log('This user owns %s calendars.', calendars.length);

รีเทิร์น

Calendar[] — ปฏิทินทั้งหมดที่ผู้ใช้เป็นเจ้าของ

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

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

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

getCalendarById(id)

เรียกดูปฏิทินตามรหัสที่ระบุ

// Gets the public calendar "US Holidays" by ID.
var calendar = CalendarApp.getCalendarById(
    'en.usa#holiday@group.v.calendar.google.com');
Logger.log('The calendar is named "%s".', calendar.getName());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสปฏิทิน

รีเทิร์น

Calendar — ปฏิทินที่มีรหัสที่ระบุ หรือ null ถ้าไม่มีปฏิทินอยู่ หากไม่มี ผู้ใช้ไม่สามารถเข้าถึง หรือหากผู้ใช้ไม่ได้สมัครรับข้อมูลปฏิทิน

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

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

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

getCalendarsByName(name)

รับปฏิทินทั้งหมดที่มีชื่อที่ระบุซึ่งผู้ใช้เป็นเจ้าของหรือติดตามอยู่ ชื่อไม่เท่ากับ คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

// Gets the public calendar named "US Holidays".
var calendars = CalendarApp.getCalendarsByName('US Holidays');
Logger.log('Found %s matching calendars.', calendars.length);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อปฏิทิน

รีเทิร์น

Calendar[] — ปฏิทินทั้งหมดที่มีชื่อนี้ซึ่งผู้ใช้เข้าถึงได้

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

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

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

getColor()

ดูสีของปฏิทิน

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the color of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getColor() instead.
const calendarColor = calendar.getColor();
console.log(calendarColor);

รีเทิร์น

String — สตริงสีเลขฐานสิบหก ("#rrggbb")

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

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

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

getDefaultCalendar()

รับปฏิทินเริ่มต้นของผู้ใช้

// Determines the time zone of the user's default calendar.
var calendar = CalendarApp.getDefaultCalendar();
Logger.log('My default calendar is set to the time zone "%s".',
    calendar.getTimeZone());

รีเทิร์น

Calendar — ปฏิทินเริ่มต้นของผู้ใช้

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

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

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

getDescription()

รับคำอธิบายของปฏิทิน

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the description of the calendar to 'Test description.'
calendar.setDescription('Test description');

// Gets the description of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getDescription() instead.
const description = calendar.getDescription();
console.log(description);

รีเทิร์น

String — คำอธิบายของปฏิทินนี้

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

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

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

getEventById(iCalId)

รับเหตุการณ์ตามรหัสที่ระบุ หากชุดเป็นปฏิทินอื่นที่ไม่ใช่ค่าเริ่มต้น ปฏิทิน จะต้องเรียกใช้เมธอดนี้จากปฏิทินนั้น โทรหา getEventById(iCalId) เท่านั้น จะแสดงกิจกรรมในปฏิทินเริ่มต้น

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

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com')

// Creates an event for the moon landing.
const event = calendar.createEvent('Apollo 11 Landing',
  new Date('July 20, 1969 20:05:00 UTC'),
  new Date('July 20, 1969 20:17:00 UTC'));

// Gets the calendar event ID and logs it to the console.
const iCalId = event.getId();
console.log(iCalId);

// Gets the event by its ID and logs the title of the event to the console.
// For the default calendar, you can use CalendarApp.getEventById(iCalId) instead.
const myEvent = calendar.getEventById(iCalId);
console.log(myEvent.getTitle());

พารามิเตอร์

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

รีเทิร์น

CalendarEvent — เหตุการณ์ที่มีรหัสที่ระบุ หรือ null หากไม่มีเหตุการณ์หรือผู้ใช้ ไม่สามารถเข้าถึงได้

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

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

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Creates an event series for a daily team meeting from 1 PM to 2 PM.
// The series adds the daily event from January 1, 2023 through December 31, 2023.
const eventSeries = calendar.createEventSeries('Team meeting',
  new Date('Jan 1, 2023 13:00:00'),
  new Date('Jan 1, 2023 14:00:00'),
  CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')));

// Gets the ID of the event series.
const iCalId = eventSeries.getId();

// Gets the event series by its ID and logs the series title to the console.
// For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) instead.
console.log(calendar.getEventSeriesById(iCalId).getTitle());

พารามิเตอร์

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

รีเทิร์น

CalendarEventSeries — ชุดหนังสือที่มีรหัสที่ระบุ หรือ null หากไม่มีชุดหนังสือหรือผู้ใช้ ไม่สามารถเข้าถึงได้

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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[] — เหตุการณ์ที่เกิดขึ้นภายในช่วงเวลา

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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[] — เหตุการณ์ที่เกิดขึ้นภายในช่วงเวลาและตรงกับเกณฑ์

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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[] — เหตุการณ์ที่เกิดขึ้นในวันที่ที่ระบุ

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

สคริปต์ที่ใช้เมธอดนี้จำเป็นต้องได้รับการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก 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[] — เหตุการณ์ที่เกิดขึ้นในวันที่ที่ระบุและตรงกับเกณฑ์

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

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

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

getId()

รับรหัสของปฏิทิน รหัสปฏิทินเริ่มต้นของผู้ใช้คืออีเมล

// Opens the calendar by its ID.
// To get the user's default calendar, use CalendarApp.getDefaultCalendar().
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the ID of the calendar and logs it to the console.
const calendarId = calendar.getId();
console.log(calendarId);

รีเทิร์น

String — รหัสของปฏิทิน

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

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

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

getName()

รับชื่อปฏิทิน

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the name of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getName() instead.
const calendarName = calendar.getName();
console.log(calendarName);

รีเทิร์น

String — ชื่อปฏิทินนี้

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

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

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

getOwnedCalendarById(id)

รับปฏิทินที่มีรหัสที่ระบุ หากผู้ใช้เป็นเจ้าของ

หากต้องการค้นหารหัสปฏิทิน ให้คลิกลูกศรข้างชื่อปฏิทินใน Google ปฏิทิน และ เลือกการตั้งค่าปฏิทิน รหัสจะแสดงบริเวณด้านล่างของการตั้งค่า

// Gets a (non-existent) private calendar by ID.
var calendar = CalendarApp.getOwnedCalendarById(
    '123456789@group.calendar.google.com');
Logger.log('The calendar is named "%s".', calendar.getName());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสปฏิทิน

รีเทิร์น

Calendar — ปฏิทินที่มีรหัสที่กำหนด หรือ null หากไม่มีปฏิทิน หรือ ผู้ใช้ไม่ได้เป็นเจ้าของ

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

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

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

getOwnedCalendarsByName(name)

รับปฏิทินทั้งหมดที่มีชื่อที่ระบุซึ่งผู้ใช้เป็นเจ้าของ ชื่อไม่จำเป็นต้องตรงตามตัวพิมพ์ใหญ่-เล็ก

// Gets a private calendar named "Travel Plans".
var calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans');
Logger.log('Found %s matching calendars.', calendars.length);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อปฏิทิน

รีเทิร์น

Calendar[] — ปฏิทินทั้งหมดที่มีชื่อนี้ซึ่งผู้ใช้เป็นเจ้าของ

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

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

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

getTimeZone()

รับข้อมูลเขตเวลาของปฏิทิน

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the time zone of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getTimeZone() instead.
const timeZone = calendar.getTimeZone();
console.log(timeZone);

รีเทิร์น

String — เขตเวลา ระบุเป็น "long" รูปแบบ (เช่น "อเมริกา/กรุงเทพฯ" ตามที่ระบุไว้ โดย Joda.org)

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

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

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

isHidden()

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

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is hidden in the user interface and logs it to the console.
// For the default calendar, you can use CalendarApp.isHidden() instead.
const isHidden = calendar.isHidden();
console.log(isHidden);

รีเทิร์น

Booleantrue หากปฏิทินซ่อนอยู่ในอินเทอร์เฟซผู้ใช้ false หากทำได้ ใช้ไม่ได้

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

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

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

isMyPrimaryCalendar()

กำหนดว่าปฏิทินนั้นเป็นปฏิทินหลักสำหรับผู้ใช้ที่มีประสิทธิภาพหรือไม่

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is the default calendar for
// the effective user and logs it to the console.
// For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() instead.
const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar();
console.log(isMyPrimaryCalendar);

รีเทิร์น

Booleantrue หากปฏิทินเป็นปฏิทินเริ่มต้นสำหรับผู้ใช้ที่มีผล false หากไม่เป็นเช่นนั้น

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

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

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

isOwnedByMe()

กำหนดว่าคุณเป็นเจ้าของปฏิทินหรือไม่

// Gets a calendar by its ID. To get the user's default calendar, use
// CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with the calendar ID that you want to use.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Determines whether the calendar is owned by you and logs it.
console.log(calendar.isOwnedByMe());

รีเทิร์น

Booleantrue หากปฏิทินเป็นของคุณ false หากไม่

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

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

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

isSelected()

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

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Determines whether the calendar's events are displayed in the user interface and logs it.
console.log(calendar.isSelected());

รีเทิร์น

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

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

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

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

newRecurrence()

สร้างออบเจ็กต์การเกิดซ้ำใหม่ ซึ่งสามารถใช้สร้างกฎสำหรับการเกิดซ้ำของกิจกรรม

// Creates an event series for a no-meetings day, taking place every Wednesday in 2013.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
    .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
    .until(new Date('January 1, 2014'));
var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    recurrence);
Logger.log('Event Series ID: ' + eventSeries.getId());

รีเทิร์น

EventRecurrence — ออบเจ็กต์การเกิดซ้ำใหม่ที่ไม่ได้ตั้งกฎไว้ (ทำงานเป็นการเกิดซ้ำรายสัปดาห์)

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

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

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

setColor(color)

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

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the color of the calendar to pink using the Calendar Color enum.
// For the default calendar, you can use CalendarApp.setColor() instead.
calendar.setColor(CalendarApp.Color.PINK);

พารามิเตอร์

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

รีเทิร์น

Calendar — ปฏิทินสำหรับห่วงโซ่

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

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

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

setDescription(description)

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

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the description of the calendar.
// TODO(developer): Update the string with the description that you want to use.
calendar.setDescription('Updated calendar description.')

พารามิเตอร์

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

รีเทิร์น

Calendar — ปฏิทินสำหรับห่วงโซ่

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

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

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

setHidden(hidden)

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

พารามิเตอร์

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

รีเทิร์น

Calendar — ปฏิทินสำหรับห่วงโซ่

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

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

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

setName(name)

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

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the name of the calendar.
// TODO(developer): Update the string with the name that you want to use.
calendar.setName('Example calendar name');

พารามิเตอร์

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

รีเทิร์น

Calendar — ปฏิทินสำหรับห่วงโซ่

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

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

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

setSelected(selected)

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

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Selects the calendar so that its events are displayed in the user interface. To
// unselect the calendar, set the parameter to false.
calendar.setSelected(true);

พารามิเตอร์

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

รีเทิร์น

Calendar — ปฏิทินสำหรับห่วงโซ่

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

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

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

setTimeZone(timeZone)

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

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the time zone of the calendar to America/New York (US/Eastern) time.
calendar.setTimeZone('America/New_York');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
timeZoneStringเขตเวลาที่ระบุเป็น "long" (เช่น "America/New_York" เช่น Joda.org)

รีเทิร์น

Calendar — ปฏิทินสำหรับห่วงโซ่

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

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

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

subscribeToCalendar(id)

สมัครรับข้อมูลปฏิทินของผู้ใช้ด้วยรหัสที่กำหนด หากผู้ใช้สมัครรับข้อมูลได้

// Subscribe to the calendar "US Holidays".
var calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com');
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของปฏิทินที่จะสมัครรับข้อมูล

รีเทิร์น

Calendar — ปฏิทินที่สมัครรับข้อมูลใหม่

การขว้าง

Error — หากไม่มีปฏิทินที่ใช้รหัสนี้

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

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

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

subscribeToCalendar(id, options)

สมัครรับข้อมูลปฏิทินของผู้ใช้ด้วยรหัสที่กำหนด หากผู้ใช้สมัครรับข้อมูลได้

// Subscribe to the calendar "US Holidays", and set it to the color blue.
var calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
    { color: CalendarApp.Color.BLUE });
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

พารามิเตอร์

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

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

ชื่อประเภทคำอธิบาย
colorStringสตริงสีเลขฐานสิบหก ("#rrggbb") หรือค่าจาก CalendarApp.Colors
hiddenBooleanกำหนดว่าปฏิทินจะซ่อนในอินเทอร์เฟซผู้ใช้หรือไม่ (ค่าเริ่มต้น: false)
selectedBooleanกิจกรรมของปฏิทินแสดงต่อผู้ใช้หรือไม่ อินเทอร์เฟซ (ค่าเริ่มต้น: true หากระบุ color ด้วย false หรือไม่เช่นนั้น)

รีเทิร์น

Calendar — ปฏิทินที่สมัครรับข้อมูลใหม่

การขว้าง

Error — หากไม่มีปฏิทินที่ใช้รหัสนี้

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

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

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