Events

L'API Calendar fournit 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": {
    "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 les utilisateurs peuvent s'inviter à l'événement (obsolète). Facultatif. La valeur par défaut est "False" (faux).	accessible en écriture
attachments[]	list	Fichiers joints à l'événement. Pour modifier les pièces jointes, le paramètre de requête supportsAttachments doit être défini sur true. Vous ne pouvez pas ajouter 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 Google Drive, utilisez le même format que dans la propriété alternateLink de la ressource Files dans l'API Drive. Obligatoire lors de l'ajout d'une pièce jointe.	accessible en écriture
attachments[].iconLink	string	Lien vers l'URL de l'icône de l'élément joint. 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. Lorsque vous modifiez un événement, cette option ne peut être utilisée que pour mettre à jour la réponse du participant. Facultatif. La valeur par défaut est "False" (faux).	accessible en écriture
attendees[]	list	Participants à l'événement. Pour en savoir plus sur la planification d'événements avec d'autres utilisateurs de l'agenda, consultez le guide Événements avec des participants. Les comptes de service doivent utiliser la délégation d'autorité au niveau du domaine pour 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 personne interrogée. Facultatif.	accessible en écriture
attendees[].displayName	string	Nom du participant, si disponible. Facultatif.	accessible en écriture
attendees[].email	string	Adresse e-mail de l'participant (si disponible) Ce champ doit être présent lorsque vous ajoutez un participant. Il doit s'agir d'une adresse e-mail valide, conformément à la norme RFC5322. Obligatoire lors de l'ajout d'un participant.	accessible en écriture
attendees[].id	string	ID de profil de l'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. Ne peut être défini que lorsque le participant est ajouté à l'événement pour la première fois. Les modifications ultérieures sont ignorées. Facultatif. La valeur par défaut est "False" (faux).	accessible en écriture
attendees[].responseStatus	string	État de la réponse de l'utilisateur. Les valeurs possibles sont les suivantes: "needsAction" : le participant n'a pas répondu à l'invitation (recommandé pour les nouveaux événements). "declined" - Le participant a refusé l'invitation. "tentative" : le participant a accepté provisoirement l'invitation. "accepted" : l'invité a accepté l'invitation. Avertissement:Si vous ajoutez un événement avec les valeurs declined, tentative ou accepted, les participants dont le paramètre "Ajouter des invitations à mon agenda" est défini sur "Lorsque je réponds à une invitation par e-mail" ou "Uniquement si je connais l'expéditeur" risquent de voir leur réponse réinitialisée sur needsAction. Aucun événement ne s'affichera dans leur agenda, sauf s'ils modifient leur réponse dans l'e-mail d'invitation à l'événement. En outre, si plus de 200 personnes sont invitées à l'événement, l'état de la réponse n'est pas communiqué 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 d'anniversaire ou d'événement spécial Utilisé si eventType est défini sur "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 extraire les coordonnées des contacts à 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 Les valeurs possibles sont les suivantes: "anniversary" : anniversaire autre qu'un anniversaire. A toujours un contact. "birthday" : é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. Contient toujours un contact. "other" : date spéciale qui ne correspond à aucune des autres catégories et qui ne possède pas de libellé personnalisé. A toujours un contact. "self" : anniversaire du propriétaire de l'agenda. Ne peut pas avoir de contact. L'API Calendar ne permet de créer que des événements de type "birthday". Une fois l'événement créé, le type ne peut plus être modifié.	accessible en écriture
colorId	string	Couleur de l'événement. Il s'agit d'un ID faisant référence à une entrée de la section event de la définition des couleurs (voir le point de terminaison des couleurs). Facultatif.	accessible en écriture
conferenceData	nested object	Informations sur la conférence, telles que les détails d'une conférence Google Meet. Pour créer des informations sur une conférence, utilisez le champ createRequest. Pour que vos modifications soient conservées, n'oubliez pas de définir le paramètre de requête conferenceDataVersion sur 1 pour toutes les requêtes de modification d'événement.	accessible en écriture
conferenceData.conferenceId	string	ID de la conférence. Peut être utilisé par les développeurs pour suivre les conférences. Ne doit pas être visible par les 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: l'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, par exemple Google Meet Non défini pour une conférence dont la demande de création a échoué. Vous devez renseigner conferenceSolution et au moins un élément 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 quand même pouvoir afficher les points d'entrée. Toutefois, les modifications devraient être interdites. Les valeurs possibles sont : "eventHangout" pour Hangouts pour le grand public (obsolète ; ce type de solution de conférence peut être affiché dans des événements existants, mais il est impossible d'en créer de nouvelles) "eventNamedHangout" pour la version classique de Hangouts pour les utilisateurs Google Workspace (obsolète : les événements existants peuvent afficher ce type de solution de conférence, mais vous ne pouvez pas en créer) "hangoutsMeet" pour Google Meet (http://meet.google.com) "addOn" pour les fournisseurs de visioconférence tiers
conferenceData.conferenceSolution.name	string	Nom visible de cette solution. Non localisé.
conferenceData.createRequest	nested object	Requête permettant de générer une nouvelle conférence et de la joindre à 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	La solution de conférence, comme 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 quand même pouvoir afficher les points d'entrée. Toutefois, les modifications devraient être interdites. Les valeurs possibles sont : "eventHangout" pour Hangouts pour le grand public (obsolète ; ce type de solution de conférence peut être affiché dans des événements existants, mais il est impossible d'en créer de nouvelles) "eventNamedHangout" pour la version classique de Hangouts pour les utilisateurs Google Workspace (obsolète : les événements existants peuvent afficher ce type de solution de conférence, mais vous ne pouvez pas en créer) "hangoutsMeet" pour Google Meet (http://meet.google.com) "addOn" pour les fournisseurs de visioconférence tiers
conferenceData.createRequest.requestId	string	Identifiant unique généré par le client pour cette requête. Les clients doivent générer à nouveau cet ID pour chaque nouvelle requête. Si l'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 requête de création de la 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 requête 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 réussi, 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 pas de points d'entrée.
conferenceData.entryPoints[]	list	Informations sur les points d'accès individuels à la conférence, telles que des URL ou des numéros de téléphone. Ils doivent tous appartenir à la même conférence. Vous devez renseigner conferenceSolution et au moins un élément 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, renseignez uniquement le sous-ensemble des 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. Les valeurs possibles sont : "video" : rejoindre une conférence via HTTP. Une conférence peut avoir zéro ou un point d'entrée video. "phone" : pour participer à une conférence en composant un numéro de téléphone. Une conférence peut avoir zéro ou plusieurs points d'entrée phone. "sip" : participation à une confé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 des 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 comportant qu'un point d'entrée more n'est pas valide.
conferenceData.entryPoints[].label	string	Libellé de l'URI. Visibles 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 réunion 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, renseignez uniquement le sous-ensemble des 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 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, renseignez uniquement le sous-ensemble de champs {meetingCode, accessCode, passcode, password, pin} correspondant à la terminologie utilisée par le fournisseur de conférences. 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 maximale est de 128 caractères. Lorsque vous créez des données de conférence, renseignez uniquement le sous-ensemble des 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 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, renseignez uniquement le sous-ensemble des 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 maximale est de 1 300 caractères. Format : pour le schéma video, http: ou https: est obligatoire. Pour phone, un schéma tel: est requis. L'URI doit inclure l'intégralité de la séquence de numérotation (par exemple, tel:[phone],,,123456789;1234). Pour sip, le schéma sip: est obligatoire (par exemple, sip:[e-mail]). pour le schéma more, http: ou https: est requis.
conferenceData.notes	string	Notes supplémentaires (instructions de l'administrateur du domaine, mentions légales, etc.) à afficher pour 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 pour laquelle la requête de création a échoué. Facultatif pour les conférences avec une demande de création en attente.
created	datetime	Heure de création de l'événement (au format RFC3339). Lecture seule.
creator	object	Créateur de l'événement. Lecture seule.
creator.displayName	string	Nom du créateur, le cas échéant.
creator.email	string	Adresse e-mail du créateur, le cas échéant.
creator.id	string	ID de profil du créateur, le cas échéant
creator.self	boolean	Indique si le créateur correspond au calendrier sur lequel cette copie de l'événement s'affiche. 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 heure (formatée conformément à la norme RFC3339). Un décalage horaire est obligatoire, sauf si un fuseau horaire est explicitement spécifié dans timeZone.	accessible en écriture
end.timeZone	string	Fuseau horaire dans lequel l'heure est spécifiée. (au format de nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements récurrents, ce champ est obligatoire et spécifie le fuseau horaire dans lequel la récurrence est développée. Pour les événements uniques, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début/la fin de l'événement.	accessible en écriture
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. Une fois l'événement créé, vous ne pourrez plus modifier ce paramètre. Les valeurs possibles sont: "birthday" : événement spécial sur toute une journée avec une récurrence annuelle. "default" : événement régulier ou non spécifié. "focusTime" : événement "Moment de concentration". "fromGmail" : événement ajouté à partir de Gmail. Il est impossible de créer ce type d'événement. "outOfOffice" : é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 réservées à 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 figurant 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 des événements "Moment de concentration" doivent être refusées. Les valeurs valides sont declineNone, ce qui signifie qu'aucune invitation à une réunion n'est refusée ; declineAllConflictingInvitations, ce qui signifie que toutes les invitations à une réunion en conflit avec l'événement sont refusées ; et declineOnlyNewConflictingInvitations, ce qui signifie que seules les nouvelles invitations à une réunion en conflit qui arrivent pendant l'événement "Moment de concentration" doivent être 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 est automatiquement refusé par Agenda.
gadget	object	Gadget qui étend cet événement. Les gadgets sont obsolètes. Cette structure n'est utilisée que pour renvoyer les métadonnées du 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 Agenda. "chip" : le gadget s'affiche lorsque l'utilisateur clique sur l'événement.	accessible en écriture
gadget.height	integer	Hauteur du gadget en pixels. La hauteur doit être un entier supérieur à 0. Facultatif. Obsolète.	accessible en écriture
gadget.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 de gadget. Obsolète.	accessible en écriture
gadget.width	integer	Largeur du gadget en pixels. La largeur doit être un entier supérieur à 0. Facultatif. Obsolète.	accessible en écriture
guestsCanInviteOthers	boolean	Indique si des participants autres que l'organisateur peuvent inviter d'autres personnes à l'événement. Facultatif. La valeur par défaut est "True".	accessible en écriture
guestsCanModify	boolean	Indique si 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 qui sont les participants à l'événement. Facultatif. La valeur par défaut est "True".	accessible en écriture
hangoutLink	string	Lien absolu vers le Google Hangout 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 (importer). 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. L'une des différences de sémantique est que, dans les événements périodiques, toutes les occurrences d'un événement ont des id différents, alors qu'elles partagent toutes les mêmes 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 des événements ponctuels 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.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 calendrier. En raison de la nature distribuée à l'échelle mondiale du système, 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 réduire le risque de collision, nous vous recommandons d'utiliser un algorithme d'UUID établi, tel que celui décrit dans le document RFC4122. Si vous ne spécifiez pas d'ID, il sera automatiquement généré par le serveur. Notez que icalUID et id ne sont pas identiques. Vous ne devez fournir qu'un seul d'entre eux au moment de la création de l'événement. Une différence de sémantique est que, dans les événements récurrents, toutes les occurrences d'un événement ont des id différents, mais partagent tous 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 d'événement verrouillée dans laquelle aucune modification ne peut être apportée aux champs principaux de l'événement "summary" (Résumé), "description" (Description), "location" (Lieu), "start" (Début), "end" (Fin) ou "recurrence" (Récurrence). 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é par 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, si 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 sur lequel cette copie de l'événement s'affiche. Lecture seule. La valeur par défaut est "False" (faux).
originalStartTime	nested object	Dans le cas d'un événement périodique, il s'agit de l'heure à laquelle cet événement commencera, selon les données de récurrence de l'événement récurrent identifié par "recurrentEventId". Il permet d'identifier 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 date. Immuable.
originalStartTime.date	date	Date au format "aaaa-mm-jj", s'il s'agit d'un événement d'une journée entière.	accessible en écriture
originalStartTime.dateTime	datetime	L'heure, sous la forme d'une valeur date-heure combinée (mise en forme conformément à la norme RFC3339). Un décalage horaire est obligatoire, sauf si un fuseau horaire est explicitement spécifié dans timeZone.	accessible en écriture
originalStartTime.timeZone	string	Fuseau horaire dans lequel l'heure est spécifiée. (au format de nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements récurrents, ce champ est obligatoire et spécifie le fuseau horaire dans lequel la récurrence est développée. Pour les événements uniques, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début/la fin de l'événement.	accessible en écriture
outOfOfficeProperties	nested object	Données d'événement "Absent du bureau". Utilisé si eventType est outOfOffice.	accessible en écriture
outOfOfficeProperties.autoDeclineMode	string	Permet de refuser les invitations à des réunions qui chevauchent des événements d'absence du bureau. Les valeurs valides sont declineNone, ce qui signifie qu'aucune invitation à une réunion n'est refusée ; declineAllConflictingInvitations, ce qui signifie que toutes les invitations à une réunion en conflit avec l'événement sont refusées ; et declineOnlyNewConflictingInvitations, ce qui signifie que seules les nouvelles invitations à une réunion en conflit qui arrivent lorsque l'événement "Absent" est présent doivent être refusées.
outOfOfficeProperties.declineMessage	string	Message de réponse à définir si un événement existant ou une nouvelle invitation est automatiquement refusée par Agenda.
privateCopy	boolean	Si elle est définie sur "True", la propagation des événements est désactivée. Notez qu'il ne s'agit pas des 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 uniques ou les occurrences d'événements récurrents.	accessible en écriture
recurringEventId	string	Pour une instance d'un événement périodique, il s'agit de l'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é. Notez que la modification des rappels n'a pas d'incidence sur la propriété updated de l'événement englobant.
reminders.overrides[]	list	Si l'événement n'utilise pas les rappels par défaut, les rappels spécifiques à l'événement sont listés. Si aucun rappel n'est défini, cela indique qu'aucun rappel n'est défini pour cet événement. Le nombre maximal de rappels de forçage est de cinq.	accessible en écriture
reminders.overrides[].method	string	Méthode utilisée pour ce rappel. Les valeurs possibles sont les suivantes: "email" : les rappels sont envoyés par e-mail. "popup" : les rappels sont envoyés via une fenêtre pop-up de l'UI. Obligatoire lors de l'ajout d'un rappel.	accessible en écriture
reminders.overrides[].minutes	integer	Nombre de minutes avant le début de l'événement auquel le rappel doit être déclenché. Les valeurs valides sont comprises entre 0 et 40 320 (4 semaines en minutes). Obligatoire lors de l'ajout d'un rappel.	accessible en écriture
reminders.useDefault	boolean	Indique si les rappels par défaut de l'agenda s'appliquent à l'événement.	accessible en écriture
sequence	integer	Numéro de séquence selon iCalendar.	accessible en écriture
source	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 le consulter ou le modifier.
source.title	string	Titre de la source (par exemple, titre d'une page Web ou objet d'un e-mail)	accessible en écriture
source.url	string	URL de la source pointant vers une ressource. Le schéma d'URL doit être HTTP ou HTTPS.	accessible en écriture
start	nested object	Heure de début (inclusive) de l'événement. Pour un événement récurrent, il s'agit de l'heure de début de la première instance.
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 heure (formatée conformément à la norme RFC3339). Un décalage horaire est obligatoire, sauf si un fuseau horaire est explicitement spécifié dans timeZone.	accessible en écriture
start.timeZone	string	Fuseau horaire dans lequel l'heure est spécifiée. (au format de nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich") Pour les événements récurrents, ce champ est obligatoire et spécifie le fuseau horaire dans lequel la récurrence est développée. Pour les événements uniques, ce champ est facultatif et indique un fuseau horaire personnalisé pour le début/la fin de l'événement.	accessible en écriture
status	string	État de l'événement. Facultatif. Les valeurs possibles sont les suivantes: "confirmed" : l'événement est confirmé. Il s'agit de l'état par défaut. tentative : l'événement est confirmé. "cancelled" : l'événement a été annulé (supprimé). La méthode list ne renvoie les événements annulés que lors d'une synchronisation incrémentielle (lorsque syncToken ou updatedMin sont spécifiés) ou si l'indicateur showDeleted est défini sur true. La méthode get les renvoie toujours. Un état "Annulé" représente deux états différents en fonction du type d'événement: Les exceptions annulées d'un événement récurrent non annulé indiquent que cette instance ne doit plus être présentée à l'utilisateur. Les clients doivent stocker ces événements pendant toute la durée de vie de l'événement périodique parent. Pour les exceptions annulées, seules les valeurs des champs id, recurringEventId et originalStartTime sont renseignées. Les autres champs peuvent être vides. Tous les autres événements annulés représentent des événements supprimés. Les clients doivent supprimer leurs copies synchronisées localement. Ces événements annulés finiront par disparaître. Par conséquent, ne comptez pas sur leur disponibilité indéfiniment. Seul le champ id est renseigné pour les événements supprimés. Dans l'agenda de l'organisateur, les détails des événements annulés (récapitulatif, lieu, etc.) restent visibles afin qu'ils puissent être restaurés ou supprimés. De même, les événements auxquels l'utilisateur a été invité et qu'il a supprimés manuellement continuent de fournir des informations. Toutefois, les requêtes de synchronisation incrémentielle avec showDeleted défini sur "false" ne renvoient pas ces informations. Si un événement change d'organisateur (par exemple, via l'opération move) et que l'organisateur d'origine ne figure pas dans la liste des participants, l'événement sera annulé, 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 une période dans l'agenda. Facultatif. Les valeurs possibles sont les suivantes: "opaque" : valeur par défaut. En revanche, l'événement bloque du temps dans l'agenda. Cela revient à définir Me montrer comme sur Occupé dans l'interface utilisateur de l'agenda. "transparent" : l'événement ne bloque pas de créneau horaire dans l'agenda. Cela équivaut à définir Me montrer comme sur Disponible dans l'interface utilisateur d'Agenda.	accessible en écriture
updated	datetime	Heure de la dernière modification des données d'événement principales (au format code temporel RFC3339). La mise à jour des rappels d'événement n'a aucune incidence sur ces changements. 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 ses détails sont visibles par tous les lecteurs de l'agenda. "private" : l'événement est privé et seuls les participants peuvent en voir les détails. "confidential" : l'événement est privé. Cette valeur est fournie pour des raisons de compatibilité.	accessible en écriture
workingLocationProperties	nested object	Données d'événement de lieu de travail	accessible en écriture
workingLocationProperties.customLocation	object	S'il est présent, indique que l'utilisateur travaille dans un lieu personnalisé.	accessible en écriture
workingLocationProperties.customLocation.label	string	Libellé supplémentaire facultatif pour des informations supplémentaires.	accessible en écriture
workingLocationProperties.homeOffice	any value	S'il est présent, indique que l'utilisateur travaille à domicile.	accessible en écriture
workingLocationProperties.officeLocation	object	S'il est présent, indique que l'utilisateur travaille depuis un bureau.	accessible en écriture
workingLocationProperties.officeLocation.buildingId	string	Identifiant de bâtiment facultatif. Il doit faire référence à un identifiant de bâtiment dans la base de données des ressources de l'organisation.	accessible en écriture
workingLocationProperties.officeLocation.deskId	string	Identifiant de bureau facultatif.	accessible en écriture
workingLocationProperties.officeLocation.floorId	string	Identifiant de l'étage (facultatif)	accessible en écriture
workingLocationProperties.officeLocation.floorSectionId	string	Identifiant facultatif de section d'étage.	accessible en écriture
workingLocationProperties.officeLocation.label	string	Nom du bureau affiché dans les clients Agenda pour le Web et les mobiles. Nous vous recommandons de faire référence au nom d'un bâtiment dans la base de données de ressources de l'organisation.	accessible en écriture
workingLocationProperties.type	string	Type de lieu de travail. Les valeurs possibles sont: "homeOffice" : l'utilisateur travaille à domicile. "officeLocation" : l'utilisateur travaille depuis un bureau. "customLocation" : l'utilisateur travaille depuis un emplacement personnalisé. Les détails sont spécifiés dans un sous-champ du nom spécifié, mais ce champ peut être manquant s'il est vide. Tous les autres champs sont ignorés. Obligatoire lors de l'ajout de propriétés de lieu de travail.	accessible en écriture

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 à l'aide du 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 l'attribut eventType est défini sur default peuvent être importés.

Comportement obsolète:si un événement autre que default est importé, son type est remplacé par default et toutes les propriétés spécifiques au type d'événement qu'il peut avoir sont 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é.

déplacer

Déplace un événement vers un autre agenda, c'est-à-dire modifie l'organisateur de l'é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

Modifie un événement. Cette méthode est compatible avec la sémantique "patch". Notez que chaque requête de correctif consomme trois unités de quota. Nous vous recommandons 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 spécifiés, les champs de tableau écrasent les tableaux existants. Tous les éléments de tableau précédents sont alors supprimés.

quickAdd

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

update

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

montre

Surveillez les modifications apportées aux ressources Events.