Settings: list

返回已验证用户的所有用户设置。 立即试用或查看示例。

请求

HTTP 请求

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

参数

参数名称 值 说明
可选的查询参数
maxResults integer 一个结果页上返回的条目数上限。默认值为 100 个条目。页面大小不得超过 250 个条目。可选。
pageToken string 用于指定要返回的结果页面的令牌。可选。
syncToken string 从上一个列表请求结果最后一页返回的 nextSyncToken 字段获得的令牌。它会使此列表请求的结果仅包含之后发生了更改的条目。
如果 syncToken 过期，服务器将返回 410 GONE 响应代码，而客户端应清除其存储空间，并在不出现任何 syncToken 的情况下执行完全同步。
详细了解增量同步。
可选。默认值为返回所有条目。

授权

此请求需要获得以下至少一个范围的授权：

范围
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly

如需了解详情，请参阅身份验证和授权页面。

请求正文

使用此方法时请勿提供请求正文。

响应

如果成功，此方法将返回采用以下结构的响应正文：

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}
属性名称 值 说明 备注
kind string 集合的类型（“calendar#settings”）。
etag etag 集合的 ETag。
items[] list 用户设置列表。
nextPageToken string 用于访问此结果的下一页的令牌。如果没有其他结果，则省略，在这种情况下提供了 nextSyncToken。
nextSyncToken string 稍后用于检索自此结果返回后更改的条目的令牌。如果有其他结果，则省略，在这种情况下提供了 nextPageToken。

示例

注意：此方法的代码示例并未列出所有受支持的编程语言（请参阅客户端库页面，查看受支持的语言列表）。

Java

使用 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

使用 Python 客户端库。

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

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

PHP

使用 PHP 客户端库。

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

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

Ruby

使用 Ruby 客户端库。

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

试试看！

使用下面的 API Explorer 对实际数据调用此方法，然后查看响应。