Met à jour un événement. Cette méthode est compatible avec la sémantique "patch". Notez que chaque requête PATCH consomme trois unités de quota. Il est préférable d'utiliser un get suivi d'un update. Les valeurs de champ que vous spécifiez remplacent les valeurs existantes. Les champs que vous ne spécifiez pas dans la demande restent inchangés. Si des champs de tableau sont spécifiés, ils écrasent les tableaux existants, ce qui supprime tous les éléments de tableau précédents.
Essayez-le maintenant.
Requête
Requête HTTP
PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
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. |
| 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).
|
conferenceDataVersion |
integer |
Numéro de version des données de conférence compatibles avec le client API. La version 0 ne prend pas en charge les données de conférence et les ignore dans le corps de l'événement. La version 1 permet de copier les données de conférence et de créer des conférences à l'aide du champ "createRequest" de conferenceData. La valeur par défaut est 0.
Les valeurs autorisées vont de 0 à 1, inclus.
|
eventLabelVersion |
integer |
Numéro de version de la fonctionnalité d'étiquette d'événement compatible avec le client API. La version 0 ne prend pas en charge les libellés d'événement et traite le champ colorId pour la gestion des couleurs. La version 1 permet la prise en charge des libellés d'événement et traite le eventLabelId dans le corps de l'événement. Dans ce cas, le champ colorId est ignoré. La valeur par défaut est 0.
Les valeurs acceptées sont comprises entre 0 et 1, incluses.
|
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. |
sendNotifications |
boolean |
Obsolète. Veuillez plutôt utiliser sendUpdates. Indique si des notifications doivent être envoyées concernant la modification de l'événement (par exemple, la modification de la description, etc.). Notez que certains e-mails peuvent toujours être envoyés même si vous définissez la valeur sur false. La valeur par défaut est false.
|
sendUpdates |
string |
Invités qui doivent recevoir des notifications concernant les modifications apportées à l'événement (par exemple, le changement de titre, etc.).
Les valeurs acceptées sont les suivantes :
|
supportsAttachments |
boolean |
Indique si le client API qui effectue l'opération est compatible avec les pièces jointes d'événements. Facultatif. La valeur par défaut est "False" (faux). |
Autorisation
Cette requête nécessite une autorisation avec au moins l'une des portées suivantes :
| Champ d'application |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
Pour en savoir plus, consultez la page Authentification et autorisation.
Corps de la requête
Dans le corps de la requête, indiquez les parties pertinentes d'une ressource "Events", conformément aux règles de la sémantique de correctif.
Réponse
Si la requête aboutit, cette méthode renvoie une ressource "Events" dans le corps de la réponse.
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.