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 .

Примеры

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

Ява

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

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

Попытайся!

Используйте обозреватель API ниже, чтобы вызвать этот метод для оперативных данных и просмотреть ответ.