Settings: list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Affiche tous les paramètres utilisateur pour l'utilisateur authentifié.
Essayer maintenant
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 100 entrées. La taille de la page ne peut jamais dépasser 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. Le résultat de cette requête de liste ne contient alors que les entrées qui ont changé depuis. Si l'syncToken expire, le serveur répond avec un code de réponse 410 GONE. Le client doit alors vider son espace de stockage et effectuer une synchronisation complète sans syncToken . En savoir plus sur la synchronisation incrémentielle Facultatif. Par défaut, toutes les entrées sont renvoyées.
|
Autorisation
Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants:
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 |
Remarques |
kind |
string |
Type de la 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 ne récupérer que les entrées qui ont changé depuis le renvoi de ce résultat. Omis si d'autres résultats sont disponibles, auquel cas nextPageToken est fourni. |
|
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Settings: list\n\n| **Note:** Requires [authorization](#auth).\n\nReturns all user settings for the authenticated user.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/calendar/v3/users/me/settings\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Optional query parameters** |||\n| `maxResults` | `integer` | Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. |\n| `pageToken` | `string` | Token specifying which result page to return. Optional. |\n| `syncToken` | `string` | Token obtained from the `nextSyncToken` field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the `syncToken` expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any `syncToken`. [Learn more](/workspace/calendar/api/guides/sync) about incremental synchronization. Optional. The default is to return all entries. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|--------------------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar.readonly` |\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.settings.readonly` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"calendar#settings\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"nextSyncToken\": string,\n \"items\": [\n settings Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|-----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Type of the collection (\"`calendar#settings`\"). | |\n| `etag` | `etag` | Etag of the collection. | |\n| `items[]` | `list` | List of user settings. | |\n| `nextPageToken` | `string` | Token used to access the next page of this result. Omitted if no further results are available, in which case `nextSyncToken` is provided. | |\n| `nextSyncToken` | `string` | Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case `nextPageToken` is provided. | |\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]