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, exécutez une commande get suivie d'une opération update à l'aide d'etags afin de garantir l'atomicité. Essayez dès maintenant ou consultez 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 bouton "primary" mot clé.
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 générée et non fonctionnelle sera fournie).
conferenceDataVersion integer Numéro de version des données de conférence pris en charge par le client API. La version 0 suppose qu'aucune donnée de conférence n'est prise en charge et ignore les données de conférence dans le corps de l'événement. La version 1 permet de copier des données ConferenceData et de créer des conférences à l'aide du champ createRequest de conférenceData. 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. S'il y a plus de participants que le nombre spécifié, seul le participant est renvoyé. Facultatif.
sendNotifications boolean Obsolète. Veuillez plutôt utiliser sendUpdates.

Permet d'envoyer des notifications sur la mise à jour de l'événement (changement de 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 sur la mise à jour de l'événement (changements de titre, etc.)

Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "all" : des 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, utilisez plutôt la méthode Events.import.
supportsAttachments boolean Indique si le client API exécutant l'opération accepte les pièces jointes d'événements. Facultatif. La valeur par défaut est "False" (faux).

Autorisation

Une autorisation est requise pour cette demande. Celle-ci doit inclure au moins l'un des champs d'application suivants:

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, indiquez une ressource "Events" (Événements) avec les propriétés suivantes:

Nom de propriété Valeur Description Remarques
Propriétés obligatoires
end nested object Heure de fin (exclue) de l'événement. Pour un événement périodique, il s'agit de l'heure de fin de la première occurrence.
start nested object Heure de début (incluse) de l'événement. Pour un événement périodique, il s'agit de l'heure de début de la première occurrence.
Propriétés facultatives
anyoneCanAddSelf boolean Indique si les utilisateurs peuvent s'inviter à l'événement (obsolète). Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
attachments[].fileUrl string l'URL de 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 d'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 remplir 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 réponse du participant. Facultatif. accessible en écriture
attendees[].displayName string Nom du participant, si disponible. Facultatif. accessible en écriture
attendees[].email string Adresse e-mail du participant, si disponible. Ce champ doit être présent lors de l'ajout d'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 s'il s'agit d'un participant 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 du participant. Les valeurs possibles sont:
  • "needsAction" - Le participant n'a pas répondu à l'invitation (recommandé pour les nouveaux événements).
  • "declined" - Le participant a refusé l'invitation.
  • "tentative" - Le participant a accepté provisoirement l'invitation.
  • "accepted" - Le participant a accepté l'invitation.
 accessible en écriture
attendeesOmitted boolean Indique si des participants ont été omis dans la représentation de l'événement. Une restriction spécifiée par le paramètre de requête maxAttendee peut s'expliquer par la récupération d'un événement. Lorsque vous modifiez un événement, cette option ne peut être utilisée que pour mettre à jour la réponse du participant. Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
colorId string Couleur de l'événement. Cet ID fait 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 liées à 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 conserver vos modifications, n'oubliez pas de définir le paramètre de requête conferenceDataVersion sur 1 pour toutes les demandes 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", s'il s'agit d'un événement d'une journée entière. accessible en écriture
end.dateTime datetime Heure, sous la forme d'une valeur combinée de date et heure (formatée conformément à la norme RFC3339). Un décalage de fuseau horaire est requis, 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. (présenté sous la forme d'un nom de base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich".) Pour les événements périodiques, ce champ est obligatoire. Il spécifie le fuseau horaire dans lequel la récurrence est étendue. Pour les événements individuels, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début et la fin de l'événement. accessible en écriture
extendedProperties.private object Propriétés réservées à la copie de l'événement qui apparaît dans cet agenda. accessible en écriture
extendedProperties.shared object Propriétés partagées entre les copies de l'événement sur celles des autres participants agendas. accessible en écriture
focusTimeProperties nested object Données d'événement "Moment de concentration". Utilisé si eventType est défini sur focusTime. accessible en écriture
gadget.display string Mode d'affichage du gadget. Obsolète. Les valeurs possibles sont:
  • "icon" - Le gadget s'affiche à côté du titre de l'événement dans la vue de l'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 nombre entier supérieur à zéro. 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 de gadget. Obsolète. accessible en écriture
gadget.width integer Largeur du gadget en pixels. La largeur doit être un nombre entier supérieur à zéro. Facultatif. Obsolète. accessible en écriture
guestsCanInviteOthers boolean Indique si des 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 des 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 qui sont 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 (texte au format libre) Facultatif. accessible en écriture
originalStartTime.date date Date au format "aaaa-mm-jj", s'il s'agit d'un événement d'une journée entière. accessible en écriture
originalStartTime.dateTime datetime Heure, sous la forme d'une valeur combinée de date et heure (formatée conformément à la norme RFC3339). Un décalage de fuseau horaire est requis, 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. (présenté sous la forme d'un nom de base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich".) Pour les événements périodiques, ce champ est obligatoire. Il spécifie le fuseau horaire dans lequel la récurrence est étendue. Pour les événements individuels, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début et la fin de l'événement. accessible en écriture
outOfOfficeProperties nested object Données d'absence du bureau. Utilisé si eventType est défini sur outOfOffice. accessible en écriture
recurrence[] list Liste des lignes RRULE, EXRULE, RDATE et EXDATE pour un événement périodique, comme spécifié dans le 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 ponctuels ou périodiques. accessible en écriture
reminders.overrides[] list Si l'événement n'utilise pas les rappels par défaut, les rappels spécifiques sont répertoriés. Si aucun rappel n'est défini, cela indique qu'aucun rappel n'est défini pour cet événement. Vous ne pouvez pas définir plus de cinq rappels. accessible en écriture
reminders.overrides[].method string Méthode utilisée pour 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 d'interface utilisateur.

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 pendant lesquelles le rappel doit se déclencher. 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 conformément à iCalendar. accessible en écriture
source.title string Titre de la source par exemple le titre d'une page Web ou l'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", s'il s'agit d'un événement d'une journée entière. accessible en écriture
start.dateTime datetime Heure, sous forme de valeur combinée date/heure (formatée conformément à la norme RFC3339). Un décalage de fuseau horaire est requis, 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. (présenté sous la forme d'un nom de base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich".) Pour les événements périodiques, ce champ est obligatoire. Il spécifie le fuseau horaire dans lequel la récurrence est étendue. Pour les événements individuels, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début et la fin de l'événement. accessible en écriture
status string État de l'événement. Facultatif. Les valeurs possibles sont:
  • "confirmed" - L'événement est confirmé. Il s'agit de l'état par défaut.
  • "tentative" - L'événement est provisoirement confirmé.
  • "cancelled" - L'événement est annulé (supprimé). La méthode list ne renvoie les événements annulés que lors de la synchronisation incrémentielle (lorsque les champs syncToken ou updatedMin sont spécifiés) ou si l'option showDeleted est définie sur true. La méthode get les renvoie toujours.

    Un état "Annulé" peut représenter deux états différents selon le 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 conserver ces événements pendant toute la durée de vie de l'événement récurrent parent.

      Les exceptions annulées ne garantissent que les valeurs des champs id, recurringEventId et originalStartTime renseignés. 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. Par conséquent, ne comptez pas sur leur disponibilité indéfinie.

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

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

    Si un événement change d'organisateur (par exemple, via l'opération move) et que l'organisateur d'origine ne figure pas dans la liste des participants, il laissera un événement annulé où seul le champ id sera renseigné.

accessible en écriture
summary string Titre de l'événement. accessible en écriture
transparency string Indique si l'événement bloque du temps dans l'agenda. Facultatif. Les valeurs possibles sont:
  • "opaque" : valeur par défaut. En revanche, l'événement bloque du temps dans l'agenda. Cela équivaut à définir l'option Ma disponibilité en tant que sur Occupé dans l'interface utilisateur d'Agenda.
  • "transparent" - L'événement ne bloque pas de temps dans l'agenda. Cela revient à définir l'option Ma disponibilité en tant que sur Disponible dans l'interface utilisateur d'Agenda.
 accessible en écriture
visibility string Visibilité de l'événement. Facultatif. Les valeurs possibles sont:
  • "default" - Utilise la visibilité par défaut des événements de l'agenda. Il s'agit de la valeur par défaut.
  • "public" - L'événement est public, et tous les lecteurs de l'agenda ont accès à ses détails.
  • "private" - L'événement est privé, et seuls les participants peuvent en consulter 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 sur le lieu de travail. accessible en écriture
workingLocationProperties.customLocation object S'il est présent, indique que l'utilisateur travaille dans un lieu personnalisé. accessible en écriture
workingLocationProperties.customLocation.label string Libellé supplémentaire facultatif pour fournir des informations supplémentaires. accessible en écriture
workingLocationProperties.homeOffice any value S'il est présent, indique que l'utilisateur travaille à domicile. accessible en écriture
workingLocationProperties.officeLocation object S'il est présent, indique que l'utilisateur travaille dans un bureau. accessible en écriture
workingLocationProperties.officeLocation.buildingId string Identifiant facultatif du bâtiment. Celui-ci doit faire référence à un identifiant de bâtiment dans la base de données "Ressources" de l'organisation. accessible en écriture
workingLocationProperties.officeLocation.deskId string Identifiant de bureau facultatif. accessible en écriture
workingLocationProperties.officeLocation.floorId string Identifiant d'étage facultatif. accessible en écriture
workingLocationProperties.officeLocation.floorSectionId string Identifiant facultatif de section d'étage. accessible en écriture
workingLocationProperties.officeLocation.label string Nom du bureau affiché dans les clients Agenda pour le Web et les mobiles. Nous vous recommandons de référencer le nom d'un bâtiment dans la base de données "Ressources" de l'organisation. accessible en écriture
workingLocationProperties.type string Type de lieu de travail. Les valeurs possibles sont:
  • "homeOffice" - L'utilisateur travaille à la maison.
  • "officeLocation" - L'utilisateur travaille dans un bureau.
  • "customLocation" - L'utilisateur travaille à partir d'un lieu personnalisé.
Tous les détails sont spécifiés dans un sous-champ du nom indiqué, 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

Lorsque cette méthode fonctionne, elle renvoie une ressource "Events" dans le corps de 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

Elle 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

Elle 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

Elle 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

Elle 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.