要求
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 ] }
屬性名稱 | 值 | 說明 | Notes |
---|---|---|---|
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 針對即時資料呼叫這個方法,並查看回應。