Events: patch

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 requête restent inchangés. S'ils sont spécifiés, les champs de tableau écrasent les tableaux existants. Cette opération supprime tous les éléments de tableau précédents. Essayer 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 d'événement.
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).
conferenceDataVersion integer Numéro de version des données de conférence prises en charge par le client API. La version 0 n'accepte pas les données de conférence et ignore ces données dans le corps de l'événement. La version 1 prend en charge la copie de ConferenceData ainsi que la création de 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.
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. Utilisez sendUpdates à la place.

Permet d'envoyer des notifications concernant la mise à jour de l'événement (modification de la description, etc.). Notez que certains e-mails peuvent continuer à ê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 sur la modification de l'événement (changement de titre, etc.).

Valeurs acceptées :
  • "all": les notifications sont envoyées à tous les invités.
  • "externalOnly": les notifications ne sont envoyées qu'aux personnes qui n'utilisent pas Google Agenda.
  • "none": aucune notification n'est envoyée. Pour les tâches de migration d'agenda, envisagez plutôt d'utiliser la méthode Events.import.
supportsAttachments boolean Indique si le client API effectuant une opération prend en charge les pièces jointes à des événements. Facultatif. La valeur par défaut est "False" (faux).

Autorisation

Une autorisation est nécessaire pour cette requête avec au moins l'un des champs d'application suivants:

Définition du champ d'application
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Dans le corps de la requête, fournissez les parties pertinentes d'une ressource "Events", conformément aux règles de la sémantique "patch".

Réponse

Lorsque cette méthode fonctionne, elle 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.