Đại diện cho lịch mà người dùng sở hữu hoặc đã đăng ký.
Phương thức
Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
---|---|---|
createAllDayEvent(title, date) | CalendarEvent | Tạo sự kiện cả ngày mới. |
createAllDayEvent(title, startDate, endDate) | CalendarEvent | Tạo sự kiện cả ngày mới có thể kéo dài nhiều ngày. |
createAllDayEvent(title, startDate, endDate, options) | CalendarEvent | Tạo sự kiện cả ngày mới có thể kéo dài nhiều ngày. |
createAllDayEvent(title, date, options) | CalendarEvent | Tạo sự kiện cả ngày mới. |
createAllDayEventSeries(title, startDate, recurrence) | CalendarEventSeries | Tạo chuỗi sự kiện mới kéo dài cả ngày. |
createAllDayEventSeries(title, startDate, recurrence, options) | CalendarEventSeries | Tạo chuỗi sự kiện mới kéo dài cả ngày. |
createEvent(title, startTime, endTime) | CalendarEvent | Tạo sự kiện mới. |
createEvent(title, startTime, endTime, options) | CalendarEvent | Tạo sự kiện mới. |
createEventFromDescription(description) | CalendarEvent | Tạo sự kiện từ nội dung mô tả dạng biểu mẫu tuỳ ý. |
createEventSeries(title, startTime, endTime, recurrence) | CalendarEventSeries | Tạo một chuỗi sự kiện mới. |
createEventSeries(title, startTime, endTime, recurrence, options) | CalendarEventSeries | Tạo một chuỗi sự kiện mới. |
deleteCalendar() | void | Xoá lịch vĩnh viễn. |
getColor() | String | Xem màu của lịch. |
getDescription() | String | Xem nội dung mô tả của lịch. |
getEventById(iCalId) | CalendarEvent | Lấy sự kiện có mã nhận dạng đã cho. |
getEventSeriesById(iCalId) | CalendarEventSeries | Lấy chuỗi sự kiện có mã đã cho. |
getEvents(startTime, endTime) | CalendarEvent[] | Lấy tất cả sự kiện xảy ra trong một phạm vi thời gian nhất định. |
getEvents(startTime, endTime, options) | CalendarEvent[] | Lấy tất cả sự kiện xảy ra trong một phạm vi thời gian nhất định và đáp ứng tiêu chí đã chỉ định. |
getEventsForDay(date) | CalendarEvent[] | Lấy tất cả sự kiện xảy ra vào một ngày cụ thể. |
getEventsForDay(date, options) | CalendarEvent[] | Lấy tất cả sự kiện xảy ra vào một ngày nhất định và đáp ứng tiêu chí đã chỉ định. |
getId() | String | Lấy mã lịch. |
getName() | String | Xem tên lịch. |
getTimeZone() | String | Lấy múi giờ của lịch. |
isHidden() | Boolean | Xác định xem lịch có bị ẩn trong giao diện người dùng hay không. |
isMyPrimaryCalendar() | Boolean | Xác định xem lịch có phải là lịch chính cho người dùng hoạt động hiệu quả hay không. |
isOwnedByMe() | Boolean | Xác định xem lịch có phải do bạn sở hữu hay không. |
isSelected() | Boolean | Xác định xem các sự kiện của lịch có hiển thị trong giao diện người dùng hay không. |
setColor(color) | Calendar | Đặt màu cho lịch. |
setDescription(description) | Calendar | Đặt mô tả cho lịch. |
setHidden(hidden) | Calendar | Đặt lịch có hiển thị trong giao diện người dùng hay không. |
setName(name) | Calendar | Đặt tên cho lịch. |
setSelected(selected) | Calendar | Thiết lập xem các sự kiện của lịch có hiển thị trong giao diện người dùng hay không. |
setTimeZone(timeZone) | Calendar | Đặt múi giờ cho lịch. |
unsubscribeFromCalendar() | void | Huỷ đăng ký người dùng khỏi lịch. |
Tài liệu chi tiết
createAllDayEvent(title, date)
Tạo sự kiện cả ngày mới.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | Tiêu đề của sự kiện. |
date | Date | Ngày của sự kiện (chỉ sử dụng ngày; bỏ qua giờ). |
Cầu thủ trả bóng
CalendarEvent
— Sự kiện đã tạo.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
Tạo sự kiện cả ngày mới có thể kéo dài nhiều ngày.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | Tiêu đề của sự kiện. |
startDate | Date | Ngày bắt đầu sự kiện (chỉ sử dụng ngày; bỏ qua thời gian). |
endDate | Date | Ngày kết thúc sự kiện (chỉ sử dụng ngày; bỏ qua thời gian). Chiến lược phát hành đĩa đơn chỉ có ngày kết thúc. |
Cầu thủ trả bóng
CalendarEvent
— Sự kiện đã tạo.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
Tạo sự kiện cả ngày mới có thể kéo dài nhiều ngày.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | Tiêu đề của sự kiện. |
startDate | Date | Ngày bắt đầu sự kiện (chỉ sử dụng ngày; bỏ qua thời gian). |
endDate | Date | Ngày kết thúc sự kiện (chỉ sử dụng ngày; bỏ qua thời gian). Chiến lược phát hành đĩa đơn chỉ có ngày kết thúc. |
options | Object | Đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới. |
Thông số nâng cao
Tên | Loại | Mô tả |
---|---|---|
description | String | Nội dung mô tả về sự kiện. |
location | String | Địa điểm diễn ra sự kiện. |
guests | String | Danh sách địa chỉ email được phân tách bằng dấu phẩy mà bạn nên thêm vào với tư cách khách. |
sendInvites | Boolean | Liệu có gửi email mời hay không (mặc định: false ). |
Cầu thủ trả bóng
CalendarEvent
— Sự kiện đã tạo.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
Tạo sự kiện cả ngày mới.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | Tiêu đề của sự kiện. |
date | Date | Ngày của sự kiện (chỉ sử dụng ngày; bỏ qua giờ). |
options | Object | Đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới. |
Thông số nâng cao
Tên | Loại | Mô tả |
---|---|---|
description | String | Nội dung mô tả về sự kiện. |
location | String | Địa điểm diễn ra sự kiện. |
guests | String | Danh sách địa chỉ email được phân tách bằng dấu phẩy mà bạn nên thêm vào với tư cách khách. |
sendInvites | Boolean | Liệu có gửi email mời hay không (mặc định: false ). |
Cầu thủ trả bóng
CalendarEvent
— Sự kiện đã tạo.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
Tạo chuỗi sự kiện mới kéo dài cả ngày.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | tiêu đề của các sự kiện trong chuỗi sự kiện |
startDate | Date | ngày của sự kiện đầu tiên trong chuỗi (chỉ sử dụng ngày; thời gian là bị bỏ qua) |
recurrence | EventRecurrence | chế độ cài đặt lặp lại của chuỗi sự kiện |
Cầu thủ trả bóng
CalendarEventSeries
— chuỗi sự kiện đã tạo
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
Tạo chuỗi sự kiện mới kéo dài cả ngày.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | tiêu đề của các sự kiện trong chuỗi sự kiện |
startDate | Date | ngày của sự kiện đầu tiên trong chuỗi (chỉ sử dụng ngày; thời gian là bị bỏ qua) |
recurrence | EventRecurrence | chế độ cài đặt lặp lại của chuỗi sự kiện |
options | Object | đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới |
Thông số nâng cao
Tên | Loại | Mô tả |
---|---|---|
description | String | nội dung mô tả về các sự kiện trong chuỗi sự kiện |
location | String | địa điểm của các sự kiện trong chuỗi sự kiện |
guests | String | danh sách địa chỉ email được phân tách bằng dấu phẩy mà bạn muốn thêm vào khách mời tham dự các sự kiện trong chuỗi sự kiện |
sendInvites | Boolean | có gửi email mời hay không (mặc định: false ) |
Cầu thủ trả bóng
CalendarEventSeries
— chuỗi sự kiện đã tạo
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
Tạo sự kiện mới.
Nếu không có múi giờ được chỉ định, giá trị thời gian được diễn giải theo ngữ cảnh của tập lệnh múi giờ, có thể khác với múi giờ của lịch.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | tiêu đề của sự kiện |
startTime | Date | ngày và giờ khi sự kiện bắt đầu |
endTime | Date | ngày và giờ khi sự kiện kết thúc |
Cầu thủ trả bóng
CalendarEvent
– sự kiện đã tạo
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
Tạo sự kiện mới.
Nếu không có múi giờ được chỉ định, giá trị thời gian được diễn giải theo ngữ cảnh của tập lệnh múi giờ, có thể khác với múi giờ của lịch.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | tiêu đề của sự kiện |
startTime | Date | ngày và giờ khi sự kiện bắt đầu |
endTime | Date | ngày và giờ khi sự kiện kết thúc |
options | Object | đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới |
Thông số nâng cao
Tên | Loại | Mô tả |
---|---|---|
description | String | nội dung mô tả về sự kiện |
location | String | địa điểm diễn ra sự kiện |
guests | String | danh sách địa chỉ email được phân tách bằng dấu phẩy mà bạn muốn thêm vào với tư cách khách |
sendInvites | Boolean | có gửi email mời hay không (mặc định: false ) |
Cầu thủ trả bóng
CalendarEvent
– sự kiện đã tạo
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventFromDescription(description)
Tạo sự kiện từ nội dung mô tả dạng biểu mẫu tuỳ ý.
Nội dung mô tả phải sử dụng cùng định dạng với tính năng "Thêm nhanh" của giao diện người dùng.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
description | String | nội dung mô tả dạng tự do về sự kiện |
Cầu thủ trả bóng
CalendarEvent
— sự kiện đã tạo
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
Tạo một chuỗi sự kiện mới.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | tiêu đề của các sự kiện trong chuỗi sự kiện |
startTime | Date | ngày và giờ khi sự kiện đầu tiên trong chuỗi sự kiện bắt đầu |
endTime | Date | ngày và giờ khi sự kiện đầu tiên trong chuỗi sự kiện kết thúc |
recurrence | EventRecurrence | chế độ cài đặt lặp lại của chuỗi sự kiện |
Cầu thủ trả bóng
CalendarEventSeries
— chuỗi sự kiện đã tạo
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
Tạo một chuỗi sự kiện mới.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
title | String | tiêu đề của các sự kiện trong chuỗi sự kiện |
startTime | Date | ngày và giờ khi sự kiện đầu tiên trong chuỗi sự kiện bắt đầu |
endTime | Date | ngày và giờ khi sự kiện đầu tiên trong chuỗi sự kiện kết thúc |
recurrence | EventRecurrence | chế độ cài đặt lặp lại của chuỗi sự kiện |
options | Object | đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới |
Thông số nâng cao
Tên | Loại | Mô tả |
---|---|---|
description | String | nội dung mô tả về các sự kiện trong chuỗi sự kiện |
location | String | địa điểm của các sự kiện trong chuỗi sự kiện |
guests | String | danh sách địa chỉ email được phân tách bằng dấu phẩy mà bạn muốn thêm vào khách mời tham dự các sự kiện trong chuỗi sự kiện |
sendInvites | Boolean | có gửi email mời hay không (mặc định: false ) |
Cầu thủ trả bóng
CalendarEventSeries
— chuỗi sự kiện đã tạo
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
deleteCalendar()
Xoá lịch vĩnh viễn. Người dùng chỉ có thể xoá lịch mà họ sở hữu.
// Creates a calendar to delete. const calendar = CalendarApp.createCalendar('Test'); // Deletes the 'Test' calendar permanently. calendar.deleteCalendar();
Gửi
Error
— nếu đây là lịch đã nhập.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getColor()
Xem màu của lịch.
// 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);
Cầu thủ trả bóng
String
– Chuỗi màu thập lục phân ("#rrggbb").
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDescription()
Xem nội dung mô tả của lịch.
// 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);
Cầu thủ trả bóng
String
— Mô tả của lịch này.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventById(iCalId)
Lấy sự kiện có mã nhận dạng đã cho. Nếu chuỗi chủ đề thuộc về một lịch không phải là lịch mặc định
lịch, thì phương thức này phải được gọi từ lịch đó. Chỉ gọi cho CalendarApp.getEventById(iCalId)
trả về một sự kiện trong lịch mặc định.
Nhiều sự kiện có thể có cùng mã nếu chúng thuộc một chuỗi sự kiện. Trong trường hợp này, phương thức chỉ trả về sự kiện đầu tiên từ chuỗi đó.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
iCalId | String | Mã của sự kiện. |
Cầu thủ trả bóng
CalendarEvent
– Sự kiện có mã nhận dạng đã cho hoặc null
nếu sự kiện không tồn tại hoặc người dùng
không thể truy cập vào tệp đó.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventSeriesById(iCalId)
Lấy chuỗi sự kiện có mã đã cho. Nếu mã nhận dạng được cung cấp là dành cho một CalendarEvent
đơn lẻ,
thì CalendarEventSeries
sẽ được trả về cùng với một sự kiện duy nhất trong chuỗi. Lưu ý rằng nếu
chuỗi sự kiện thuộc về một lịch khác với lịch mặc định, thì phương thức này phải
được gọi từ Calendar
đó; đang gọi CalendarApp.getEventSeriesById(iCalId)
chỉ trả về một chuỗi sự kiện tồn tại trong lịch mặc định.
// 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
iCalId | String | Mã của chuỗi sự kiện. |
Cầu thủ trả bóng
CalendarEventSeries
– Bộ sách có mã nhận dạng đã cho hoặc null
nếu bộ sách không tồn tại hoặc người dùng
không thể truy cập vào tệp đó.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime)
Lấy tất cả sự kiện xảy ra trong một phạm vi thời gian nhất định.
Phương thức này trả về các sự kiện bắt đầu trong một khoảng thời gian nhất định, kết thúc trong thời gian đó hoặc bao gồm phạm vi thời gian. Nếu không có múi giờ được chỉ định, giá trị thời gian sẽ được diễn giải theo ngữ cảnh múi giờ của tập lệnh, múi giờ này có thể khác với múi giờ của lịch.
// 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);
Tham số
Tên | Loại | Mô tả |
---|---|---|
startTime | Date | thời điểm bắt đầu phạm vi thời gian |
endTime | Date | kết thúc của phạm vi thời gian, không bao gồm |
Cầu thủ trả bóng
CalendarEvent[]
– các sự kiện xảy ra trong phạm vi thời gian
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime, options)
Lấy tất cả sự kiện xảy ra trong một phạm vi thời gian nhất định và đáp ứng tiêu chí đã chỉ định.
Phương thức này trả về các sự kiện bắt đầu trong một khoảng thời gian nhất định, kết thúc trong khoảng thời gian đó hoặc bao gồm phạm vi thời gian. Nếu không có múi giờ được chỉ định, giá trị thời gian sẽ được diễn giải theo ngữ cảnh múi giờ của tập lệnh, múi giờ này có thể khác với múi giờ của lịch.
Xin lưu ý rằng tính năng lọc trên author
, search
hoặc statusFilters
sẽ lấy
sau khi áp dụng start
và max
. Điều này có nghĩa là số lượng sự kiện
trả về có thể ít hơn max
, mặc dù các sự kiện khác đáp ứng tiêu chí.
// 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);
Tham số
Tên | Loại | Mô tả |
---|---|---|
startTime | Date | thời điểm bắt đầu phạm vi thời gian |
endTime | Date | kết thúc của phạm vi thời gian, không bao gồm |
options | Object | đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới |
Thông số nâng cao
Tên | Loại | Mô tả |
---|---|---|
start | Integer | chỉ mục của sự kiện đầu tiên trả về |
max | Integer | số lượng sự kiện tối đa cần trả về |
author | String | địa chỉ email dùng để lọc kết quả theo người tạo sự kiện |
search | String | cụm từ tìm kiếm toàn bộ văn bản dùng để lọc kết quả |
statusFilters[] | GuestStatus | một loạt trạng thái dùng để lọc kết quả |
Cầu thủ trả bóng
CalendarEvent[]
— các sự kiện diễn ra trong phạm vi thời gian và phù hợp với tiêu chí
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date)
Lấy tất cả sự kiện xảy ra vào một ngày cụ thể.
Phương thức này trả về các sự kiện nếu chúng bắt đầu trong một ngày cụ thể, kết thúc vào ngày đó hoặc bao gồm ngày.
Xin lưu ý rằng chỉ sử dụng phần ngày của đối tượng Ngày và phần thời gian sẽ bị bỏ qua. Ngày được diễn giải là từ nửa đêm của ngày hôm đó đến nửa đêm của ngày tiếp theo theo giờ trong lịch vùng.
// Determines how many events are happening today. var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log('Number of events: ' + events.length);
Tham số
Tên | Loại | Mô tả |
---|---|---|
date | Date | ngày truy xuất sự kiện (chỉ sử dụng ngày; thời gian bị bỏ qua) |
Cầu thủ trả bóng
CalendarEvent[]
— các sự kiện xảy ra vào ngày đã cho
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date, options)
Lấy tất cả sự kiện xảy ra vào một ngày nhất định và đáp ứng tiêu chí đã chỉ định.
Phương thức này trả về các sự kiện nếu chúng bắt đầu trong một ngày cụ thể, kết thúc vào ngày đó hoặc bao gồm ngày.
Xin lưu ý rằng chỉ sử dụng phần ngày của đối tượng Ngày và phần thời gian sẽ bị bỏ qua. Ngày được diễn giải là từ nửa đêm của ngày hôm đó đến nửa đêm của ngày tiếp theo theo giờ trong lịch vùng.
Xin lưu ý rằng tính năng lọc trên author
, search
hoặc statusFilters
sẽ lấy
sau khi áp dụng start
và max
. Điều này có nghĩa là số lượng sự kiện
trả về có thể ít hơn max
, mặc dù các sự kiện khác đáp ứng tiêu chí.
// 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);
Tham số
Tên | Loại | Mô tả |
---|---|---|
date | Date | ngày truy xuất sự kiện (chỉ sử dụng ngày; thời gian bị bỏ qua) |
options | Object | tuỳ chọn lọc nâng cao |
Thông số nâng cao
Tên | Loại | Mô tả |
---|---|---|
start | Integer | chỉ mục của sự kiện đầu tiên trả về |
max | Integer | số lượng sự kiện tối đa cần trả về |
author | String | địa chỉ email dùng để lọc kết quả theo người tạo sự kiện |
search | String | cụm từ tìm kiếm toàn bộ văn bản dùng để lọc kết quả |
statusFilters[] | GuestStatus | một loạt trạng thái dùng để lọc kết quả |
Cầu thủ trả bóng
CalendarEvent[]
— các sự kiện xảy ra vào ngày đã cho và đáp ứng tiêu chí
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getId()
Lấy mã lịch. Mã lịch mặc định của người dùng là địa chỉ email của họ.
// 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);
Cầu thủ trả bóng
String
— Mã lịch.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getName()
Xem tên lịch.
// 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);
Cầu thủ trả bóng
String
— Tên lịch này.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTimeZone()
Lấy múi giờ của lịch.
// 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);
Cầu thủ trả bóng
String
— Múi giờ, được chỉ định bằng "long" định dạng (ví dụ: "Mỹ/New_ Được" như liệt kê
của Joda.org).
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isHidden()
Xác định xem lịch có bị ẩn trong giao diện người dùng hay không.
// 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);
Cầu thủ trả bóng
Boolean
– true
nếu lịch bị ẩn trong giao diện người dùng; false
nếu
thì không.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isMyPrimaryCalendar()
Xác định xem lịch có phải là lịch chính cho người dùng hoạt động hiệu quả hay không.
// 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);
Cầu thủ trả bóng
Boolean
– true
nếu lịch là lịch mặc định cho người dùng hoạt động hiệu quả; false
nếu không.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isOwnedByMe()
Xác định xem lịch có phải do bạn sở hữu hay không.
// 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());
Cầu thủ trả bóng
Boolean
— true
nếu lịch là của bạn; false
nếu không.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isSelected()
Xác định xem các sự kiện của lịch có hiển thị trong giao diện người dùng hay không.
// 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());
Cầu thủ trả bóng
Boolean
– true
nếu các sự kiện của lịch được hiển thị trong giao diện người dùng; false
nếu không
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setColor(color)
Đặt màu cho lịch.
// 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);
Tham số
Tên | Loại | Mô tả |
---|---|---|
color | String | CalendarApp.Color hoặc chuỗi màu thập lục phân
("#rrggbb"). |
Cầu thủ trả bóng
Calendar
— Lịch này để tạo chuỗi.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
Đặt mô tả cho lịch.
// 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.')
Tham số
Tên | Loại | Mô tả |
---|---|---|
description | String | mô tả về lịch này |
Cầu thủ trả bóng
Calendar
— lịch này để tạo chuỗi
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setHidden(hidden)
Đặt lịch có hiển thị trong giao diện người dùng hay không.
Tham số
Tên | Loại | Mô tả |
---|---|---|
hidden | Boolean | true để ẩn lịch trong giao diện người dùng; false để hiển thị |
Cầu thủ trả bóng
Calendar
— lịch này để tạo chuỗi
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setName(name)
Đặt tên cho lịch.
// 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');
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | tên mới |
Cầu thủ trả bóng
Calendar
— lịch này để tạo chuỗi
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
Thiết lập xem các sự kiện của lịch có hiển thị trong giao diện người dùng hay không.
// 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);
Tham số
Tên | Loại | Mô tả |
---|---|---|
selected | Boolean | true để hiển thị các sự kiện của lịch trong giao diện người dùng; false
để ẩn chúng |
Cầu thủ trả bóng
Calendar
— lịch này để tạo chuỗi
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
Đặt múi giờ cho lịch.
// 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');
Tham số
Tên | Loại | Mô tả |
---|---|---|
timeZone | String | Múi giờ, được chỉ định bằng "long" (chẳng hạn như " America/New_ Được ", như do Joda.org liệt kê). |
Cầu thủ trả bóng
Calendar
— Lịch này để tạo chuỗi.
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
unsubscribeFromCalendar()
Huỷ đăng ký người dùng khỏi lịch. Người dùng không thể huỷ đăng ký những lịch được liệt kê trong Danh sách Lịch của tôi. Họ có thể huỷ đăng ký nhận các lịch được liệt kê trong phần Khác lịch.
// Gets the calendar by its ID. // TODO(developer): Replace the calendar ID with the calendar ID that you want to get. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Unsubscribes the user from the calendar. const result = calendar.unsubscribeFromCalendar();
Gửi
Error
— nếu đây là lịch của bạn
Ủy quyền
Những tập lệnh dùng phương thức này yêu cầu uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây trong API REST liên quan:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds