Trang này được dịch bởi Cloud Translation API.

CalendarList: insert

Chèn một 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

Thông số

Tên thông số	Giá trị	Mô tả
Thông số truy vấn không bắt buộc
`colorRgbFormat`	`boolean`	Liệu có nên sử dụng các trường `foregroundColor` và `backgroundColor` để viết màu lịch (RGB) hay không. Nếu bạn sử 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 tuỳ chọn 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 yêu cầu uỷ quyền với ít nhất một trong các phạm vi sau:

Phạm vi
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.calendarlist`

Để 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 phần 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 các tham số của phương thức chèn, cập nhật và sửa lỗi. Không bắt buộc.	writable
`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 thuộc tính `backgroundColor` và `foregroundColor` và có thể bị bỏ qua khi sử dụng các thuộc tính này. Không bắt buộc.	writable
`defaultReminders[]`	`list`	Lời nhắc mặc định mà người dùng đã xác thực có cho lịch này.	writable
`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à: "`email`" – Lời nhắc được gửi qua email. "`popup`" – Lời nhắc được gửi qua cửa sổ bật lên trên giao diện người dùng. Bắt buộc khi thêm lời nhắc.	writable
`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. 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.	writable
`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 các tham số của phương thức chèn, cập nhật và sửa lỗi. Không bắt buộc.	writable
`hidden`	`boolean`	Liệu lịch có bị ẩn khỏi danh sách hay không. Không bắt buộc. Thuộc tính này chỉ được trả về khi lịch bị ẩn, trong trường hợp này, giá trị là `true`.	writable
`notificationSettings`	`object`	Thông báo mà người dùng đã xác thực đang nhận được cho lịch này.	writable
`notificationSettings.notifications[].method`	`string`	Phương thức dùng để phân phối thông báo. Giá trị có thể dùng là: "`email`" – Thông báo được gửi qua email. Bắt buộc khi thêm thông báo.	writable
`notificationSettings.notifications[].type`	`string`	Loại thông báo. Các giá trị có thể có là: "`eventCreation`" – Thông báo được gửi khi một sự kiện mới được đưa vào lịch. "`eventChange`" – Thông báo được gửi khi một sự kiện thay đổi. "`eventCancellation`" – Thông báo được gửi khi một sự kiện bị huỷ. "`eventResponse`" – Thông báo được gửi khi người tham dự phản hồi lời mời tham dự sự kiện. "`agenda`" – Một chương trình làm việc với các sự kiện trong ngày (được gửi vào buổi sáng). Bắt buộc khi thêm thông báo.	writable
`selected`	`boolean`	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.	writable
`summaryOverride`	`string`	Thông tin 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.	writable

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 phần 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

Sử 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

Sử 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

Sử 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

Sử 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ử!

Sử dụng 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.