Chèn lịch hiện có vào danh sách lịch của người dùng. Thử ngay hoặc xem ví dụ.
Yêu cầu
Yêu cầu HTTP
POST https://www.googleapis.com/calendar/v3/users/me/calendarList
Tham số
Tên thông số | Giá trị | Mô tả |
---|---|---|
Tham số truy vấn không bắt buộc | ||
colorRgbFormat |
boolean |
Liệu có sử dụng trường foregroundColor và backgroundColor để ghi màu lịch (RGB) hay không. Nếu bạn dùng tính năng này, trường colorId dựa trên chỉ mục sẽ tự động được đặt thành lựa chọn so khớp phù hợp nhất. Không bắt buộc. Giá trị mặc định là False.
|
Ủy quyền
Yêu cầu này cần được cho phép có phạm vi sau:
Phạm vi |
---|
https://www.googleapis.com/auth/calendar |
Để biết thêm thông tin, hãy xem trang xác thực và uỷ quyền.
Nội dung yêu cầu
Trong nội dung yêu cầu, hãy cung cấp tài nguyên CalendarList với các thuộc tính sau:
Tên tài sản | Giá trị | Mô tả | Ghi chú |
---|---|---|---|
Thuộc tính bắt buộc | |||
id |
string |
Giá trị nhận dạng của lịch. | |
Thuộc tính không bắt buộc | |||
backgroundColor |
string |
Màu chính của lịch ở định dạng thập lục phân "#0088aa ". Thuộc tính này thay thế thuộc tính colorId dựa trên chỉ mục. Để đặt hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong thông số của phương thức insert, update và patch. Không bắt buộc. |
có thể ghi |
colorId |
string |
Màu của lịch. Đây là mã nhận dạng tham chiếu đến một mục trong phần calendar của định nghĩa màu (xem điểm cuối màu). Thuộc tính này được thay thế bằng các thuộc tính backgroundColor và foregroundColor và bạn có thể bỏ qua khi sử dụng các thuộc tính này. Không bắt buộc. |
có thể ghi |
defaultReminders[] |
list |
Lời nhắc mặc định mà người dùng đã xác thực có đối với lịch này. | có thể ghi |
defaultReminders[].method |
string |
Phương thức mà lời nhắc này sử dụng. Các giá trị có thể có là:
Bắt buộc khi thêm lời nhắc. |
có thể ghi |
defaultReminders[].minutes |
integer |
Số phút trước khi bắt đầu sự kiện mà lời nhắc sẽ kích hoạt. Các giá trị hợp lệ nằm trong khoảng từ 0 đến 40320 (4 tuần tính bằng phút). Bắt buộc khi thêm lời nhắc. |
có thể ghi |
foregroundColor |
string |
Màu nền trước của lịch ở định dạng thập lục phân "#ffffff ". Thuộc tính này thay thế thuộc tính colorId dựa trên chỉ mục. Để đặt hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong thông số của phương thức insert, update và patch. Không bắt buộc. |
có thể ghi |
notificationSettings |
object |
Các thông báo mà người dùng đã xác thực nhận được đối với lịch này. | có thể ghi |
notificationSettings.notifications[].method |
string |
Phương thức được dùng để gửi thông báo. Giá trị có thể là:
Bắt buộc khi thêm thông báo. |
có thể ghi |
notificationSettings.notifications[].type |
string |
Loại thông báo. Các giá trị có thể có là:
Bắt buộc khi thêm thông báo. |
có thể ghi |
selected |
boolean |
Liệu nội dung lịch có xuất hiện trong giao diện người dùng của lịch hay không. Không bắt buộc. Giá trị mặc định là False. | có thể ghi |
summaryOverride |
string |
Bản tóm tắt mà người dùng đã xác thực đã đặt cho lịch này. Không bắt buộc. | có thể ghi |
Phản hồi
Nếu thành công, phương thức này sẽ trả về một tài nguyên CalendarList trong nội dung phản hồi.
Ví dụ
Lưu ý: Các đoạn mã mẫu của phương thức này không phải là ví dụ cho mọi ngôn ngữ lập trình được hỗ trợ (xem trang thông tin về các thư viện dùng cho ứng dụng để biết danh sách các ngôn ngữ được hỗ trợ).
Java
Dùng thư viện ứng dụng Java.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.CalendarListEntry; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Create a new calendar list entry CalendarListEntry calendarListEntry = new CalendarListEntry(); calendarListEntry.setId("calendarId"); // Insert the new calendar list entry CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute(); System.out.println(createdCalendarListEntry.getSummary());
Python
Dùng thư viện ứng dụng Python.
calendar_list_entry = { 'id': 'calendarId' } created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute() print created_calendar_list_entry['summary']
PHP
Dùng thư viện ứng dụng PHP.
$calendarListEntry = new Google_Service_Calendar_CalendarListEntry(); $calendarListEntry->setId("calendarId"); $createdCalendarListEntry = $service->calendarList->insert($calendarListEntry); echo $createdCalendarListEntry->getSummary();
Ruby
Dùng thư viện ứng dụng Ruby.
entry = Google::Apis::CalendarV3::CalendarListEntry.new( id: 'calendarId' ) result = client.insert_calendar_list(entry) print result.summary
Hãy dùng thử!
Hãy sử dụng APIs Explorer (Trình khám phá API) bên dưới để gọi phương thức này trên dữ liệu trực tiếp và xem phản hồi.