Settings: list

Kimliği doğrulanmış kullanıcı için tüm kullanıcı ayarlarını döndürür. Şimdi deneyin veya bir örneğe göz atın.

İstek

HTTP isteği

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

Parametreler

Parametre adı Değer Açıklama
İsteğe bağlı sorgu parametreleri
maxResults integer Bir sonuç sayfasında döndürülen maksimum giriş sayısı. Varsayılan olarak bu değer 100 giriştir. Sayfa boyutu hiçbir zaman 250'den fazla giriş olamaz. İsteğe bağlı.
pageToken string Döndürülecek sonuç sayfasını belirten jeton. İsteğe bağlı.
syncToken string nextSyncToken alanından alınan jeton, önceki liste isteğinden sonuçların son sayfasında döndürülen jeton. Bu liste isteğinin sonucunun yalnızca o zamandan sonra değişen girişleri içermesini sağlar.
syncToken süresi dolarsa, sunucu 410 GONE yanıt koduyla yanıt verir ve istemcinin depolama alanını temizlemesi ve syncToken olmadan tam senkronizasyon gerçekleştirmesi gerekir.
Artımlı senkronizasyon hakkında daha fazla bilgi edinin.
İsteğe bağlı. Varsayılan ayar, tüm girişleri döndürmektir.

Yetkilendirme

Bu istek, aşağıdaki kapsamların en az biriyle yetkilendirme gerektiriyor:

Kapsam
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly

Daha fazla bilgi edinmek için kimlik doğrulama ve yetkilendirme sayfasına göz atın.

İstek içeriği

Bu yöntemle istek gövdesi sağlamayın.

Yanıt

Başarılı olursa bu yöntem, aşağıdaki yapıya sahip bir yanıt gövdesi döndürür:

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}
Mülk adı Değer Açıklama Notlar
kind string Koleksiyonun türü ("calendar#settings").
etag etag Koleksiyonun Etag'i.
items[] list Kullanıcı ayarları listesi.
nextPageToken string Bu sonucun sonraki sayfasına erişmek için kullanılan jeton. Başka sonuç yoksa atlanır. Bu durumda nextSyncToken sağlanır.
nextSyncToken string Daha sonra, yalnızca bu sonucun döndürülmesinden bu yana değişen girişleri almak için kullanılan jeton. Başka sonuçlar varsa atlanır. Bu durumda nextPageToken sağlanır.

Örnekler

Not: Bu yöntem için kullanıma sunulan kod örnekleri, desteklenen tüm programlama dillerini kapsamaz (Desteklenen dillerin listesi için istemci kitaplıkları sayfasını inceleyin).

Java

Java istemci kitaplığını kullanır.

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 istemci kitaplığını kullanır.

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

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

PHP

PHP istemci kitaplığını kullanır.

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

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

Ruby

Ruby istemci kitaplığını kullanır.

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

Deneyin!

Canlı verilerde bu yöntemi çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın.