Events

L'API Calendar propose différentes versions de ressources d'événements. 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": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": 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 à 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 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
attachments[].iconLink	string	URL de 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 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. Lors de la modification d'un événement, ce paramètre peut être utilisé pour ne modifier que la réponse du participant. Facultatif. La valeur par défaut est "False" (faux).	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[].id	string	ID de profil du participant, s'il est disponible.
attendees[].optional	boolean	Indique si le participant est 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. 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. Avertissement : Si vous ajoutez un événement en utilisant les valeurs declined, tentative ou accepted, la réponse des participants dont le paramètre "Ajouter des invitations à mon agenda" est défini sur "Lorsque je réponds à l'invitation par e-mail" ou "Uniquement si je connais l'expéditeur" peut être réinitialisée sur needsAction. Ils ne verront pas l'événement dans leur agenda, sauf s'ils modifient leur réponse dans l'e-mail d'invitation à l'événement. De plus, si plus de 200 invités sont invités à l'événement, l'état de la réponse n'est pas propagé aux invités.	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).
birthdayProperties	nested object	Données sur les anniversaires ou les événements spéciaux Utilisé si eventType est "birthday". Immuable.	accessible en écriture
birthdayProperties.contact	string	Nom de ressource du contact auquel cet événement d'anniversaire est associé. Vous pouvez l'utiliser pour récupérer les coordonnées à partir de l'API People. Format : "people/c12345". Lecture seule.
birthdayProperties.customTypeName	string	Libellé de type personnalisé spécifié pour cet événement. Ce champ est renseigné si birthdayProperties.type est défini sur "custom". Lecture seule.
birthdayProperties.type	string	Type d'anniversaire ou d'événement spécial. Valeurs possibles : "anniversary" : un anniversaire autre qu'un anniversaire 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. Avertissement : Réutiliser les données de conférence Google Meet pour différents événements peut entraîner des problèmes d'accès et exposer les détails des réunions à des utilisateurs non prévus. Pour garantir la confidentialité des réunions, générez toujours une conférence unique pour chaque événement à l'aide du champ createRequest.	accessible en écriture
conferenceData.conferenceId	string	ID de la conférence. Les développeurs peuvent l'utiliser pour suivre les conférences. Il ne doit pas être affiché aux utilisateurs. La valeur de l'ID est différente 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 : l'ID correspond au nom du Hangout. (Ce type de conférence est obsolète.) hangoutsMeet : ID de réunion à 10 caractères, par exemple aaa-bbbb-ccc. addOn : l'ID est défini par le fournisseur tiers.  Facultatif.
conferenceData.conferenceSolution	nested object	Solution de visioconférence, telle que Google Meet. Non défini 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 doit toujours pouvoir afficher les points d'entrée. Toutefois, il doit interdire les modifications. Les valeurs possibles sont : "eventHangout" pour Hangouts pour les consommateurs (obsolète ; ce type de solution de visioconférence peut s'afficher pour les événements existants, mais il n'est pas possible de créer de nouvelles visioconférences) "eventNamedHangout" pour la version classique de Hangouts pour les utilisateurs Google Workspace (obsolète ; ce type de solution de visioconférence peut s'afficher pour les événements existants, mais il n'est pas possible de créer de visioconférences) "hangoutsMeet" pour Google Meet (http://meet.google.com) "addOn" pour les fournisseurs de solutions de visioconférence tiers
conferenceData.conferenceSolution.name	string	Nom de cette solution visible par l'utilisateur. Non localisé.
conferenceData.createRequest	nested object	Requête permettant de générer une conférence et de l'associer à l'événement. Les données sont générées de manière asynchrone. Pour vérifier si les données sont présentes, consultez le champ status. Vous devez indiquer conferenceSolution et au moins un entryPoint, ou createRequest.
conferenceData.createRequest.conferenceSolutionKey	nested object	Solution de visioconfé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 doit toujours pouvoir afficher les points d'entrée. Toutefois, il doit interdire les modifications. Les valeurs possibles sont : "eventHangout" pour Hangouts pour les consommateurs (obsolète ; ce type de solution de visioconférence peut s'afficher pour les événements existants, mais il n'est pas possible de créer de nouvelles visioconférences) "eventNamedHangout" pour la version classique de Hangouts pour les utilisateurs Google Workspace (obsolète ; ce type de solution de visioconférence peut s'afficher pour les événements existants, mais il n'est pas possible de créer de visioconférences) "hangoutsMeet" pour Google Meet (http://meet.google.com) "addOn" pour les fournisseurs de solutions de visioconférence tiers
conferenceData.createRequest.requestId	string	ID unique généré par le client pour cette requête. Les clients doivent régénérer cet ID pour chaque nouvelle demande. 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 la conférence.
conferenceData.createRequest.status.statusCode	string	État actuel de la demande de création de la conférence. Lecture seule. Les valeurs possibles sont : "pending" : la demande de création de la conférence est toujours en cours de traitement. "success" : la requête de création de la conférence a abouti et les points d'entrée sont renseignés. "failure" : la requête de création de la conférence a échoué. Il n'y a aucun point d'entrée.
conferenceData.entryPoints[]	list	Informations sur les points d'accès individuels à la conférence, tels que les URL ou les 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 à la conférence. La longueur ne doit pas dépasser 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 correspondent à la terminologie utilisée par le fournisseur de 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. Valeurs possibles : "video" : rejoindre une conférence via HTTP. Une conférence peut avoir zéro ou un point d'entrée video. "phone" : 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" : participation à une visioconférence via SIP. Une conférence peut avoir zéro ou un point d'entrée sip. "more" : instructions supplémentaires pour rejoindre la conférence, par exemple d'autres numéros de téléphone. Une conférence peut avoir zéro ou un point d'entrée more. Une conférence avec un seul 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 ne doit pas dépasser 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 permettant d'accéder à la conférence. La longueur ne doit pas dépasser 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 correspondent à la terminologie utilisée par le fournisseur de 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 ne doit pas dépasser 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 correspondent à la terminologie utilisée par le fournisseur de conférence. Seuls les champs renseignés doivent être affichés.
conferenceData.entryPoints[].password	string	Mot de passe permettant d'accéder à la conférence. La longueur ne doit pas dépasser 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 correspondent à la terminologie utilisée par le fournisseur de conférence. Seuls les champs renseignés doivent être affichés. Facultatif.
conferenceData.entryPoints[].pin	string	Code d'accès à la conférence. La longueur ne doit pas dépasser 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 correspondent à la terminologie utilisée par le fournisseur de conférence. Seuls les champs renseignés doivent être affichés. Facultatif.
conferenceData.entryPoints[].uri	string	URI du point d'entrée. La longueur ne doit pas dépasser 1 300 caractères. Format : pour le schéma video, http: ou https:. Le schéma tel: est requis pour phone. L'URI doit inclure la séquence de numérotation complète (par exemple, tel:[phone],,,123456789;1234). Pour sip, le schéma sip: est requis (par exemple, sip:[e-mail]). pour le schéma more, http: ou https:.
conferenceData.notes	string	Notes supplémentaires (telles que les instructions de l'administrateur du domaine ou 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éfini pour une conférence dont la demande de création a échoué. Facultatif pour une conférence dont la demande de création est en attente.
created	datetime	Heure de création de l'événement (sous forme de code temporel RFC3339). Lecture seule.
creator	object	Créateur de l'événement. Lecture seule.
creator.displayName	string	Nom du créateur, s'il est disponible.
creator.email	string	Adresse e-mail du créateur, si disponible.
creator.id	string	ID de profil du créateur, le cas échéant.
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 récurrent, 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 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
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. 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	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 s'affiche 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.
focusTimeProperties	nested object	Données d'événement "Moment de concentration". Utilisé si eventType est focusTime.	accessible en écriture
focusTimeProperties.autoDeclineMode	string	Indique si les invitations à des réunions qui chevauchent les événements "Moment de concentration" doivent être refusées. Les valeurs valides sont declineNone (aucune invitation à une réunion n'est refusée), declineAllConflictingInvitations (toutes les invitations à une réunion qui entrent en conflit avec l'événement sont refusées) et declineOnlyNewConflictingInvitations (seules les nouvelles invitations à une réunion qui entrent en conflit avec l'événement "Temps de concentration" sont refusées).
focusTimeProperties.chatStatus	string	État à attribuer à l'utilisateur dans Chat et les produits associés. Peut être défini sur available ou doNotDisturb.
focusTimeProperties.declineMessage	string	Message de réponse à définir si un événement existant ou une nouvelle invitation sont automatiquement refusés par Agenda.
gadget	object	Gadget qui étend cet événement. Les gadgets sont obsolètes. Cette structure n'est désormais utilisée que pour renvoyer les métadonnées de l'agenda des anniversaires.
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.iconLink	string	URL de l'icône du gadget. Le schéma d'URL doit être HTTPS. Obsolète.	accessible en écriture
gadget.link	string	URL du gadget. Le schéma d'URL doit être 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 la liste 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 la RFC5545. Il permet d'identifier de manière unique les événements dans les systèmes d'agenda et doit être fourni lors de l'importation d'événements via la méthode import. 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. Pour récupérer un événement à l'aide de son iCalUID, appelez la méthode events.list en utilisant le 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 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
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 verrouillée d'un événement, dans laquelle aucune modification ne peut être apportée aux 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é dans une entrée distincte dans attendees, avec le champ organizer défini sur "True". Pour changer d'organisateur, utilisez l'opération move. En 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 de 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'un événement récurrent, il s'agit de l'heure à laquelle cet événement doit commencer selon les données de récurrence de l'événement récurrent identifié par recurringEventId. Il identifie de manière unique l'instance dans la série d'événements récurrents, même si elle a été déplacée à une autre heure. 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 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
outOfOfficeProperties.autoDeclineMode	string	Indique si les invitations à des réunions qui chevauchent les événements d'absence doivent être refusées. Les valeurs valides sont declineNone (aucune invitation à une réunion n'est refusée), declineAllConflictingInvitations (toutes les invitations à une réunion qui entrent en conflit avec l'événement sont refusées) et declineOnlyNewConflictingInvitations (seules les nouvelles invitations à une réunion qui entrent en conflit avec l'événement d'absence du bureau sont refusées).
outOfOfficeProperties.declineMessage	string	Message de réponse à définir si un événement existant ou une nouvelle invitation sont automatiquement refusés par Agenda.
privateCopy	boolean	Si la valeur est définie sur "True", la propagation des événements est désactivée. Notez que ce n'est pas la même chose que les 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 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
recurringEventId	string	Pour une instance d'événement récurrent, il s'agit de l'id de l'événement récurrent auquel appartient cette instance. Immuable.
reminders	object	Informations sur les rappels de l'événement pour l'utilisateur authentifié. Notez que la modification des rappels ne modifie pas la propriété updated de l'événement parent.
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	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 les voir ou les modifier.
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 récurrent, 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 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 : 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. 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 dans 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
updated	datetime	Heure de la dernière modification des données d'événement principal (sous forme de code temporel RFC3339). La modification des rappels d'événements n'aura aucune incidence. Lecture seule.
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

Méthodes

supprimer

Supprime un événement.

get

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 en utilisant le paramètre iCalUID.

import

 importe un événement. Cette opération permet d'ajouter une copie privée d'un événement existant à un agenda. Seuls les événements dont le eventType est défini sur default peuvent être importés.

Comportement obsolète : si un événement autre que default est importé, son type sera remplacé par default et toutes les propriétés spécifiques au type d'événement qu'il peut comporter seront supprimées.

insérer

Crée un événement.

instances

Renvoie les instances de l'événement récurrent spécifié.

liste

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

move

Déplace un événement vers un autre agenda, c'est-à-dire modifie l'organisateur d'un événement. Notez que seuls les événements default peuvent être déplacés. Les événements birthday, focusTime, fromGmail, outOfOffice et workingLocation ne peuvent pas l'être.

patch

Met à jour un événement. Cette méthode est compatible avec la sémantique "patch". Notez que chaque requête PATCH consomme trois unités de quota. Il est préférable d'utiliser un get suivi d'un update. Les valeurs de champ que vous spécifiez remplacent les valeurs existantes. Les champs que vous ne spécifiez pas dans la requête restent inchangés. Si des champs de tableau sont spécifiés, ils écrasent les tableaux existants, ce qui supprime tous les éléments de tableau précédents.

quickAdd

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

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 requête get suivie d'une requête update à l'aide d'etags pour garantir l'atomicité.

regarder

Surveille les modifications apportées aux ressources Events.