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

Events: list

Renvoie les événements de l'agenda spécifié. Essayez maintenant ou consultez un exemple.

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é. Une valeur est toujours renvoyée dans le champ `email` pour l'organisateur, le créateur et les participants, même si aucune adresse e-mail réelle n'est disponible (c'est-à-dire qu'une valeur non fonctionnelle est générée).
`eventTypes`	`string`	Types d'événements à afficher. Facultatif. Les valeurs possibles sont: `"default"` `"focusTime"` `"outOfOffice"` `"workingLocation"` Vous pouvez répéter ce paramètre plusieurs fois pour renvoyer des événements de différents types. La valeur par défaut est `["default", "focusTime", "outOfOffice"]`.
`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 qui s'affiche peut être inférieur à cette valeur, voire aucun événement, même si davantage d'é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. Par défaut, la valeur est de 250 événements. La taille de la page ne peut jamais être supérieure à 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é. Valeurs acceptées : "`startTime`": triez par date/heure de début (dans l'ordre croissant). Cette option n'est disponible que lorsque vous interrogez des événements uniques (le paramètre `singleEvents` est défini sur "True") "`updated`": triez par date et heure de la dernière modification (dans l'ordre croissant).
`pageToken`	`string`	Jeton spécifiant la page de résultats à renvoyer. Facultatif.
`privateExtendedProperty`	`string`	Contrainte de propriétés étendues spécifiées sous la forme propriétéName=value. Ne correspond qu'aux propriétés privées. Ce paramètre peut être répété plusieurs fois pour renvoyer des événements qui correspondent à toutes les contraintes données.
`q`	`string`	Termes de recherche en texte libre pour trouver des événements correspondant à ces termes dans les champs suivants: `summary` `description` `location` `displayName` du participant `email` du participant `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` Ces termes de recherche mettent également en correspondance des mots clés prédéfinis avec toutes les traductions du titre à afficher pour "Lieu de travail", "Absent du bureau" et "Moment de concentration". Par exemple, rechercher "Bureau" ou "Bureau" affiche les événements de lieu de travail de type `officeLocation`, tandis que rechercher "Absent du bureau" ou "Abwesend" renvoie les événements "Absent du bureau". Facultatif.
`sharedExtendedProperty`	`string`	Contrainte de propriétés étendues spécifiées sous la forme propriétéName=value. Ne correspond qu'aux propriétés partagées. Ce paramètre peut être répété plusieurs fois pour renvoyer des événements qui correspondent à toutes les contraintes données.
`showDeleted`	`boolean`	Indique si les événements supprimés (`status` correspond à "`cancelled`") dans le résultat. Les instances annulées d'événements récurrents (mais pas celles de l'événement périodique sous-jacent) sont toujours incluses si `showDeleted` et `singleEvents` sont tous les deux définis sur "False". Si les valeurs `showDeleted` et `singleEvents` sont toutes les deux définies sur "True", seules des 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 s'il faut inclure les invitations masquées dans le résultat. Facultatif. La valeur par défaut est "False" (faux).
`singleEvents`	`boolean`	Permet de spécifier si les événements périodiques doivent être étendus aux instances et ne renvoient que les événements ponctuels et les instances d'événements périodiques, 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. Ainsi, le résultat de cette demande de liste ne contiendra que les entrées qui ont été modifiées depuis. Tous les événements supprimés depuis la requête de liste précédente 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. Il s'agit de: `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 `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.
`timeMax`	`datetime`	Limite supérieure (exclue) de l'heure de début d'un événement à utiliser comme filtre. Facultatif. Par défaut, les filtres ne sont pas filtrés par heure de début. Il doit s'agir d'un horodatage RFC3339 avec un décalage de fuseau horaire obligatoire, par exemple, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Les millisecondes peuvent être fournies, mais sont ignorées. Si `timeMin` est défini, `timeMax` doit être supérieur à `timeMin`.
`timeMin`	`datetime`	Limite inférieure (exclue) de l'heure de fin d'un événement à utiliser comme filtre. Facultatif. Par défaut, le filtrage par heure de fin n'est pas effectué. Il doit s'agir d'un horodatage RFC3339 avec un décalage de fuseau horaire obligatoire, par exemple, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Les millisecondes peuvent être fournies, mais sont ignorées. Si `timeMax` est défini, `timeMin` doit être inférieur à `timeMax`.
`timeZone`	`string`	Fuseau horaire utilisé dans la réponse. Facultatif. Le fuseau horaire par défaut est celui de l'agenda.
`updatedMin`	`datetime`	Limite inférieure de l'heure de la dernière modification d'un événement (en tant qu'horodatage RFC3339) à utiliser pour le filtrage. Si spécifié, les entrées supprimées depuis cette heure seront toujours incluses, quel que soit le `showDeleted`. Facultatif. Par défaut, les données ne sont pas filtrées par date de dernière modification.

Autorisation

Cette requête autorise une autorisation 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.events.readonly`
`https://www.googleapis.com/auth/calendar.events`

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 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 de l'agenda (en tant que 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: `none` : l'utilisateur n'a aucun accès. `freeBusyReader` : l'utilisateur dispose d'un 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 seront visibles par les utilisateurs disposant d'un accès en lecture, mais les détails les concernant seront masqués. "`writer`" : l'utilisateur dispose d'un accès en lecture et en écriture à l'agenda. Les événements privés seront visibles par les utilisateurs autorisés à écrire, et les détails les concernant seront visibles. "`owner`" : l'utilisateur est propriétaire de l'agenda. Ce rôle dispose de toutes les autorisations du rôle de rédacteur, mais il peut également afficher et manipuler les LCA.
`defaultReminders[]`	`list`	Rappels par défaut de l'agenda pour l'utilisateur authentifié. Ces rappels s'appliquent à tous les événements de cet agenda qui ne les remplacent pas explicitement (c'est-à-dire pour lesquels `reminders.useDefault` n'est pas défini sur "True").
`defaultReminders[].method`	`string`	Méthode utilisée par ce rappel. Les valeurs possibles sont: `email` : les rappels sont envoyés par e-mail. `popup` : les rappels sont envoyés via un pop-up dans l'interface utilisateur. Obligatoire lors de l'ajout d'un rappel.	accessible en écriture
`defaultReminders[].minutes`	`integer`	Nombre de minutes avant le début de l'événement pendant lequel le rappel doit se déclencher. Les valeurs valides sont comprises entre 0 et 40320 (quatre semaines en minutes). Obligatoire lors de l'ajout d'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 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.Event;
import com.google.api.services.calendar.model.Events;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over the events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').setPageToken(pageToken).execute();
  List<Event> items = events.getItems();
  for (Event event : items) {
    System.out.println(event.getSummary());
  }
  pageToken = events.getNextPageToken();
} while (pageToken != null);

Python

Utilise la bibliothèque cliente Python.

page_token = None
while True:
  events = service.events().list(calendarId='primary', pageToken=page_token).execute()
  for event in events['items']:
    print event['summary']
  page_token = events.get('nextPageToken')
  if not page_token:
    break

PHP

Utilise la bibliothèque cliente PHP.

$events = $service->events->listEvents('primary');

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->listEvents('primary', $optParams);
  } else {
    break;
  }
}

Ruby

Utilise la bibliothèque cliente Ruby.

page_token = nil
begin
  result = client.list_events('primary', page_token: page_token)
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

Essayer

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