Events: update

Met à jour un événement. Cette méthode n'est pas compatible avec la sémantique "patch" et met toujours à jour l'intégralité de la ressource d'événement. Pour effectuer une mise à jour partielle, effectuez une get suivie d'une update à l'aide d'etags pour assurer l'atomicité. Essayez maintenant ou voir un exemple

Requête

Requête HTTP

PUT 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 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 générée et non fonctionnelle est fournie).
conferenceDataVersion integer Numéro de version des données de conférence compatibles avec le client de l'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 ConferenceData 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.
maxAttendees integer Nombre maximal de participants à inclure dans la réponse. Si le nombre de participants est supérieur au nombre spécifié, seul le participant est renvoyé. Facultatif.
sendNotifications boolean Obsolète. Veuillez utiliser sendUpdates à la place.

Indique si des notifications doivent être envoyées concernant la mise à jour de l'événement (par exemple, en cas de 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 Les invités qui doivent recevoir des notifications concernant la mise à jour de l'événement (par exemple, en cas de changement de titre, etc.).

Les valeurs acceptées sont les suivantes :
  • "all": les notifications sont envoyées à tous les invités.
  • "externalOnly": les notifications ne sont envoyées qu'aux invités qui n'utilisent pas Google Agenda.
  • "none": aucune notification n'est envoyée. Pour les tâches de migration d'agenda, nous vous conseillons d'utiliser plutôt la méthode Events.import.
supportsAttachments boolean Indique si le client API effectuant l'opération accepte 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'un des champs d'application suivants:

Portée
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 une ressource "Events" avec les propriétés suivantes:

Nom de propriété Valeur Description Remarques
Propriétés requises
end nested object Heure de fin (exclusive) de l'événement. Pour un événement récurrent, il s'agit de l'heure de fin de la première instance.
start nested object Heure de début (inclusive) de l'événement. Pour un événement récurrent, il s'agit de l'heure de début de la première instance.
Propriétés facultatives
anyoneCanAddSelf boolean Indique si n'importe qui peut s'inviter à l'événement (obsolète). Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
attachments[].fileUrl string Lien URL vers la pièce jointe.

Pour ajouter des pièces jointes Google Drive, utilisez le même format que dans la propriété alternateLink de la ressource Files dans l'API Drive.

Obligatoire lors de l'ajout d'une pièce jointe.

 accessible en écriture
attendees[] list Participants à l'événement. Pour en savoir plus sur la planification d'événements avec d'autres utilisateurs de l'agenda, consultez le guide Événements avec des participants. Les comptes de service doivent utiliser la délégation d'autorité au niveau du domaine pour renseigner la liste des participants. accessible en écriture
attendees[].additionalGuests integer Nombre d'invités supplémentaires. Facultatif. La valeur par défaut est 0. accessible en écriture
attendees[].comment string Commentaire de la personne interrogée. Facultatif. accessible en écriture
attendees[].displayName string Nom de l'utilisateur, le cas échéant Facultatif. accessible en écriture
attendees[].email string Adresse e-mail de l'participant (si disponible) Ce champ doit être présent lorsque vous ajoutez un participant. Il doit s'agir d'une adresse e-mail valide, conformément à la norme RFC5322.

Obligatoire lors de l'ajout d'un participant.

 accessible en écriture
attendees[].optional boolean Indique si l'invité est facultatif. Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
attendees[].resource boolean Indique si le participant est une ressource. Ne peut être défini que lorsque le participant est ajouté à l'événement pour la première fois. Les modifications ultérieures sont ignorées. Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
attendees[].responseStatus string État de la réponse de l'utilisateur. Les valeurs possibles sont les suivantes:
  • "needsAction" : le participant n'a pas répondu à l'invitation (recommandé pour les nouveaux événements).
  • "declined" : le participant a refusé l'invitation.
  • "tentative" : l'invité a accepté provisoirement l'invitation.
  • "accepted" : l'invité a accepté l'invitation.
 accessible en écriture
attendeesOmitted boolean Indique si des participants ont pu être omis de la représentation de l'événement. Lorsque vous récupérez un événement, cela peut être dû à une restriction spécifiée par le paramètre de requête maxAttendee. Lorsque vous mettez à jour un événement, vous pouvez uniquement modifier la réponse du participant. Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
colorId string Couleur de l'événement. Il s'agit d'un ID faisant référence à une entrée de la section event de la définition des couleurs (voir le point de terminaison des couleurs). Facultatif. accessible en écriture
conferenceData nested object Informations sur la conférence, telles que les détails d'une conférence Google Meet. Pour créer des informations sur une conférence, utilisez le champ createRequest. Pour que vos modifications soient conservées, n'oubliez pas de définir le paramètre de requête conferenceDataVersion sur 1 pour toutes les requêtes de modification d'événement. accessible en écriture
description string Description de l'événement. Peut contenir du code HTML. Facultatif. accessible en écriture
end.date date Date au format "aaaa-mm-jj", si l'événement dure toute la journée. accessible en écriture
end.dateTime datetime L'heure, sous la forme d'une valeur date-heure combinée (mise en forme conformément à la RFC3339). Un décalage horaire est obligatoire, sauf si un fuseau horaire est explicitement spécifié dans timeZone. accessible en écriture
end.timeZone string Fuseau horaire dans lequel l'heure est spécifiée. (au format de nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements récurrents, ce champ est obligatoire et spécifie le fuseau horaire dans lequel la récurrence est développée. Pour les événements uniques, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début/la fin de l'événement. accessible en écriture
extendedProperties.private object Propriétés privées à la copie de l'événement qui s'affiche dans cet agenda. accessible en écriture
extendedProperties.shared object Propriétés partagées entre les copies de l'événement dans les agendas des autres participants. accessible en écriture
focusTimeProperties nested object Données d'événement "Moment de concentration". Utilisé si eventType est focusTime. accessible en écriture
gadget.display string Mode d'affichage du gadget. Obsolète. Les valeurs possibles sont les suivantes:
  • "icon" : le gadget s'affiche à côté du titre de l'événement dans la vue Agenda.
  • "chip" : le gadget s'affiche lorsque l'utilisateur clique sur l'événement.
 accessible en écriture
gadget.height integer Hauteur du gadget en pixels. La hauteur doit être un entier supérieur à 0. Facultatif. Obsolète. accessible en écriture
gadget.preferences object Préférences. accessible en écriture
gadget.title string Titre du gadget. Obsolète. accessible en écriture
gadget.type string Type du gadget. Obsolète. accessible en écriture
gadget.width integer Largeur du gadget en pixels. La largeur doit être un entier supérieur à 0. Facultatif. Obsolète. accessible en écriture
guestsCanInviteOthers boolean Indique si les participants autres que l'organisateur peuvent inviter d'autres personnes à l'événement. Facultatif. La valeur par défaut est "True". accessible en écriture
guestsCanModify boolean Indique si les participants autres que l'organisateur peuvent modifier l'événement. Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
guestsCanSeeOtherGuests boolean Indique si les participants autres que l'organisateur peuvent voir les participants à l'événement. Facultatif. La valeur par défaut est "True". accessible en écriture
location string Emplacement géographique de l'événement sous forme de texte libre. Facultatif. accessible en écriture
originalStartTime.date date Date au format "aaaa-mm-jj", si l'événement dure toute la journée. accessible en écriture
originalStartTime.dateTime datetime L'heure, sous la forme d'une valeur date-heure combinée (mise en forme conformément à la RFC3339). Un décalage horaire est obligatoire, sauf si un fuseau horaire est explicitement spécifié dans timeZone. accessible en écriture
originalStartTime.timeZone string Fuseau horaire dans lequel l'heure est spécifiée. (au format de nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements récurrents, ce champ est obligatoire et spécifie le fuseau horaire dans lequel la récurrence est développée. Pour les événements uniques, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début/la fin de l'événement. accessible en écriture
outOfOfficeProperties nested object Données d'événement "Absent du bureau". Utilisé si eventType est outOfOffice. accessible en écriture
recurrence[] list Liste des lignes RRULE, EXRULE, RDATE et EXDATE pour un événement récurrent, comme spécifié dans la RFC5545. Notez que les lignes DTSTART et DTEND ne sont pas autorisées dans ce champ. Les heures de début et de fin de l'événement sont spécifiées dans les champs start et end. Ce champ est omis pour les événements uniques ou les occurrences d'événements récurrents. accessible en écriture
reminders.overrides[] list Si l'événement n'utilise pas les rappels par défaut, les rappels spécifiques à l'événement sont listés. Si aucun rappel n'est défini, cela indique qu'aucun rappel n'est défini pour cet événement. Le nombre maximal de rappels de forçage est de cinq. accessible en écriture
reminders.overrides[].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 une fenêtre pop-up de l'UI.

Obligatoire lors de l'ajout d'un rappel.

 accessible en écriture
reminders.overrides[].minutes integer Nombre de minutes avant le début de l'événement auquel 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
reminders.useDefault boolean Indique si les rappels par défaut de l'agenda s'appliquent à l'événement. accessible en écriture
sequence integer Numéro de séquence selon iCalendar. accessible en écriture
source.title string Titre de la source (par exemple, titre d'une page Web ou objet d'un e-mail). accessible en écriture
source.url string URL de la source pointant vers une ressource. Le schéma d'URL doit être HTTP ou HTTPS. accessible en écriture
start.date date Date au format "aaaa-mm-jj", si l'événement dure toute la journée. accessible en écriture
start.dateTime datetime L'heure, sous la forme d'une valeur date-heure combinée (mise en forme conformément à la RFC3339). Un décalage horaire est obligatoire, sauf si un fuseau horaire est explicitement spécifié dans timeZone. accessible en écriture
start.timeZone string Fuseau horaire dans lequel l'heure est spécifiée. (au format de nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements récurrents, ce champ est obligatoire et spécifie le fuseau horaire dans lequel la récurrence est développée. Pour les événements uniques, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début/la fin de l'événement. accessible en écriture
status string État de l'événement. Facultatif. Les valeurs possibles sont les suivantes:
  • "confirmed" : l'événement est confirmé. Il s'agit de l'état par défaut.
  • "tentative" : l'événement est confirmé provisoirement.
  • "cancelled" : l'événement est annulé (supprimé). La méthode list ne renvoie les événements annulés que lors d'une synchronisation incrémentielle (lorsque syncToken ou updatedMin sont spécifiés) ou si l'indicateur showDeleted est défini sur true. La méthode get les renvoie toujours.

    Un état "Annulé" représente deux états différents en fonction du type d'événement:

    1. Les exceptions annulées d'un événement récurrent non annulé indiquent que cette instance ne doit plus être présentée à l'utilisateur. Les clients doivent stocker ces événements pendant toute la durée de vie de l'événement périodique parent.

      Pour les exceptions annulées, seules les valeurs des champs id, recurringEventId et originalStartTime sont renseignées. Les autres champs peuvent être vides.

    2. Tous les autres événements annulés représentent des événements supprimés. Les clients doivent supprimer leurs copies synchronisées localement. Ces événements annulés finiront par disparaître. Ne comptez donc pas sur leur disponibilité indéfinie.

      Seul le champ id est renseigné pour les événements supprimés.

    Dans l'agenda de l'organisateur, les événements annulés continuent d'afficher les détails (résumé, lieu, etc.) afin qu'ils puissent être restaurés (non supprimés). De même, les événements auxquels l'utilisateur a été invité et qu'il a supprimés manuellement continuent de fournir des informations. Toutefois, les requêtes de synchronisation incrémentielle avec showDeleted défini sur "false" ne renvoient pas ces informations.

    Si l'organisateur d'un événement change (par exemple, via l'opération move) et que l'organisateur d'origine ne figure pas sur la liste des participants, un événement annulé est créé, dans lequel seul le champ id est garanti d'être renseigné.

accessible en écriture
summary string Titre de l'événement. accessible en écriture
transparency string Indique si l'événement bloque une période dans l'agenda. Facultatif. Les valeurs possibles sont les suivantes:
  • "opaque" : valeur par défaut. L'événement bloque une période dans l'agenda. Cela revient à définir Me montrer comme sur Occupé dans l'interface utilisateur de l'agenda.
  • "transparent" : l'événement ne bloque pas de créneau horaire dans l'agenda. Cela équivaut à définir Me montrer comme sur Disponible dans l'interface utilisateur d'Agenda.
 accessible en écriture
visibility string Visibilité de l'événement. Facultatif. Les valeurs possibles sont les suivantes:
  • "default" : utilise la visibilité par défaut pour les événements de l'agenda. Il s'agit de la valeur par défaut.
  • "public" : l'événement est public et ses détails sont visibles par tous les lecteurs de l'agenda.
  • "private" : l'événement est privé et seuls les participants peuvent en voir les détails.
  • "confidential" : l'événement est privé. Cette valeur est fournie pour des raisons de compatibilité.
 accessible en écriture
workingLocationProperties nested object Données d'événement de lieu de travail accessible en écriture
workingLocationProperties.customLocation object Si présent, indique que l'utilisateur travaille depuis un emplacement personnalisé. accessible en écriture
workingLocationProperties.customLocation.label string Libellé supplémentaire facultatif pour des informations supplémentaires. accessible en écriture
workingLocationProperties.homeOffice any value Si elle est présente, indique que l'utilisateur travaille à domicile. accessible en écriture
workingLocationProperties.officeLocation object S'il est présent, indique que l'utilisateur travaille depuis un bureau. accessible en écriture
workingLocationProperties.officeLocation.buildingId string Identifiant de bâtiment facultatif. Il doit faire référence à un identifiant de bâtiment dans la base de données des ressources de l'organisation. accessible en écriture
workingLocationProperties.officeLocation.deskId string Identifiant de bureau facultatif. accessible en écriture
workingLocationProperties.officeLocation.floorId string Identifiant de l'étage (facultatif) accessible en écriture
workingLocationProperties.officeLocation.floorSectionId string Identifiant facultatif de la section de l'étage. accessible en écriture
workingLocationProperties.officeLocation.label string Nom de l'établissement qui s'affiche dans les clients Web et mobiles de l'agenda. Nous vous recommandons de faire référence au nom d'un bâtiment dans la base de données de ressources de l'organisation. accessible en écriture
workingLocationProperties.type string Type de lieu de travail. Les valeurs possibles sont les suivantes:
  • "homeOffice" : l'utilisateur travaille à domicile.
  • "officeLocation" : l'utilisateur travaille depuis un bureau.
  • "customLocation" : l'utilisateur travaille depuis un emplacement personnalisé.
Tous les détails sont spécifiés dans un sous-champ du nom spécifié, mais ce champ peut être manquant s'il est vide. Tous les autres champs sont ignorés.

Obligatoire lors de l'ajout de propriétés de lieu de travail.

 accessible en écriture

Réponse

Si la requête aboutit, cette méthode renvoie une ressource "Events" dans le corps de la réponse.

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;

// ...

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

// Retrieve the event from the API
Event event = service.events().get("primary", "eventId").execute();

// Make a change
event.setSummary("Appointment at Somewhere");

// Update the event
Event updatedEvent = service.events().update("primary", event.getId(), event).execute();

System.out.println(updatedEvent.getUpdated());

Python

Utilise la bibliothèque cliente Python.

# First retrieve the event from the API.
event = service.events().get(calendarId='primary', eventId='eventId').execute()

event['summary'] = 'Appointment at Somewhere'

updated_event = service.events().update(calendarId='primary', eventId=event['id'], body=event).execute()

# Print the updated date.
print updated_event['updated']

PHP

Utilise la bibliothèque cliente PHP.

// First retrieve the event from the API.
$event = $service->events->get('primary', 'eventId');

$event->setSummary('Appointment at Somewhere');

$updatedEvent = $service->events->update('primary', $event->getId(), $event);

// Print the updated date.
echo $updatedEvent->getUpdated();

Ruby

Utilise la bibliothèque cliente Ruby.

event = client.get_event('primary', 'eventId')
event.summary = 'Appointment at Somewhere'
result = client.update_event('primary', event.id, event)
print result.updated

Essayer

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