Renvoie les instances de l'événement périodique spécifié. Essayer maintenant.
Requête
Requête HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances
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".
|
eventId |
string |
Identifiant de l'événement périodique. |
| Paramètres de requête (facultatifs) | ||
alwaysIncludeEmail |
boolean |
Obsolète et ignoré. Une valeur sera 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 générée et non fonctionnelle sera fournie).
|
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. Par défaut, la valeur est de 250 événements. La taille de la page ne peut jamais dépasser 2 500 événements. Facultatif. |
originalStart |
string |
Heure de début d'origine de l'instance dans le résultat. Facultatif. |
pageToken |
string |
Jeton spécifiant la page de résultats à renvoyer. Facultatif. |
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 seront toujours incluses si singleEvents est défini sur "False". Facultatif. La valeur par défaut est "False" (faux).
|
timeMax |
datetime |
Limite supérieure (exclusive) de l'heure de début d'un événement à filtrer. Facultatif. Par défaut, le filtrage n'est pas effectué en fonction de l'heure de début. Doit être un code temporel RFC3339 avec un décalage de fuseau horaire obligatoire. |
timeMin |
datetime |
Limite inférieure (inclusive) de l'heure de fin d'un événement à filtrer. Facultatif. Par défaut, le filtrage n'est pas effectué en fonction de l'heure de fin. Doit être un code temporel RFC3339 avec un décalage de fuseau horaire obligatoire. |
timeZone |
string |
Fuseau horaire utilisé dans la réponse. Facultatif. Par défaut, il s'agit du fuseau horaire de l'agenda. |
Autorisation
Cette requête autorise l'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.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 de l'agenda (au format 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. Valeurs possibles :
|
|
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 qui n'ont pas reminders.useDefault défini sur "True"). |
|
defaultReminders[].method |
string |
Méthode utilisée par ce rappel. Valeurs possibles :
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 lorsque le rappel doit être déclenché. Les valeurs valides sont comprises entre 0 et 40 320 (4 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. Dans ce 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. Dans ce 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.