Events

L'API Calendar offre différents types de ressources d'événement. Pour en savoir plus, consultez À propos des événements.

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}

Nom de propriété	Valeur	Description	Remarques
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[]	list	Pièces jointes de l'événement. Pour modifier les pièces jointes, le paramètre de requête supportsAttachments doit être défini sur true. Il ne peut pas y avoir plus de 25 pièces jointes par événement.
attachments[].fileId	string	ID du fichier joint. Lecture seule. Pour les fichiers Google Drive, il s'agit de l'ID de l'entrée de ressource Files correspondante dans l'API Drive.
attachments[].fileUrl	string	Lien 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 lorsque vous ajoutez une pièce jointe.	accessible en écriture
attachments[].iconLink	string	URL à l'icône de la pièce jointe. Ce champ ne peut être modifié que pour les pièces jointes tierces personnalisées.
attachments[].mimeType	string	Type de média Internet (type MIME) de la pièce jointe.
attachments[].title	string	Titre de la pièce jointe.
attendeesOmitted	boolean	Indique si les participants ont été 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 utiliser la réponse du participant. Facultatif. La valeur par défaut est "False" (faux).	accessible en écriture
attendees[]	list	Participants à l'événement. Consultez le guide Événements avec des participants pour en savoir plus sur la planification d'événements avec d'autres utilisateurs d'agenda. Les comptes de service doivent utiliser la délégation au niveau du domaine pour renseigner la liste des participants.	accessible en écriture
attendees[].additionalGuests	integer	Nombre de personnes 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, le cas échéant. 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 lorsque vous ajoutez un participant.	accessible en écriture
attendees[].id	string	ID du profil du participant, le cas échéant.
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[].organizer	boolean	Indique si le participant est l'organisateur de l'événement. Lecture seule. La valeur par défaut est "False" (faux).
attendees[].resource	boolean	Indique si le participant est une ressource. Ce paramètre ne peut être défini que lorsque le participant est ajouté à l'événement pour la première fois. Les modifications suivantes 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 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" : le participant a provisoirement accepté l'invitation. "accepted" : le participant a accepté l'invitation. Avertissement:Si vous ajoutez un événement à l'aide des valeurs declined, tentative ou accepted, les participants dont le paramètre "Ajouter des invitations à mon agenda" est défini sur "Lorsque je réponds à l'invitation par e-mail" ne verront pas d'événement dans leur agenda, sauf s'ils choisissent de modifier leur réponse à l'invitation par e-mail.	accessible en écriture
attendees[].self	boolean	Indique si cette entrée représente l'agenda dans lequel cette copie de l'événement apparaît. Lecture seule. La valeur par défaut est "False" (faux).
colorId	string	Couleur de l'événement. Il s'agit d'un identifiant 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 la 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
conferenceData.conferenceId	string	Identifiant de la conférence. Les développeurs peuvent l'utiliser pour assurer le suivi des conférences et ne doivent pas être présentés aux utilisateurs. La valeur de l'ID est formée différemment pour chaque type de solution de conférence: eventHangout: l'ID n'est pas défini. (ce type de conférence est obsolète). eventNamedHangout: ID correspondant au nom du Hangout. (ce type de conférence est obsolète). hangoutsMeet: ID correspond au code de réunion à 10 lettres, par exemple aaa-bbbb-ccc. addOn: l'ID est défini par le fournisseur tiers. Facultatif.
conferenceData.conferenceSolution	nested object	La solution de conférence, telle que Google Meet. Non définie pour une conférence dont la demande de création a échoué. Vous devez indiquer conferenceSolution et au moins un entryPoint, ou createRequest.
conferenceData.conferenceSolution.iconUri	string	Icône visible par l'utilisateur pour cette solution.
conferenceData.conferenceSolution.key	nested object	Clé permettant d'identifier de manière unique la solution de conférence pour cet événement.
conferenceData.conferenceSolution.key.type	string	Type de solution de conférence. Si un client rencontre un type inconnu ou vide, il devrait toujours pouvoir afficher les points d'entrée. Toutefois, il devrait interdire les modifications. Les valeurs possibles sont : "eventHangout" pour Hangouts pour les consommateurs (obsolète ; les événements existants peuvent afficher ce type de solution de conférence, mais il est impossible de créer des conférences) "eventNamedHangout" pour les utilisateurs de la version classique de Hangouts pour Google Workspace (obsolètes ; ce type de solution de conférence peut apparaître dans les événements existants, mais il est impossible de créer des conférences) "hangoutsMeet" pour Google Meet (http://meet.google.com) "addOn" pour les fournisseurs de conférences tiers
conferenceData.conferenceSolution.name	string	Nom visible de l'utilisateur de cette solution. Non localisé
conferenceData.createRequest	nested object	Requête permettant de générer une nouvelle conférence et de l'associer à l'événement Les données sont générées de manière asynchrone. Pour voir si les données sont présentes, vérifiez le champ status. Vous devez indiquer conferenceSolution et au moins un entryPoint, ou createRequest.
conferenceData.createRequest.conferenceSolutionKey	nested object	La solution de conférence, telle que Hangouts ou Google Meet
conferenceData.createRequest.conferenceSolutionKey.type	string	Type de solution de conférence. Si un client rencontre un type inconnu ou vide, il devrait toujours pouvoir afficher les points d'entrée. Toutefois, il devrait interdire les modifications. Les valeurs possibles sont : "eventHangout" pour Hangouts pour les consommateurs (obsolète ; les événements existants peuvent afficher ce type de solution de conférence, mais il est impossible de créer des conférences) "eventNamedHangout" pour les utilisateurs de la version classique de Hangouts pour Google Workspace (obsolètes ; ce type de solution de conférence peut apparaître dans les événements existants, mais il est impossible de créer des conférences) "hangoutsMeet" pour Google Meet (http://meet.google.com) "addOn" pour les fournisseurs de conférences tiers
conferenceData.createRequest.requestId	string	ID unique généré par le client pour cette requête. Les clients doivent regénérer cet ID pour chaque nouvelle requête. Si un ID fourni est identique à celui de la requête précédente, la requête est ignorée.
conferenceData.createRequest.status	nested object	État de la demande de création de conférence.
conferenceData.createRequest.status.statusCode	string	État actuel de la demande de création de conférence. Lecture seule. Les valeurs possibles sont : "pending": la demande de création de conférence est toujours en cours de traitement. "success": la requête de création de conférence a bien été exécutée, les points d'entrée sont renseignés. "failure": la requête de création de conférence a échoué. Il n'y a aucun point d'entrée.
conferenceData.entryPoints[]	list	Informations sur des points d'entrée de conférence individuels, tels que des URL ou des numéros de téléphone Tous doivent appartenir à la même conférence. Vous devez indiquer conferenceSolution et au moins un entryPoint, ou createRequest.
conferenceData.entryPoints[].accessCode	string	Code d'accès pour accéder à la conférence. La longueur maximale est de 128 caractères. Lorsque vous créez des données de conférence, ne renseignez que le sous-ensemble de champs {meetingCode, accessCode, passcode, password, pin} qui correspond à la terminologie du fournisseur de la conférence. Seuls les champs renseignés doivent être affichés. Facultatif.
conferenceData.entryPoints[].entryPointType	string	Type de point d'entrée de la conférence. Les valeurs possibles sont : "video" : participer à une conférence via HTTP Une conférence peut avoir zéro ou un point d'entrée video. "phone" : permet de participer à une conférence en composant un numéro de téléphone. Une conférence peut comporter zéro ou plusieurs points d'entrée phone. "sip" : participer à une conférence via SIP. Une conférence peut avoir zéro ou un point d'entrée sip. "more" : instructions de participation à la conférence, par exemple numéros de téléphone supplémentaires Une conférence peut avoir zéro ou un point d'entrée more. Une conférence ne disposant que d'un point d'entrée more n'est pas valide.
conferenceData.entryPoints[].label	string	Libellé de l'URI. Visible par les utilisateurs finaux. Non localisé La longueur maximale est de 512 caractères. Exemples : pour video: meet.google.com/aaa-bbbb-ccc pour phone: [phone] pour sip: [e-mail] pour more: ne doit pas être renseigné Facultatif.
conferenceData.entryPoints[].meetingCode	string	Code de la réunion pour accéder à la conférence. La longueur maximale est de 128 caractères. Lorsque vous créez des données de conférence, ne renseignez que le sous-ensemble de champs {meetingCode, accessCode, passcode, password, pin} qui correspond à la terminologie du fournisseur de la conférence. Seuls les champs renseignés doivent être affichés. Facultatif.
conferenceData.entryPoints[].passcode	string	Code secret permettant d'accéder à la conférence. La longueur maximale est de 128 caractères. Lorsque vous créez des données de conférence, ne renseignez que le sous-ensemble de champs {meetingCode, accessCode, passcode, password, pin} qui correspond à la terminologie du fournisseur de la conférence. Seuls les champs renseignés doivent être affichés.
conferenceData.entryPoints[].password	string	Mot de passe pour accéder à la conférence. La longueur maximale est de 128 caractères. Lorsque vous créez des données de conférence, ne renseignez que le sous-ensemble de champs {meetingCode, accessCode, passcode, password, pin} qui correspond à la terminologie du fournisseur de la conférence. Seuls les champs renseignés doivent être affichés. Facultatif.
conferenceData.entryPoints[].pin	string	Code d'accès pour accéder à la conférence. La longueur maximale est de 128 caractères. Lorsque vous créez des données de conférence, ne renseignez que le sous-ensemble de champs {meetingCode, accessCode, passcode, password, pin} qui correspond à la terminologie du fournisseur de la conférence. Seuls les champs renseignés doivent être affichés. Facultatif.
conferenceData.entryPoints[].uri	string	URI du point d'entrée. Ne doit pas dépasser 1 300 caractères. Format: Veuillez indiquer un schéma video, http: ou https:. Pour phone, un schéma tel: est requis. L'URI doit inclure la séquence de numérotation complète (par exemple, tel:[phone],,,,123456789;1234). Pour sip, un schéma sip: est requis (par exemple, sip:[e-mail]). Veuillez indiquer un schéma more, http: ou https:.
conferenceData.notes	string	Notes supplémentaires (telles que les instructions de l'administrateur du domaine, les mentions légales) à afficher à l'utilisateur. Peut contenir du code HTML. La longueur maximale est de 2 048 caractères. Facultatif.
conferenceData.signature	string	Signature des données de la conférence. Généré côté serveur. Non définie pour une conférence dont la demande de création a échoué. Facultatif pour une conférence avec une requête de création en attente.
created	datetime	Heure de création de l'événement (sous la forme d'un horodatage RFC3339). Lecture seule.
creator	object	Créateur de l'événement. Lecture seule.
creator.displayName	string	Nom du créateur, si disponible.
creator.email	string	Adresse e-mail du créateur, si disponible.
creator.id	string	ID du profil du créateur, si disponible.
creator.self	boolean	Indique si le créateur correspond à l'agenda dans lequel cette copie de l'événement apparaît. Lecture seule. La valeur par défaut est "False" (faux).
description	string	Description de l'événement. Peut contenir du code HTML. Facultatif.	accessible en écriture
end	nested object	Heure de fin (exclusive) de l'événement. Pour un événement périodique, il s'agit de l'heure de fin de la première instance.
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 forme de valeur de date/heure combinée (mise en forme conformément à la 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 au nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements périodiques, ce champ est obligatoire et indique 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
endTimeUnspecified	boolean	Indique si l'heure de fin n'est pas spécifiée. Une heure de fin est toujours fournie pour des raisons de compatibilité, même si cet attribut est défini sur "True". La valeur par défaut est "False" (faux).
etag	etag	ETag de la ressource.
eventType	string	Type spécifique de l'événement. Lecture seule. Les valeurs possibles sont les suivantes: "default" : événement standard ou non spécifié. "outOfOffice" : événement d'absence du bureau. "focusTime" : événement de temps de travail. "workingLocation" : événement de lieu de travail. Aperçu pour les développeurs:disponible dans le cadre du Programme Google Workspace Developer Preview, qui accorde un accès anticipé à certaines fonctionnalités.
extendedProperties	object	Propriétés étendues de l'événement.
extendedProperties.private	object	Propriétés privées de la copie de l'événement qui apparaît dans cet agenda.	accessible en écriture
extendedProperties.private.(key)	string	Nom de la propriété privée et valeur correspondante.
extendedProperties.shared	object	Propriétés partagées entre les copies de l'événement dans les agendas des autres participants.	accessible en écriture
extendedProperties.shared.(key)	string	Nom de la propriété partagée et valeur correspondante.
gadget	object	Gadget qui prolonge cet événement. Les gadgets sont obsolètes. Cette structure est uniquement utilisée pour renvoyer des métadonnées de calendrier d'anniversaire.
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 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 à 0. Facultatif. Obsolète.	accessible en écriture
gadget.iconLink	string	URL de l'icône du gadget. Le schéma d'URL doit être de type HTTPS. Obsolète.	accessible en écriture
gadget.link	string	URL du gadget. Le schéma d'URL doit être de type HTTPS. Obsolète.	accessible en écriture
gadget.preferences	object	Préférences.	accessible en écriture
gadget.preferences.(key)	string	Nom de la préférence et valeur correspondante.
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 le nom des participants à l'événement. Facultatif. La valeur par défaut est "True".	accessible en écriture
hangoutLink	string	Lien absolu vers le Hangout Google associé à cet événement. Lecture seule.
htmlLink	string	Lien absolu vers cet événement dans l'interface utilisateur Web de Google Agenda. Lecture seule.
iCalUID	string	Identifiant unique de l'événement, tel que défini dans le document RFC5545. Il permet d'identifier de manière unique les événements sur les systèmes d'agenda. Il doit être fourni lors de l'importation d'événements via la méthode import. Notez que iCalUID et id ne sont pas identiques et qu'un seul d'entre eux doit être fourni au moment de la création de l'événement. Une différence de sémantique réside dans le fait que dans les événements périodiques, toutes les occurrences d'un événement ont des valeurs id différentes alors qu'elles partagent toutes les mêmes valeurs iCalUID. Pour récupérer un événement à l'aide de son iCalUID, appelez la méthode events.list à l'aide du paramètre iCalUID. Pour récupérer un événement à l'aide de son id, appelez la méthode events.get.
id	string	Identifiant opaque de l'événement. Lorsque vous créez un événement unique ou récurrent, vous pouvez spécifier son ID. Les ID fournis doivent respecter les règles suivantes: Les caractères autorisés dans l'ID sont ceux utilisés pour l'encodage base32hex (lettres minuscules a-v et chiffres 0-9). Reportez-vous à la section 3. 1.2 de la RFC2938. l'ID doit comprendre entre 5 et 1 024 caractères L'ID doit être unique pour chaque agenda. En raison de la nature distribuée à l'échelle mondiale du système, nous ne pouvons pas garantir que les collisions d'identifiants seront détectées au moment de la création de l'événement. Pour minimiser les risques de collisions, nous vous recommandons d'utiliser un algorithme d'UUID établi, tel que celui décrit dans la RFC4122. Si vous ne spécifiez pas d'identifiant, il sera automatiquement généré par le serveur. Notez que icalUID et id ne sont pas identiques et qu'un seul d'entre eux doit être fourni au moment de la création de l'événement. Une différence de sémantique réside dans le fait que dans les événements périodiques, toutes les occurrences d'un événement ont des valeurs id différentes alors qu'elles partagent toutes les mêmes valeurs icalUID.	accessible en écriture
kind	string	Type de la ressource ("calendar#event").
location	string	Emplacement géographique de l'événement sous forme de texte libre. Facultatif.	accessible en écriture
locked	boolean	Indique s'il s'agit d'une copie d'événement verrouillée ne pouvant pas être modifiée dans les champs principaux de l'événement "summary", "description", "location", "start", "end" ou "recurrence". La valeur par défaut est "False" (faux). Lecture seule.
organizer	object	Organisateur de l'événement. Si l'organisateur est également un participant, cela est indiqué avec une entrée distincte dans attendees avec le champ organizer défini sur "True". Pour changer d'organisateur, utilisez l'opération move. Lecture seule, sauf lors de l'importation d'un événement.	accessible en écriture
organizer.displayName	string	Nom de l'organisateur, s'il est disponible.	accessible en écriture
organizer.email	string	Adresse e-mail de l'organisateur, si disponible. Il doit s'agir d'une adresse e-mail valide, conformément à la norme RFC5322.	accessible en écriture
organizer.id	string	ID du profil de l'organisateur, si disponible.
organizer.self	boolean	Indique si l'organisateur correspond à l'agenda dans lequel cette copie de l'événement apparaît. Lecture seule. La valeur par défaut est "False" (faux).
originalStartTime	nested object	Pour une instance d'événement périodique, il s'agit de l'heure à laquelle l'événement démarrera selon les données de récurrence de l'événement récurrent identifié par le champ "eventEventId". Elle identifie de manière unique l'instance dans la série d'événements périodiques, même si celle-ci a été déplacée à un autre moment. Immuable.
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 forme de valeur de date/heure combinée (mise en forme conformément à la 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 au nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements périodiques, ce champ est obligatoire et indique 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
privateCopy	boolean	Si elle est définie sur "True", la propagation d'événement est désactivée. Notez qu'il ne s'agit pas de propriétés d'événement privé. Facultatif. Immuable. La valeur par défaut est "False" (faux).
recurrence[]	list	Liste des lignes RRULE, EXRULE, RDATE et EXDATE pour un événement périodique, comme spécifié dans le document RFC5545. Notez que les lignes DTSTART et DTEND ne sont pas autorisées dans ce champ. Les heures de début et de fin des événements sont spécifiées dans les champs start et end. Ce champ est omis pour les événements uniques ou périodiques.	accessible en écriture
recurringEventId	string	Pour une instance d'événement périodique, il s'agit de la id de l'événement périodique auquel cette instance appartient. Immuable.
reminders	object	Informations sur les rappels de l'événement pour l'utilisateur authentifié.
reminders.overrides[]	list	Si l'événement n'utilise pas les rappels par défaut, il affiche les rappels spécifiques à l'événement. Sinon, indique qu'aucun rappel n'a été défini. Le nombre de rappels de remplacement est limité à 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. 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 où le rappel doit se déclencher. Les valeurs valides sont comprises entre 0 et 40 320 (quatre 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	object	Source à partir de laquelle l'événement a été créé. Par exemple, une page Web, un e-mail ou tout document identifiable par une URL avec un schéma HTTP ou HTTPS. Seul le créateur de l'événement peut voir ou modifier le contenu.
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	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 instance.
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 forme de valeur de date/heure combinée (mise en forme conformément à la 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 au nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements périodiques, ce champ est obligatoire et indique 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 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 l'option syncToken ou updatedMin est spécifiée) ou si l'option showDeleted est définie 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: Les exceptions annulées en cas d'é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 vie de l'événement récurrent parent. Les valeurs des champs id, recurringEventId et originalStartTime ne sont renseignées que pour les exceptions annulées. Les autres champs peuvent être vides. 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. Vous ne devez donc pas compter sur leur disponibilité illimitée. Le champ id n'est renseigné qu'avec les événements supprimés. Dans l'agenda de l'organisateur, les événements annulés continuent d'afficher les détails des événements (résumé, lieu, etc.) afin qu'ils puissent être restaurés (restauration). 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. Cependant, les requêtes de synchronisation incrémentielle dont showDeleted est défini sur "false" ne renverront pas ces détails. Si un organisateur change d'organisateur (par exemple, via l'opération de déplacement) et que l'organisateur d'origine ne figure pas sur la liste des participants, il laissera un événement annulé dans lequel 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 le temps dans l'agenda. Facultatif. Les valeurs possibles sont les suivantes: "opaque" : valeur par défaut. L'événement bloque le temps dans l'agenda. Cela équivaut à définir l'option Afficher comme Occupé dans l'interface utilisateur d'Agenda. "transparent" : l'événement ne bloque pas l'horaire dans l'agenda. Cela revient à définir l'option Démonstration sur Disponible dans l'interface utilisateur d'Agenda.	accessible en écriture
updated	datetime	Heure de la dernière modification de l'événement (au format RFC3339). Lecture seule.
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 les 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	Aperçu pour les développeurs:disponible dans le cadre du Programme Google Workspace Developer Preview, qui accorde un accès anticipé à certaines fonctionnalités. Données d'événement du lieu de travail. Lecture seule.
workingLocationProperties.customLocation	object	Si ce champ est présent, indique que l'utilisateur travaille depuis un emplacement personnalisé.
workingLocationProperties.customLocation.label	string	Libellé supplémentaire facultatif pour des informations supplémentaires.
workingLocationProperties.homeOffice	any value	S'il est présent, indique que l'utilisateur travaille à la maison.
workingLocationProperties.officeLocation	object	Si ce champ est présent, indique que l'utilisateur travaille depuis un bureau.
workingLocationProperties.officeLocation.buildingId	string	Identifiant facultatif du bâtiment. Il doit faire référence à un ID de bâtiment figurant dans la base de données des ressources de l'organisation.
workingLocationProperties.officeLocation.deskId	string	Identifiant de bureau arbitraire facultatif.
workingLocationProperties.officeLocation.floorId	string	Identifiant d'étage arbitraire facultatif.
workingLocationProperties.officeLocation.floorSectionId	string	Un identifiant de section d'étage arbitraire facultatif.
workingLocationProperties.officeLocation.label	string	Libellé supplémentaire facultatif pour des informations supplémentaires.

Méthodes

supprimer

Supprime un événement.

obtenir

Renvoie un événement en fonction de son ID Google Agenda. Pour récupérer un événement à l'aide de son ID iCalendar, appelez la méthode events.list à l'aide du paramètre iCalUID.

importer

Importer un événement. Cette opération permet d'ajouter à un agenda une copie privée d'un événement existant.

insérer

Crée un événement.

instances

Renvoie les instances de l'événement périodique spécifié.

list

Renvoie les événements de l'agenda spécifié.

déplacer

Déplace un événement vers un autre agenda, c'est-à-dire modifie l'organisateur d'un événement.

correctif

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. Utilisez de préférence une get suivie d'une 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. Tous les éléments précédents du tableau seront alors supprimés.

quickAdd

Crée un événement à partir d'une simple chaîne de texte.

mettre à jour

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 opération get suivie d'une opération update à l'aide d'etags afin de garantir l'atomicité.

montre

Surveillez les modifications apportées aux ressources "Événements".