Эта страница переведена с помощью Cloud Translation API.

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`	Этаг коллекции.
`items[]`	`list`	Список пользовательских настроек.
`nextPageToken`	`string`	Токен, используемый для доступа к следующей странице этого результата. Опускается, если дальнейшие результаты недоступны, и в этом случае предоставляется `nextSyncToken` .
`nextSyncToken`	`string`	Токен, используемый позднее для получения только тех записей, которые изменились с момента возврата этого результата. Опускается, если доступны дополнительные результаты; в этом случае предоставляется `nextPageToken` .

Примеры

Примечание. Примеры кода, доступные для этого метода, не представляют все поддерживаемые языки программирования (список поддерживаемых языков см. на странице клиентских библиотек ).

Ява Питон PHP Руби

Использует клиентскую библиотеку 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 .

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

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

Использует клиентскую библиотеку PHP .

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

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

Использует клиентскую библиотеку Ruby .

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