Settings: list

Requires authorization 承認が必要

Returns all user settings for the authenticated user. Try it now or see an example. 認証されたユーザーのすべてのユーザー設定を返します。今すぐ試す、例を見てください

Request要求

HTTP requestHTTPリクエスト

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

Parametersパラメーター

Parameter nameパラメータ名 Value Description説明
Optional query parametersオプションのクエリパラメータ
maxResults integer Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. 1つの結果ページに返される最大エントリ数。デフォルトでは、値は100エントリです。ページサイズは250エントリを超えることはできません。オプションです。
pageToken string Token specifying which result page to return. Optional. どの結果ページを返すかを指定するトークン。オプションです。
syncToken string Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries. nextSyncToken前回のリスト要求の結果の最後のページに返され たフィールドから取得したトークン。このリスト要求の結果に、それ以降に変更されたエントリだけが含まれるようにします。
場合はsyncToken有効期限が切れると、サーバは410 GONE応答コードで応答すると、クライアントは、そのストレージをクリアし、任意のせずに完全な同期を実行する必要がありますsyncToken。増分同期の
詳細を学んでください
オプションです。デフォルトではすべてのエントリが返されます。

Authorization承認

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).この要求には、以下の範囲のうちの少なくとも1つを使用した許可が必要です(認証および許可について詳しく読む)。

Scope範囲
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly

Request bodyリクエストボディ

Do not supply a request body with this method.このメソッドでリクエストボディを指定しないでください。

Response応答

If successful, this method returns a response body with the following structure:成功した場合、このメソッドは以下の構造を持つレスポンスボディを返します。

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}
Property nameプロパティ名 Value Description説明 Notesノート
kind string Type of the collection ("calendar#settings").コレクションの種類( " calendar#settings")。
etag etag Etag of the collection.コレクションのタグ。
items[] list List of user settings.ユーザー設定の一覧
nextPageToken string Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.この結果の次のページにアクセスするためのトークン。それ以上の結果が得られない場合は省略され、その場合nextSyncTokenは提供されます。
nextSyncToken string Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.この結果が返された後に変更されたエントリのみを取得するために後で使用されるトークン。さらなる結果が利用可能である場合nextPageTokenは省略され、その場合は提供される。

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).注:このメソッドで使用可能なコード例は、サポートされているすべてのプログラミング言語を表しているわけではありません(サポートされている言語のリストについては、クライアントライブラリのページ参照してください)。

Java

Uses the Java client library.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

Uses the Python client library.Pythonクライアントライブラリを使用します

settings = service.settings().list().execute()
for setting in settings['items']:
  print '%s: %s' % (setting['id'], setting['value'])

PHP

Uses the PHP client library.PHPクライアントライブラリを使用します

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

Rubyルビー

Uses the Ruby client library.Rubyクライアントライブラリを使用します

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

Try it!それを試してみてください!

Use the APIs Explorer below to call this method on live data and see the response. 以下のAPI Explorerを使用して、ライブデータに対してこのメ??ソッドを呼び出して応答を確認してください。

関連記事

スポンサーリンク

基本的な特徴

ホームページ製作・web系アプリ系の製作案件募集中です。

上に戻る