Biểu thị một lịch mà người dùng sở hữu hoặc đăng ký theo dõi.
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
create | Calendar | Tạo một sự kiện cả ngày mới. |
create | Calendar | Tạo một sự kiện cả ngày mới có thể kéo dài nhiều ngày. |
create | Calendar | Tạo một sự kiện cả ngày mới có thể kéo dài nhiều ngày. |
create | Calendar | Tạo một sự kiện cả ngày mới. |
create | Calendar | Tạo một chuỗi sự kiện cả ngày mới. |
create | Calendar | Tạo một chuỗi sự kiện cả ngày mới. |
create | Calendar | Tạo một sự kiện mới. |
create | Calendar | Tạo một sự kiện mới. |
create | Calendar | Tạo một sự kiện từ nội dung mô tả tuỳ ý. |
create | Calendar | Tạo một chuỗi sự kiện mới. |
create | Calendar | Tạo một chuỗi sự kiện mới. |
delete | void | Xoá lịch vĩnh viễn. |
get | String | Lấy màu của lịch. |
get | String | Lấy nội dung mô tả của lịch. |
get | Calendar | Lấy sự kiện có mã nhận dạng đã cho. |
get | Calendar | Lấy chuỗi sự kiện có mã nhận dạng đã cho. |
get | Calendar | Lấy tất cả sự kiện xảy ra trong một phạm vi thời gian nhất định. |
get | Calendar | 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 các tiêu chí được chỉ định. |
get | Calendar | Lấy tất cả sự kiện diễn ra vào một ngày cụ thể. |
get | Calendar | Lấy tất cả sự kiện xảy ra vào một ngày nhất định và đáp ứng các tiêu chí được chỉ định. |
get | String | Lấy mã nhận dạng của lịch. |
get | String | Lấy tên của lịch. |
get | String | Lấy múi giờ của lịch. |
is | Boolean | Xác định xem lịch có bị ẩn trong giao diện người dùng hay không. |
is | Boolean | Xác định xem lịch có phải là lịch chính của người dùng có hiệu lực hay không. |
is | Boolean | Xác định xem bạn có phải là chủ sở hữu lịch hay không. |
is | Boolean | Xác định xem các sự kiện của lịch có xuất hiện trong giao diện người dùng hay không. |
set | Calendar | Đặt màu cho lịch. |
set | Calendar | Đặt nội dung mô tả cho lịch. |
set | Calendar | Đặt xem lịch có xuất hiện trên giao diện người dùng hay không. |
set | Calendar | Đặt tên cho lịch. |
set | Calendar | Đặt xem các sự kiện của lịch có xuất hiện trong giao diện người dùng hay không. |
set | Calendar | Đặt múi giờ của lịch. |
unsubscribe | void | Huỷ đăng ký theo dõi lịch của người dùng. |
Tài liệu chi tiết
createAllDayEvent(title, date)
Tạo một sự kiện cả ngày mới.
// Creates an all-day event for the moon landing and logs the ID. const 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 diễn ra sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua). |
Cầu thủ trả bóng
CalendarEvent – Sự kiện đã tạo.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
Tạo một 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. const 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. |
start | Date | Ngày bắt đầu sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua). |
end | Date | Ngày kết thúc sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua). Ngày kết thúc không bao gồm. |
Cầu thủ trả bóng
CalendarEvent – Sự kiện đã tạo.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
Tạo một 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. const 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. |
start | Date | Ngày bắt đầu sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua). |
end | Date | Ngày kết thúc sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua). Ngày kết thúc không bao gồm. |
options | Object | Một đố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 làm khách. |
send | Boolean | Có gửi lời mời qua email hay không (mặc định: false). |
Cầu thủ trả bóng
CalendarEvent – Sự kiện đã tạo.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
Tạo một sự kiện cả ngày mới.
// Creates an all-day event for the moon landing and logs the ID. const 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 diễn ra sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua). |
options | Object | Một đố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 làm khách. |
send | Boolean | Có gửi lời mời qua email hay không (mặc định: false). |
Cầu thủ trả bóng
CalendarEvent – Sự kiện đã tạo.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
Tạo một chuỗi sự kiện cả ngày mới.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const 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 |
start | Date | ngày diễn ra sự kiện đầu tiên trong chuỗi sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua) |
recurrence | Event | chế độ cài đặt định kỳ của loạt sự kiện |
Cầu thủ trả bóng
CalendarEventSeries – chuỗi sự kiện đã tạo
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
Tạo một chuỗi sự kiện cả ngày mới.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const 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 |
start | Date | ngày diễn ra sự kiện đầu tiên trong chuỗi sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua) |
recurrence | Event | chế độ cài đặt định kỳ của loạt sự kiện |
options | Object | một đố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 diễn ra 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 nên thêm làm khách vào các sự kiện trong chuỗi |
send | 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
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
Tạo một sự kiện mới.
Nếu bạn không chỉ định múi giờ, các giá trị thời gian sẽ được diễn giải trong bối 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.
// Creates an event for the moon landing and logs the ID. const 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 |
start | Date | ngày và giờ bắt đầu sự kiện |
end | Date | ngày và giờ kết thúc sự kiện |
Cầu thủ trả bóng
CalendarEvent – sự kiện đã tạo
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
Tạo một sự kiện mới.
Nếu bạn không chỉ định múi giờ, các giá trị thời gian sẽ được diễn giải trong bối 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.
// Creates an event for the moon landing and logs the ID. const 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 |
start | Date | ngày và giờ bắt đầu sự kiện |
end | Date | ngày và giờ kết thúc sự kiện |
options | Object | một đố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ả 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 làm khách |
send | 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
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
createEventFromDescription(description)
Tạo một sự kiện từ nội dung mô tả tuỳ ý.
Phần 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. const 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ả tự do về sự kiện |
Cầu thủ trả bóng
CalendarEvent – sự kiện đã tạo
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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. const 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 |
start | Date | ngày và giờ bắt đầu sự kiện đầu tiên trong chuỗi |
end | Date | ngày và giờ kết thúc sự kiện đầu tiên trong chuỗi |
recurrence | Event | chế độ cài đặt định kỳ của loạt sự kiện |
Cầu thủ trả bóng
CalendarEventSeries – chuỗi sự kiện đã tạo
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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. const 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 |
start | Date | ngày và giờ bắt đầu sự kiện đầu tiên trong chuỗi |
end | Date | ngày và giờ kết thúc sự kiện đầu tiên trong chuỗi |
recurrence | Event | chế độ cài đặt định kỳ của loạt sự kiện |
options | Object | một đố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 diễn ra 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 nên thêm làm khách vào các sự kiện trong chuỗi |
send | 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
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
getColor()
Lấy 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 – Một chuỗi màu thập lục phân ("#rrggbb").
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getDescription()
Lấy 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 – Nội dung mô tả về lịch này.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 thuộc 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ừ lịch đó. Chỉ gọi CalendarApp.getEventById(iCalId) sẽ trả về một sự kiện trong lịch mặc định.
Nhiều sự kiện có thể có cùng mã nhận dạng nếu thuộc một chuỗi sự kiện. Trong trường hợp này, phương thức này chỉ trả về sự kiện đầu tiên trong 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ã 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 sự kiện đó.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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ã nhận dạng đã cho. Nếu mã nhận dạng được cung cấp là cho một CalendarEvent duy nhất, thì CalendarEventSeries sẽ được trả về cùng với một sự kiện duy nhất trong chuỗi. Xin lưu ý rằng nếu chuỗi sự kiện thuộc về một lịch khác ngoài lịch mặc định, thì phương thức này phải được gọi từ Calendar đó; việc gọi trực tiếp CalendarApp.getEventSeriesById(iCalId) chỉ trả về một chuỗi sự kiện có 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 – Loạt phim có mã nhận dạng đã cho hoặc null nếu loạt phim không tồn tại hoặc người dùng không truy cập được.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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ề những sự kiện bắt đầu trong phạm vi thời gian đã cho, kết thúc trong phạm vi thời gian hoặc bao gồm phạm vi thời gian. Nếu bạn không chỉ định múi giờ, các giá trị thời gian sẽ được diễn giải trong bối 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. const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log(`Number of events: ${events.length}`);
Tham số
| Tên | Loại | Mô tả |
|---|---|---|
start | Date | thời điểm bắt đầu của phạm vi thời gian |
end | Date | kết thúc 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
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 các tiêu chí được chỉ định.
Phương thức này trả về các sự kiện bắt đầu trong phạm vi thời gian đã cho, kết thúc trong phạm vi thời gian hoặc bao gồm phạm vi thời gian. Nếu bạn không chỉ định múi giờ, các giá trị thời gian sẽ được diễn giải trong bối 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 việc lọc trên author, search hoặc statusFilters sẽ diễn ra sau khi áp dụng start và max. Điều này có nghĩa là số lượng sự kiện được trả về có thể ít hơn max, ngay cả khi có thêm các sự kiện đáp ứng tiêu chí.
// Determines how many events are happening in the next two hours that contain // the term "meeting". const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents( now, twoHoursFromNow, {search: 'meeting'}, ); Logger.log(`Number of events: ${events.length}`);
Tham số
| Tên | Loại | Mô tả |
|---|---|---|
start | Date | thời điểm bắt đầu của phạm vi thời gian |
end | Date | kết thúc phạm vi thời gian, không bao gồm |
options | Object | một đố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 cầ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 nhà tổ chức sự kiện |
search | String | cụm từ tìm kiếm toàn văn bản dùng để lọc kết quả |
status | Guest | một mảng trạng thái dùng để lọc kết quả |
Cầu thủ trả bóng
CalendarEvent[] – những sự kiện diễn ra trong phạm vi thời gian và đáp ứng các tiêu chí
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 diễn 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 ngày đã cho, kết thúc trong ngày hoặc bao gồm cả ngày.
Xin lưu ý rằng hệ thống chỉ sử dụng phần ngày của đối tượng Ngày và bỏ qua phần giờ. Ngày được hiểu là từ nửa đêm hôm đó đến nửa đêm ngày tiếp theo theo múi giờ của lịch.
// Determines how many events are happening today. const today = new Date(); const 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 các sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua) |
Cầu thủ trả bóng
CalendarEvent[] – những sự kiện xảy ra vào ngày đã cho
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 các tiêu chí được chỉ định.
Phương thức này trả về các sự kiện nếu chúng bắt đầu trong ngày đã cho, kết thúc trong ngày hoặc bao gồm cả ngày.
Xin lưu ý rằng hệ thống chỉ sử dụng phần ngày của đối tượng Ngày và bỏ qua phần giờ. Ngày được hiểu là từ nửa đêm hôm đó đến nửa đêm ngày tiếp theo theo múi giờ của lịch.
Xin lưu ý rằng việc lọc trên author, search hoặc statusFilters sẽ diễn ra sau khi áp dụng start và max. Điều này có nghĩa là số lượng sự kiện được trả về có thể ít hơn max, ngay cả khi có thêm các sự kiện đáp ứng tiêu chí.
// Determines how many events are happening today and contain the term // "meeting". const today = new Date(); const 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 các sự kiện (chỉ sử dụng ngày; thời gian sẽ bị bỏ qua) |
options | Object | các lựa 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 cầ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 nhà tổ chức sự kiện |
search | String | cụm từ tìm kiếm toàn văn bản dùng để lọc kết quả |
status | Guest | một mảng trạng thái dùng để lọc kết quả |
Cầu thủ trả bóng
CalendarEvent[] – những sự kiện xảy ra vào ngày đã cho và đáp ứng các tiêu chí
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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ã nhận dạng của lịch. Mã nhận dạng cho 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ã nhận dạng của lịch.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getName()
Lấy tên 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 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 của lịch này.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 ở định dạng "dài" (ví dụ: "America/New_York", như được Joda.org liệt kê).
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 lịch không bị ẩn.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 của người dùng có hiệu lực 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 của người dùng có hiệu lực; false nếu không.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 bạn có phải là chủ sở hữu lịch 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 bạn sở hữu lịch; false nếu không.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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ó xuất hiện 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 trên lịch xuất hiện trong giao diện người dùng; false nếu không
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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 | Một Calendar hoặc một chuỗi màu thập lục phân ("#rrggbb"). |
Cầu thủ trả bóng
Calendar – Lịch này dùng để xâu chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setDescription(description)
Đặt nội dung 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 | nội dung 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
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setHidden(hidden)
Đặt xem lịch có xuất hiện trên 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 lịch |
Cầu thủ trả bóng
Calendar – lịch này để tạo chuỗi
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có 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
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setSelected(selected)
Đặt xem các sự kiện của lịch có xuất hiện 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 các sự kiện của lịch trong giao diện người dùng; false để ẩn các sự kiện đó |
Cầu thủ trả bóng
Calendar – lịch này để tạo chuỗi
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
Đặt múi giờ của 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ả |
|---|---|---|
time | String | Múi giờ, được chỉ định ở định dạng "dài" (chẳng hạn như "America/New_York", theo danh sách của Joda.org). |
Cầu thủ trả bóng
Calendar – Lịch này dùng để xâu chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
unsubscribeFromCalendar()
Huỷ đăng ký theo dõi lịch của người dùng. Người dùng không thể huỷ đăng ký các lịch có trong danh sách Lịch của tôi. Họ có thể huỷ đăng ký theo dõi các lịch có trong phần Lịch khác.
// 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 bạn sở hữu
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds