Events

L'API Calendar propose différentes versions des 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
    }
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Nom de propriété Valeur Description Notes
anyoneCanAddSelf boolean Indique si tous les participants peuvent s'inviter à l'événement (obsolète). Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
attachments[] list Joindre des fichiers à l'événement

Pour modifier les pièces jointes, vous devez définir le paramètre de requête supportsAttachments 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 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[].mimeType string Type de support Internet (type MIME) du rattachement.
attachments[].title string Titre de la pièce jointe.
attendeesOmitted boolean Indique s'il est possible d'omettre les participants 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 cette option 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, consultez le guide Événements avec les participants. Les comptes de service doivent utiliser une 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, s'il est disponible. Facultatif. accessible en écriture
attendees[].email string Adresse e-mail du participant, si elle est 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 lorsque vous ajoutez un participant.

accessible en écriture
attendees[].id string ID du profil du participant, s'il est disponible.
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 accepté provisoirement l'invitation.
  • "accepted" : le participant a accepté l'invitation.
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 ID de la conférence.

Les développeurs peuvent s'en servir pour effectuer 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 du Hangout. (Ce type de conférence est obsolète.)
  • hangoutsMeet: l'ID est le 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 ayant échoué à la demande de création.

Vous devez indiquer 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 toujours pouvoir afficher les points d'entrée. Toutefois, elle doit refuser les modifications.

Les valeurs possibles sont :

  • "eventHangout" pour Hangouts pour le grand public (obsolète : ce type de solution de conférence peut s'afficher dans les événements existants, mais il est impossible de créer des conférences)
  • "eventNamedHangout" pour les utilisateurs de la version classique de Hangouts pour Google Workspace (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)
  • "hangoutsMeet" pour Google Meet (http://meet.google.com)
  • "addOn" pour les fournisseurs de conférences 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 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 élément entryPoint ou createRequest.

conferenceData.createRequest.conferenceSolutionKey nested object 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 toujours pouvoir afficher les points d'entrée. Toutefois, elle doit refuser les modifications.

Les valeurs possibles sont :

  • "eventHangout" pour Hangouts pour le grand public (obsolète : ce type de solution de conférence peut s'afficher dans les événements existants, mais il est impossible de créer des conférences)
  • "eventNamedHangout" pour les utilisateurs de la version classique de Hangouts pour Google Workspace (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)
  • "hangoutsMeet" pour Google Meet (http://meet.google.com)
  • "addOn" pour les fournisseurs de conférences tiers

conferenceData.createRequest.requestId string Identifiant 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 le même que pour la requête précédente, cette dernière 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 la conférence a abouti, les points d'entrée sont renseignés.
  • "failure": la demande 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 spécifiques à la conférence (URL ou numéros de téléphone, par exemple).

Ils doivent tous appartenir à la même conférence.

Vous devez indiquer conferenceSolution et au moins un élément entryPoint ou createRequest.

conferenceData.entryPoints[].accessCode string Code d'accès à la conférence. 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} correspondant à la terminologie utilisée par le fournisseur de services 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" : participation à une conférence via HTTP. Une conférence ne peut comporter qu'un seul point d'entrée video.
  • "phone" : participation à une conférence en composant un numéro de téléphone Une conférence peut avoir phone point d'entrée ou plus.
  • "sip" : participation à une conférence via SIP. Une conférence ne peut comporter qu'un seul point d'entrée sip.
  • "more" : instructions de participation supplémentaires à la conférence (numéros de téléphone supplémentaires, par exemple). Une conférence ne peut comporter qu'un seul 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é Ne doit pas dépasser 512 caractères

Exemples :

  • pour video: meet.google.com/aaa-bbbb-ccc
  • pour phone: +1 123 268 2601
  • pour sip: 12345678@altostrat.com
  • pour more: ne doit pas être renseigné.

Facultatif.

conferenceData.entryPoints[].meetingCode string Code de la réunion pour accéder à la conférence. 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} correspondant à la terminologie utilisée par le fournisseur de services de conférence. Seuls les champs renseignés doivent être affichés.

Facultatif.

conferenceData.entryPoints[].passcode string Le code secret permettant d'accéder à la conférence. 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} correspondant à la terminologie utilisée par le fournisseur de services 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. 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} correspondant à la terminologie utilisée par le fournisseur de services 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. 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} correspondant à la terminologie utilisée par le fournisseur de services de 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:.
  • Le schéma tel: est obligatoire pour phone. L'URI doit inclure la séquence d'appels complète (par exemple, tel:+12345678900,,,123456789;1234).
  • pour sip, un schéma sip: est requis (ex. : sip:12345678@myprovider.com).
  • Veuillez indiquer un schéma more, http: ou https:.

conferenceData.notes string Notes supplémentaires (par exemple, des instructions de l'administrateur du domaine et des mentions légales) à afficher à l'utilisateur. Peut contenir du code HTML. Ne doit pas dépasser 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 ayant échoué à la demande de création.

Facultatif pour une conférence avec une demande de création 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 (si disponible).
creator.email string Adresse e-mail du créateur, si elle est disponible.
creator.id string L'ID du profil du créateur, s'il est disponible
creator.self boolean Indique si le créateur correspond à l'agenda dans lequel la 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 (exclue) 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", s'il s'agit d'un événement d'une journée entière. accessible en écriture
end.dateTime datetime Heure, sous la forme d'une valeur date/heure combinée (formatée selon 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 de l'IANA, par exemple "Europe/Zurich"). Pour les événements périodiques, 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. Une fois l'événement créé, vous ne pourrez plus modifier ce paramètre. Les valeurs possibles sont les suivantes:
  • "default" : événement standard ou non spécifié
  • "outOfOffice" : événement "Absent du bureau".
  • "focusTime" : événement de temps de travail.
  • "workingLocation" : événement de lieu de travail.
Actuellement, seuls les événements "default" et "workingLocation" peuvent être créés à l'aide de l'API. Une prise en charge étendue des autres types d'événements sera disponible dans les prochaines versions.
accessible en écriture
extendedProperties object Propriétés étendues de l'événement.
extendedProperties.private object Propriétés privées accessibles uniquement à la copie de l'événement qui apparaît sur cet agenda. accessible en écriture
extendedProperties.private.(key) string Nom de la propriété privée et valeur correspondante.
extendedProperties.shared object Les 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 étend cet événement. Les gadgets sont obsolètes. Cette structure est utilisée uniquement pour renvoyer des métadonnées de calendrier d'anniversaire.
gadget.display string Mode d'affichage du widget Obsolète. Les valeurs possibles sont les suivantes:
  • "icon" : le widget s'affiche à côté du titre de l'événement dans la vue de l'agenda.
  • "chip" : le widget s'affiche lorsque l'utilisateur clique sur l'événement.
accessible en écriture
gadget.height integer Hauteur du widget en pixels. La hauteur doit être un entier supérieur à zéro. Facultatif. 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 widget Obsolète. accessible en écriture
gadget.type string Type du widget. Obsolète. accessible en écriture
gadget.width integer Largeur du pixel en pixels. La largeur doit être un entier supérieur à zéro. 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 qui sont les participants à l'événement. Facultatif. La valeur par défaut est "True". accessible en écriture
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 dans les systèmes d'agenda. Il doit être fourni lorsque vous importez des événements via la méthode import.

Notez que les valeurs iCalUID et id ne sont pas identiques et qu'une seule d'entre elles doit être fournie au moment de la création de l'événement. L'une des différences sémantiques 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 indiquer son ID. Les ID fournis doivent respecter les règles suivantes:
  • les caractères autorisés dans l'ID correspondent à ceux utilisés dans l'encodage base32hex, c'est-à-dire aux lettres minuscules a-v et chiffres 0-9 (voir la section 3.1.2 de la RFC2938)
  • L'ID doit comprendre entre 5 et 1 024 caractères.
  • L'identifiant doit être unique pour chaque agenda.
En raison de la nature distribuée du système, nous ne pouvons pas garantir que les conflits d'ID seront détectés au moment de la création de l'événement. Pour minimiser 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 les valeurs icalUID et id ne sont pas identiques et qu'une seule d'entre elles doit être fournie au moment de la création de l'événement. L'une des différences sémantiques 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 S'il s'agit d'une copie d'événement verrouillée, aucune modification ne peut être apportée aux champs d'événement principaux "summary", "description", "location", "start", "end" ou "récurrence". La valeur par défaut est "False" (faux). Lecture seule.
organizer object Organisateur de l'événement. Si l'organisateur est aussi un participant, cela est indiqué avec une entrée distincte dans attendees, le champ organizer étant 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, si disponible. accessible en écriture
organizer.email string Adresse e-mail de l'organisateur, si elle est 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 il démarre, en fonction des données de récurrence de l'événement périodique identifié par le champ eventEventId. 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 vers un autre moment. 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 Heure, sous la forme d'une valeur date/heure combinée (formatée selon 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 de l'IANA, par exemple "Europe/Zurich"). Pour les événements périodiques, 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
privateCopy boolean Si ce paramètre est défini sur "True", la propagation d'événement est désactivée. Notez qu'il ne s'agit pas des propriétés d'événements privés. 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 indiqué 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 les événements périodiques. accessible en écriture
recurringEventId string Pour une instance d'événement périodique, il s'agit de la valeur 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 ou, s'il n'est pas défini, 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 un pop-up dans l'interface utilisateur.

Obligatoire lors de l'ajout d'un rappel.

accessible en écriture
reminders.overrides[].minutes integer Nombre de minutes avant le début de l'événement au cours duquel 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 (titre d'une page Web ou d'un e-mail, par exemple). 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", s'il s'agit d'un événement d'une journée entière. accessible en écriture
start.dateTime datetime Heure, sous la forme d'une valeur date/heure combinée (formatée selon 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 de l'IANA, par exemple "Europe/Zurich"). Pour les événements périodiques, 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. 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 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 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:

    1. Les exceptions annulées d'un événement périodique non annulé indiquent que l'instance ne doit plus être présentée à l'utilisateur. Les clients doivent stocker ces événements pendant la durée de vie de l'événement périodique parent.

      La valeur des champs id, recurringEventId et originalStartTime n'est garantie que pour les exceptions annulées. Les autres champs peuvent être vides.

    2. Tous les autres événements annulés représentent des événements supprimés. Les clients doivent supprimer leurs copies synchronisées localement. Ces événements annulés finissent par disparaître, alors ne vous attendez pas à ce qu'ils soient disponibles indéfiniment.

      Le champ id ne peut être renseigné que pour 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 (non 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 détails. Cependant, les requêtes de synchronisation incrémentielle dont la valeur showDeleted est définie sur "false" ne renvoient pas ces détails.

    Si un événement change d'organisateur (par exemple, via l'opération move) 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 cependant l'heure dans l'agenda. Cela revient à définir le paramètre Ma disponibilité sur Occupé dans l'interface utilisateur d'Agenda.
  • "transparent" : l'événement ne bloque pas l'heure dans l'agenda. Cela revient à définir l'option Démonstration sur Disponible dans l'interface utilisateur d'Agenda.
accessible en écriture
updated datetime Date et heure de la dernière modification de l'événement (sous la forme d'un horodatage 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 le concernant 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énements de lieu de travail. accessible en écriture
workingLocationProperties.customLocation object Le cas échéant, indique que l'utilisateur travaille depuis un emplacement personnalisé. accessible en écriture
workingLocationProperties.customLocation.label string Libellé supplémentaire facultatif pour des informations supplémentaires accessible en écriture
workingLocationProperties.homeOffice any value Le cas échéant, indique que l'utilisateur travaille à la maison. accessible en écriture
workingLocationProperties.officeLocation object Le cas échéant, 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 ID de bâtiment figurant 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 d'étage facultatif. accessible en écriture
workingLocationProperties.officeLocation.floorSectionId string Un identifiant de section d'étage facultatif. accessible en écriture
workingLocationProperties.officeLocation.label string Nom du bureau affiché dans les clients Web et mobile d'Agenda. Nous vous recommandons de référencer le 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. Les valeurs possibles sont les suivantes:
  • "homeOffice" : l'utilisateur est en télétravail.
  • "officeLocation" : l'utilisateur travaille dans un bureau.
  • "customLocation" : l'utilisateur travaille depuis un emplacement personnalisé.
Toute information est indiquée 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 lorsque vous ajoutez des propriétés sur le 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.
Importer
Importez un événement. Cette opération permet d'ajouter la copie privée d'un événement existant à un agenda.
Insérer
Crée un événement.
d'instances
Renvoie les instances de l'événement périodique spécifié.
list
Renvoie les événements de l'agenda spécifié.
déménager
Déplace un événement vers un autre agenda, par exemple en modifiant 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 corrective utilise trois unités de quota. Il est préférable d'utiliser un get suivi d'un update. Les valeurs de champs que vous spécifiez remplacent les valeurs existantes. Les champs que vous ne spécifiez pas dans la requête restent inchangés. Le cas échéant, les champs de tableau écrasent les tableaux existants. L'ensemble des éléments du tableau est alors supprimé.
Ajout rapide
Crée un événement en fonction d'une chaîne de texte simple.
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 un get suivi d'un update à l'aide d'etags pour garantir l'atomicité.
regarder
Surveillez les modifications apportées aux ressources "Événements".