CalendarList: list

Renvoie les agendas de la liste d'agendas de l'utilisateur. Essayer maintenant

Requête

Requête HTTP

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

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.
minAccessRole string Rôle d'accès minimal de l'utilisateur dans les entrées renvoyées. Facultatif. Par défaut, aucune restriction n'est appliquée.

Les valeurs acceptées sont les suivantes :
  • "freeBusyReader": l'utilisateur peut lire les informations de disponibilité.
  • "owner": l'utilisateur peut lire et modifier les événements et les listes de contrôle d'accès.
  • "reader": l'utilisateur peut lire les événements qui ne sont pas privés.
  • "writer": l'utilisateur peut lire et modifier les événements.
pageToken string Jeton spécifiant la page de résultats à renvoyer. Facultatif.
showDeleted boolean Indique si les entrées de liste d'agenda supprimées doivent être incluses dans le résultat. Facultatif. La valeur par défaut est "False" (faux).
showHidden boolean Indique si les entrées masquées doivent être affichées. Facultatif. La valeur par défaut est "False" (faux).
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 seuls des champs en lecture seule, tels que des propriétés de calendrier ou des ACL, ont été modifiés, l'entrée ne sera pas renvoyée. Toutes les entrées supprimées et masquées depuis la précédente requête de liste seront toujours incluses dans l'ensemble de résultats. Il n'est pas autorisé de définir showDeleted ni showHidden sur "False".
Pour garantir la cohérence de l'état client, le paramètre de requête minAccessRole ne peut pas être spécifié avec nextSyncToken.
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.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.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#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Nom de propriété Valeur Description Remarques
kind string Type de la collection ("calendar#calendarList").
etag etag ETag de la collection.
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.
items[] list Agendas figurant dans la liste des agendas de l'utilisateur.
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.