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

Events: list

Renvoie les événements de l'agenda spécifié. Essayer maintenant

Requête

Requête HTTP

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
`calendarId`	`string`	Identifiant de l'agenda. Pour récupérer les ID d'agenda, appelez la méthode calendarList.list. Si vous souhaitez accéder à l'agenda principal de l'utilisateur actuellement connecté, utilisez le mot clé "`primary`".
Paramètres de requête facultatifs
`alwaysIncludeEmail`	`boolean`	Obsolète et ignoré.
`eventTypes`	`string`	Types d'événements à renvoyer. Facultatif. Ce paramètre peut être répété plusieurs fois pour renvoyer des événements de différents types. Si elle n'est pas définie, tous les types d'événements sont renvoyés. Les valeurs acceptées sont les suivantes : "`birthday`" : événements spéciaux sur toute la journée qui se répètent chaque année. "`default`" : événements réguliers. "`focusTime`" : événements "Moment de concentration". "`fromGmail`" : événements ajoutés à partir de Gmail. "`outOfOffice`" : absences du bureau. "`workingLocation`" : événements liés au lieu de travail.
`iCalUID`	`string`	Spécifie un ID d'événement au format iCalendar à fournir dans la réponse. Facultatif. Utilisez cette option si vous souhaitez rechercher un événement par son ID iCalendar.
`maxAttendees`	`integer`	Nombre maximal de participants à inclure dans la réponse. Si le nombre de participants est supérieur à celui spécifié, seul le participant est renvoyé. Facultatif.
`maxResults`	`integer`	Nombre maximal d'événements renvoyés sur une page de résultats. Le nombre d'événements sur la page résultante peut être inférieur à cette valeur, voire nul, même si d'autres événements correspondent à la requête. Les pages incomplètes peuvent être détectées par un champ `nextPageToken` non vide dans la réponse. La valeur par défaut est de 250 événements. La taille de la page ne peut jamais dépasser 2 500 événements. Facultatif.
`orderBy`	`string`	Ordre des événements renvoyés dans le résultat. Facultatif. La valeur par défaut est un ordre stable non spécifié. Les valeurs acceptées sont les suivantes : "`startTime`" : trier par date/heure de début (ordre croissant). Cette option n'est disponible que lorsque vous interrogez des événements individuels (c'est-à-dire lorsque le paramètre `singleEvents` est défini sur "True"). "`updated`" : tri par date/heure de la dernière modification (ordre croissant).
`pageToken`	`string`	Jeton spécifiant la page de résultats à renvoyer. Facultatif.
`privateExtendedProperty`	`string`	Contrainte de propriétés étendues spécifiée sous la forme propertyName=value. Ne correspond qu'aux propriétés privées. Ce paramètre peut être répété plusieurs fois pour renvoyer les événements qui correspondent à toutes les contraintes données.
`q`	`string`	Termes de recherche en texte libre permettant de trouver les événements qui correspondent à ces termes dans les champs suivants : `summary` `description` `location` `displayName` du participant `email` du participant de l'organisateur `displayName` de l'organisateur `email` `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` Ces termes de recherche correspondent également aux mots clés prédéfinis pour toutes les traductions des titres à afficher des événements "Lieu de travail", "Absent" et "Temps de concentration". Par exemple, si vous recherchez "Bureau" ou "Office", vous obtiendrez des événements de type `officeLocation`, tandis que si vous recherchez "Absent" ou "Abwesend", vous obtiendrez des événements d'absence. Facultatif.
`sharedExtendedProperty`	`string`	Contrainte de propriétés étendues spécifiée sous la forme propertyName=value. Ne correspond qu'aux propriétés partagées. Ce paramètre peut être répété plusieurs fois pour renvoyer les événements qui correspondent à toutes les contraintes données.
`showDeleted`	`boolean`	Indique s'il faut inclure les événements supprimés (avec `status` égal à "`cancelled`") dans le résultat. Les instances annulées d'événements récurrents (mais pas l'événement récurrent sous-jacent) seront toujours incluses si `showDeleted` et `singleEvents` sont définis sur "False". Si `showDeleted` et `singleEvents` sont tous les deux définis sur "True", seules les instances uniques d'événements supprimés (mais pas les événements récurrents sous-jacents) sont renvoyées. Facultatif. La valeur par défaut est "False" (faux).
`showHiddenInvitations`	`boolean`	Indique si les invitations masquées doivent être incluses dans le résultat. Facultatif. La valeur par défaut est "False" (faux).
`singleEvents`	`boolean`	Indique s'il faut développer les événements récurrents en instances et ne renvoyer que les événements ponctuels uniques et les instances d'événements récurrents, mais pas les événements récurrents sous-jacents eux-mêmes. 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 que les entrées qui ont été modifiées depuis. Tous les événements supprimés depuis la précédente demande de liste figureront toujours dans l'ensemble de résultats. Il n'est pas autorisé de définir `showDeleted` sur "False". Plusieurs paramètres de requête ne peuvent pas être spécifiés avec `nextSyncToken` pour assurer la cohérence de l'état du client. Voici quelques exemples : `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` Tous les autres paramètres de requête doivent être identiques à ceux de la synchronisation initiale pour éviter tout comportement indéfini. Si le `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.
`timeMax`	`datetime`	Limite supérieure (exclusive) de l'heure de début d'un événement à filtrer. Facultatif. Par défaut, le filtrage par heure de début n'est pas activé. Doit être un code temporel RFC3339 avec un décalage de fuseau horaire obligatoire, par exemple 2011-06-03T10:00:00-07:00 ou 2011-06-03T10:00:00Z. Les millisecondes peuvent être fournies, mais elles sont ignorées. Si `timeMin` est défini, `timeMax` doit être supérieur à `timeMin`.
`timeMin`	`datetime`	Limite inférieure (exclusive) de l'heure de fin d'un événement à filtrer. Facultatif. Par défaut, le filtrage par heure de fin n'est pas activé. Doit être un code temporel RFC3339 avec un décalage de fuseau horaire obligatoire, par exemple 2011-06-03T10:00:00-07:00 ou 2011-06-03T10:00:00Z. Les millisecondes peuvent être fournies, mais elles sont ignorées. Si `timeMax` est défini, `timeMin` doit être inférieur à `timeMax`.
`timeZone`	`string`	Fuseau horaire utilisé dans la réponse. Facultatif. La valeur par défaut est le fuseau horaire de l'agenda.
`updatedMin`	`datetime`	Limite inférieure de l'heure de la dernière modification d'un événement (sous forme de code temporel RFC3339) à utiliser pour le filtrage. Si cette valeur est spécifiée, les entrées supprimées depuis cette heure seront toujours incluses, quelle que soit la valeur de `showDeleted`. Facultatif. Par défaut, le filtrage par heure de dernière modification n'est pas activé.

Autorisation

Cette requête permet l'autorisation avec au moins l'une des portées suivantes :

Champ d'application
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.events.readonly`
`https://www.googleapis.com/auth/calendar.events`
`https://www.googleapis.com/auth/calendar.app.created`
`https://www.googleapis.com/auth/calendar.events.freebusy`
`https://www.googleapis.com/auth/calendar.events.owned`
`https://www.googleapis.com/auth/calendar.events.owned.readonly`
`https://www.googleapis.com/auth/calendar.events.public.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#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}

Nom de propriété	Valeur	Description	Remarques
`kind`	`string`	Type de la collection ("`calendar#events`").
`etag`	`etag`	ETag de la collection.
`summary`	`string`	Titre de l'agenda. Lecture seule.
`description`	`string`	Description de l'agenda. Lecture seule.
`updated`	`datetime`	Heure de la dernière modification apportée à l'agenda (code temporel RFC3339). Lecture seule.
`timeZone`	`string`	Fuseau horaire de l'agenda. Lecture seule.
`accessRole`	`string`	Rôle d'accès de l'utilisateur pour cet agenda. Lecture seule. Les valeurs possibles sont les suivantes : `none` : l'utilisateur n'a pas accès à la ressource. "`freeBusyReader`" : l'utilisateur a accès en lecture aux informations de disponibilité. "`reader`" : l'utilisateur dispose d'un accès en lecture à l'agenda. Les événements privés s'affichent pour les utilisateurs ayant accès en lecture, mais leurs détails sont masqués. "`writer`" : l'utilisateur dispose d'un accès en lecture et en écriture à l'agenda. Les événements privés s'affichent pour les utilisateurs disposant d'un accès en écriture, et les détails des événements sont visibles. "`owner`" : l'utilisateur dispose d'un accès administrateur à l'agenda. Ce rôle dispose de toutes les autorisations du rôle Rédacteur, ainsi que de la possibilité de consulter et de modifier les niveaux d'accès des autres utilisateurs. Important : Le rôle `owner` est différent de celui du propriétaire des données de l'agenda. Un agenda ne peut avoir qu'un seul propriétaire de données, mais peut être associé à plusieurs utilisateurs disposant du rôle `owner`.
`defaultReminders[]`	`list`	Rappels par défaut dans l'agenda de l'utilisateur authentifié. Ces rappels s'appliquent à tous les événements de cet agenda qui ne les remplacent pas explicitement (c'est-à-dire dont la valeur `reminders.useDefault` n'est pas définie sur "True").
`defaultReminders[].method`	`string`	Méthode utilisée par ce rappel. Les valeurs possibles sont les suivantes : "`email`" : les rappels sont envoyés par e-mail. "`popup`" : les rappels sont envoyés via un pop-up de l'UI. Obligatoire lorsque vous ajoutez un rappel.	accessible en écriture
`defaultReminders[].minutes`	`integer`	Nombre de minutes avant le début de l'événement où le rappel doit être déclenché. Les valeurs valides sont comprises entre 0 et 40 320 (4 semaines en minutes). Obligatoire lorsque vous ajoutez un rappel.	accessible en écriture
`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`	Liste des événements de l'agenda.
`nextSyncToken`	`string`	Jeton utilisé ultérieurement pour ne récupérer que 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.

Essayer

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