CalendarList: update

Cập nhật lịch hiện có trên 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

PUT https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId

Các tham số

Tên thông số Giá trị Nội dung mô tả
Tham số đường dẫn
calendarId string Giá trị nhận dạng lịch. Để truy xuất mã lịch, hãy gọi phương thức calendarList.list. Nếu bạn muốn truy cập vào lịch chính của người dùng đang đăng nhập, hãy sử dụng từ khoá "primary".
Tham số truy vấn không bắt buộc
colorRgbFormat boolean Liệu có sử dụng các 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 tuỳ chọn 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 uỷ quyền với 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ị Nội dung mô tả Ghi 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. Để thiết lập hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong các 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 nhập trong phần calendar của định nghĩa về màu sắc (xem điểm cuối của màu). Thuộc tính này được thay thế bằng các thuộc tính backgroundColor và foregroundColor, đồng thời có thể bị 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ể sử dụng là:
  • "email" – Lời nhắc được gửi qua email.
  • "popup" – Lời nhắc được gửi qua một 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.

 có thể ghi
defaultReminders[].minutes integer Số phút trước khi bắt đầu sự kiện khi 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. Để thiết lập hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong các thông số của phương thức insert, update và patch. Không bắt buộc. có thể ghi
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ị sẽ là true. có thể ghi
notificationSettings object 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à:
  • "email" – Thông báo được gửi qua email.

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ể sử dụng là:
  • "eventCreation" – Thông báo được gửi khi có một sự kiện mới được thêm vào lịch.
  • "eventChange" – Thông báo được gửi khi một sự kiện có sự 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 một người tham dự phản hồi lời mời tham gia sự kiện.
  • "agenda" – Chương trình làm việc gồm 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.

 có thể ghi
selected boolean Liệu nội dung lịch có hiển thị 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 Phầ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

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();

// Retrieve the calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

// Make a change
calendarListEntry.setColorId("newColorId");

// Update the altered entry
CalendarListEntry updatedCalendarListEntry =
    service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute();

System.out.println(updatedCalendarListEntry.getEtag());

Python

Dùng thư viện ứng dụng Python.

# First retrieve the calendarListEntry from the API.
calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()
calendar_list_entry['colorId'] = 'newColorId'

updated_calendar_list_entry = service.calendarList().update(
    calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute()

print created_calendar_list_entry['etag']

1.199

Sử dụng thư viện ứng dụng PHP.

// First retrieve the calendarListEntry from the API.
$calendarListEntry = $service->calendarList->get('calendarId');
$calendarListEntry->setColorId('newColorId');

$updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry);

echo $updatedCalendarListEntry->getEtag();

Ruby

Sử dụng thư viện ứng dụng hồng ngọc.

calendar_list_entry = client.get_calendar_list('calendarId')
calendar_list_entry.colorId = 'newColorId'
result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry)
print result.etag

Hãy dùng thử!

Hãy sử dụng APIs Explorer 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.