Events: insert

Crée un événement. Essayer maintenant

Requête

Requête HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events

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".
Paramètres de requête facultatifs
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 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 à 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 création du nouvel événement. 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 Indique si des notifications doivent être envoyées concernant la création du nouvel événement. Notez que certains e-mails peuvent encore être envoyés. La valeur par défaut est false.

Les valeurs acceptées sont les suivantes :
  • 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.
supportsAttachments boolean Indique si le client API effectuant 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 ayant 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 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 (incluse) 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 tout le monde 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 de fichiers Google Drive, utilisez le même format que dans la propriété alternateLink de la ressource Files de l'API Drive.

Obligatoire lorsque vous ajoutez 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 de l'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 la réponse du participant. Facultatif. accessible en écriture
attendees[].displayName string Nom du participant, s'il est disponible. Facultatif. accessible en écriture
attendees[].email string Adresse e-mail du 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 le participant 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 du participant. Valeurs possibles :
  • 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
birthdayProperties nested object Données sur les anniversaires ou les événements spéciaux Utilisé si eventType est "birthday". Immuable. accessible en écriture
birthdayProperties.type string Type d'anniversaire ou d'événement spécial. Valeurs possibles :
  • "anniversary" : un anniversaire autre qu'une date de naissance. Possède toujours un contact.
  • "birthday" : un événement d'anniversaire. Il s'agit de la valeur par défaut.
  • "custom" : date spéciale dont le libellé est précisé dans le champ customTypeName. Possède toujours un contact.
  • "other" : date spéciale qui n'entre dans aucune autre catégorie et qui n'a pas de libellé personnalisé. Possède toujours un contact.
  • "self" : anniversaire du propriétaire de l'agenda. Ne peut pas contenir de contact.
 L'API Calendar n'accepte que la création d'événements de type "birthday". Une fois l'événement créé, vous ne pouvez plus modifier son type.		 accessible en écriture
colorId string Couleur de l'événement. Il s'agit d'un ID faisant référence à une entrée dans 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 de 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 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", si l'événement dure toute la journée. accessible en écriture
end.dateTime datetime Heure, sous la forme d'une valeur combinée de date et d'heure (mise en forme selon 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. (Formaté comme un 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 et la fin de l'événement. accessible en écriture
eventType string Type spécifique de l'événement. Vous ne pourrez plus modifier ce paramètre une fois l'événement créé. Valeurs possibles :
  • "birthday" : événement spécial sur toute une journée qui se répète chaque année.
  • "default" : événement régulier ou non spécifié.
  • "focusTime" : un événement "Moment de concentration".
  • "fromGmail" : un événement ajouté à partir de Gmail. Ce type d'événement ne peut pas être créé.
  • "outOfOffice" : un événement d'absence du bureau.
  • "workingLocation" : événement de lieu de travail.
 accessible en écriture
extendedProperties.private object Propriétés privées de 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. Valeurs possibles :
  • "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 nombre 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 nombre 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 la liste des participants à l'événement. Facultatif. La valeur par défaut est "True". accessible en écriture
id string Identifiant opaque de l'événement. Lorsque vous créez des événements uniques ou récurrents, vous pouvez spécifier leurs ID. Les ID fournis doivent respecter les règles suivantes :
  • Les caractères autorisés dans l'ID sont ceux utilisés dans l'encodage base32hex, c'est-à-dire les lettres minuscules a à v et les chiffres 0 à 9.Pour en savoir plus, consultez la section 3. 1.2 de la RFC2938.
  • La longueur de l'ID doit être comprise entre 5 et 1 024 caractères.
  • l'ID doit être unique pour chaque agenda.
 En raison de la nature distribuée du système à l'échelle mondiale, nous ne pouvons pas garantir que les collisions d'ID seront détectées au moment de la création de l'événement. Pour minimiser le risque de collisions, nous vous recommandons d'utiliser un algorithme UUID établi, tel que celui décrit dans la RFC4122.

Si vous ne spécifiez pas d'ID, il sera généré automatiquement par le serveur.

Notez que icalUID et id ne sont pas identiques. Vous ne devez fournir qu'un seul de ces paramètres lors de la création de l'événement. Une différence sémantique réside dans le fait que, dans les événements récurrents, toutes les occurrences d'un événement ont des id différents, mais partagent les mêmes icalUID.

 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 Heure, sous la forme d'une valeur combinée de date et d'heure (mise en forme selon 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. (Formaté comme un 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 et la fin de l'événement. accessible en écriture
outOfOfficeProperties nested object Données d'événement d'absence 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 ponctuels ou les instances d'événements récurrents. accessible en écriture
reminders.overrides[] list Si l'événement n'utilise pas les rappels par défaut, cette section liste les rappels spécifiques à l'événement ou, s'ils ne sont pas définis, indique qu'aucun rappel n'est défini pour cet événement. Le nombre maximal de rappels de remplacement est de cinq. accessible en écriture
reminders.overrides[].method string Méthode utilisée par ce rappel. Valeurs possibles :
  • "email" : les rappels sont envoyés par e-mail.
  • "popup" : les rappels sont envoyés via un pop-up dans l'interface utilisateur.

Obligatoire lorsque vous ajoutez un rappel.

 accessible en écriture
reminders.overrides[].minutes integer Nombre de minutes avant le début de l'événement où le rappel doit être déclenché. Les valeurs valides sont comprises entre 0 et 40 320 (4 semaines en minutes).

Obligatoire lorsque vous ajoutez 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, 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", si l'événement dure toute la journée. accessible en écriture
start.dateTime datetime Heure, sous la forme d'une valeur combinée de date et d'heure (mise en forme selon 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. (Formaté comme un 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 et la fin de l'événement. accessible en écriture
status string État de l'événement. Facultatif. Valeurs possibles :
  • 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 d'une synchronisation incrémentielle (lorsque syncToken ou updatedMin sont spécifiés) ou si le flag showDeleted est défini sur true. La méthode get les renvoie toujours.

    L'état "Annulée" représente deux états différents selon le type d'événement :

    1. Les exceptions annulées d'un événement périodique 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 l'événement récurrent parent.

      Les exceptions annulées sont garanties d'avoir des valeurs renseignées uniquement pour les champs id, recurringEventId et originalStartTime. 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 des événements supprimés est obligatoirement renseigné.

     Dans l'agenda de l'organisateur, les événements annulés continuent d'afficher les détails de l'événement (résumé, lieu, etc.) afin de pouvoir être restaurés. De même, les événements auxquels l'utilisateur a été invité et qu'il a supprimés manuellement continuent de fournir des détails. Toutefois, les requêtes de synchronisation incrémentielle avec showDeleted défini sur "false" ne renverront 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é sera laissé derrière, où 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 du temps dans l'agenda. Facultatif. Valeurs possibles :
  • "opaque" : valeur par défaut. L'événement bloque du temps dans l'agenda. Cela équivaut à définir M'afficher comme sur Occupé dans l'interface utilisateur de l'agenda.
  • "transparent" : l'événement ne bloque pas de plage horaire dans l'agenda. Cela équivaut à définir M'afficher comme sur Disponible dans l'interface utilisateur de l'agenda.
 accessible en écriture
visibility string Visibilité de l'événement. Facultatif. Valeurs possibles :
  • "default" : utilise la visibilité par défaut des événements dans l'agenda. Il s'agit de la valeur par défaut.
  • "public" : l'événement est public et les détails sont visibles par tous les lecteurs de l'agenda.
  • "private" : l'événement est privé et seuls les participants peuvent en afficher 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 Si elle est présente, indique que l'utilisateur travaille depuis un lieu personnalisé. accessible en écriture
workingLocationProperties.customLocation.label string Étiquette supplémentaire facultative pour des informations supplémentaires. accessible en écriture
workingLocationProperties.homeOffice any value Si cette valeur est présente, elle 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 de section de l'étage (facultatif). accessible en écriture
workingLocationProperties.officeLocation.label string Nom du bureau affiché dans les clients Web et mobile Agenda. Nous vous recommandons de faire référence au nom d'un bâtiment dans la base de données des ressources de l'organisation. accessible en écriture
workingLocationProperties.type string Type de lieu de travail. Valeurs possibles :
  • "homeOffice" : l'utilisateur travaille à domicile.
  • "officeLocation" : l'utilisateur travaille depuis un bureau.
  • "customLocation" : l'utilisateur travaille depuis 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 lorsque vous ajoutez des 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.

Essayer

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