Settings: list

認証されたユーザーのすべてのユーザー設定を返します。 今すぐ試すまたは例を見る。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 値 説明
省略可能なクエリ パラメータ
maxResults integer 1 つの結果ページで返されるエントリの最大数です。デフォルトでは、値は 100 エントリです。ページサイズは 250 エントリを超えることはできません。省略可能。
pageToken string どの結果ページを返すかを指定するトークン。省略可能。
syncToken string 前のリスト リクエストの結果の最後のページで返された nextSyncToken フィールドから取得したトークン。このリスト リクエストの結果には、それ以降に変更されたエントリのみが含まれます。
syncToken が期限切れになると、サーバーは 410 GONE レスポンス コードを返します。クライアントはストレージを消去し、syncToken を使用せずに完全な同期を実行する必要があります。
増分同期の詳細については、こちらをご覧ください。
省略可。デフォルトでは、すべてのエントリが返されます。

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。

範囲
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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。