Settings: list

Trả về tất cả chế độ cài đặt người dùng cho người dùng đã xác thực. Thử ngay hoặc xem ví dụ.

Yêu cầu

Yêu cầu HTTP

GET https://www.googleapis.com/calendar/v3/users/me/settings

Các tham số

Tên thông số Giá trị Nội dung mô tả
Tham số truy vấn không bắt buộc
maxResults integer Số mục nhập tối đa được trả về trên một trang kết quả. Theo mặc định, giá trị này là 100 mục nhập. Kích thước trang không bao giờ được lớn hơn 250 mục nhập. Không bắt buộc.
pageToken string Mã thông báo chỉ định trang kết quả cần trả về. Không bắt buộc.
syncToken string Mã thông báo thu được từ trường nextSyncToken được trả về trên trang kết quả cuối cùng của yêu cầu danh sách trước đó. Điều này làm cho kết quả của yêu cầu danh sách này chỉ chứa các mục nhập đã thay đổi kể từ đó.
Nếu syncToken hết hạn, máy chủ sẽ phản hồi bằng mã phản hồi 410 GONE và ứng dụng sẽ giải phóng bộ nhớ rồi đồng bộ hoá toàn bộ mà không có syncToken nào.
Tìm hiểu thêm về quá trình đồng bộ hoá gia tăng.
Không bắt buộc. Tuỳ chọn mặc định là trả về tất cả các mục nhập.

Ủy quyền

Yêu cầu này cần được 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.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly

Để 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

Đừng cung cấp nội dung yêu cầu bằng phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một nội dung phản hồi có cấu trúc như sau:

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}
Tên tài sản Giá trị Nội dung mô tả Ghi chú
kind string Loại bộ sưu tập ("calendar#settings").
etag etag Thẻ của bộ sưu tập.
items[] list Danh sách chế độ cài đặt người dùng.
nextPageToken string Mã thông báo được dùng để truy cập vào trang tiếp theo của kết quả này. Được bỏ qua nếu không có thêm kết quả nào, trong trường hợp này, nextSyncToken sẽ được cung cấp.
nextSyncToken string Mã thông báo được sử dụng sau đó để chỉ truy xuất các mục nhập đã thay đổi kể từ khi kết quả này được trả về. Bỏ qua nếu có thêm kết quả, trong trường hợp này, nextPageToken sẽ được cung cấp.

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.Setting;
import com.google.api.services.calendar.model.Settings;
// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over all user settings
Settings settings = service.settings().list().execute();

for (Setting setting : settings.getItems()) {
  System.out.println(setting.getId() + ": " + setting.getValue());
}

Python

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

settings = service.settings().list().execute()

for setting in settings['items']:
  print '%s: %s' % (setting['id'], setting['value'])

1.199

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

$settings = $service->settings->listSettings();

foreach ($settings->getItems() as $setting) {
  echo $setting->getId() . ': ' . $setting->getValue();
}

Ruby

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

result = client.list_settings
result.items.each do |e|
  print e.id + ": " + e.value + "\n"
end

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.