Google Calendar API

Settings: list

Requires authorization

Returns all user settings for the authenticated user. Try it now or see an example.

Request

HTTP request

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

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

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,
  "items": [
    settings Resource
  ]
}
Property name Value Description Notes
kind string Type of the collection ("calendar#settings").
etag etag Etag of the collection.
items[] list List of user settings.

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.

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

for (Setting setting : settings.getItems()) {
  System.out.println(setting.getId() + ": " + setting.getValue());
}

Python

Uses the Python client library.

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

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

PHP

Uses the PHP client library.

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

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

Ruby

Uses the Ruby client library.

result = client.execute(:api_method => service.settings.list)
settings = result.data.items
settings.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.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.