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

試試看！

您可以使用下方的 APIs Explorer，針對即時資料呼叫這個方法，然後查看回應。