Cette page a été traduite par l'API Cloud Translation.

Settings: list

Renvoie tous les paramètres utilisateur de l'utilisateur authentifié. Essayez maintenant ou consultez un exemple.

Requête

Requête HTTP

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

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de requête facultatifs
`maxResults`	`integer`	Nombre maximal d'entrées renvoyées sur une page de résultats. Par défaut, la valeur est de 100 entrées. La taille de la page ne peut jamais être supérieure à 250 entrées. Facultatif.
`pageToken`	`string`	Jeton spécifiant la page de résultats à renvoyer. Facultatif.
`syncToken`	`string`	Jeton obtenu à partir du champ `nextSyncToken` renvoyé sur la dernière page de résultats de la requête de liste précédente. Ainsi, le résultat de cette demande de liste ne contiendra que les entrées qui ont été modifiées depuis. Si la valeur `syncToken` expire, le serveur renvoie un code de réponse 410 GONE, et le client doit effacer son espace de stockage et effectuer une synchronisation complète sans aucun `syncToken`. En savoir plus sur la synchronisation incrémentielle. Facultatif. La valeur par défaut consiste à renvoyer toutes les entrées.

Autorisation

Une autorisation est nécessaire pour cette requête avec au moins l'un des champs d'application suivants:

Définition du champ d'application
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.settings.readonly`

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}

Nom de propriété	Valeur	Description
`kind`	`string`	Type de collection ("`calendar#settings`").
`etag`	`etag`	ETag de la collection.
`items[]`	`list`	Liste des paramètres utilisateur.
`nextPageToken`	`string`	Jeton utilisé pour accéder à la page suivante de ce résultat. Omis si aucun autre résultat n'est disponible, auquel cas `nextSyncToken` est fourni.
`nextSyncToken`	`string`	Jeton utilisé ultérieurement pour récupérer uniquement les entrées qui ont été modifiées depuis le renvoi de ce résultat. Omis si d'autres résultats sont disponibles, auquel cas `nextPageToken` est fourni.

Exemples

Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).

Java

Utilise la bibliothèque cliente 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

Utilise la bibliothèque cliente Python.

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

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

PHP

Utilise la bibliothèque cliente PHP.

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

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

Ruby

Utilise la bibliothèque cliente Ruby.

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

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.