Events

L'API Calendar propose différents types de ressources pour les é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
    }
  ],
  "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 des pièces jointes, le paramètre de requête supportsAttachments doit être défini sur true.

Le nombre de pièces jointes par événement est limité à 25.

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[].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 été omis de la représentation de l'événement. Lors de la récupération d'un événement, cela peut être dû à une restriction spécifiée par le paramètre de requête maxAttendee. Lors de la mise à jour d'un événement, cette option permet uniquement de 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 savoir comment planifier des événements avec d'autres utilisateurs d'agenda, consultez le guide Événements avec 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 de personnes supplémentaires. Facultatif. La valeur par défaut est 0. accessible en écriture
attendees[].comment string Commentaire sur la réponse du participant. Facultatif. accessible en écriture
attendees[].displayName string Nom du participant, si disponible Facultatif. accessible en écriture
attendees[].email string Adresse e-mail du participant, si disponible Ce champ doit être présent lors de l'ajout d'un participant. Il doit s'agir d'une adresse e-mail valide conformément à la norme RFC5322.

Obligatoire lors de l'ajout d'un participant.

accessible en écriture
attendees[].id string ID de profil du participant, si 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. Cette option ne peut être définie 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. Les valeurs possibles sont:
  • 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é 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. Cet ID fait 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, par exemple les détails d'une conférence Google Meet. Pour créer les détails d'une nouvelle 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.

Peut être utilisé par les développeurs pour suivre les conférences, ne doit pas être affiché 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: l'ID correspond au nom du Hangout. (Ce type de conférence est obsolète.)
  • hangoutsMeet: l'ID correspond au code de la réunion à 10 lettres, par exemple aaa-bbbb-ccc.
  • addOn: l'ID est défini par le fournisseur tiers.
(Facultatif)

conferenceData.conferenceSolution nested object Les solutions de conférence, telles que Google Meet

Cette option est désactivée pour les conférences dont la demande de création a échoué.

conferenceSolution et au moins un élément entryPoint ou createRequest sont obligatoires.

conferenceData.conferenceSolution.iconUri string Icône visible par l'utilisateur pour cette solution
conferenceData.conferenceSolution.key nested object Clé permettant d'identifier de façon unique la solution de conférence utilisée pour cet événement.
conferenceData.conferenceSolution.key.type string Type de solution de conférence.

Si un client rencontre un type inconnu ou vide, il devrait toujours pouvoir afficher les points d'entrée. Toutefois, les modifications doivent être interdites.

Les valeurs possibles sont :

  • "eventHangout" pour les Hangouts grand public (obsolète ; il est possible que ce type de solution de conférence soit proposé dans les événements existants, mais vous ne pouvez pas créer de conférences)
  • "eventNamedHangout" pour les utilisateurs de la version classique de Hangouts pour les utilisateurs de Google Workspace (obsolète ; les événements existants peuvent présenter 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 services de conférence tiers

conferenceData.conferenceSolution.name string Nom de cette solution visible par l'utilisateur. Non localisé.
conferenceData.createRequest nested object Demande de génération d'une nouvelle 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, vérifiez le champ status.

conferenceSolution et au moins un élément entryPoint ou createRequest sont obligatoires.

conferenceData.createRequest.conferenceSolutionKey nested object Les solutions de conférence, telles que Hangouts ou Google Meet
conferenceData.createRequest.conferenceSolutionKey.type string Type de solution de conférence.

Si un client rencontre un type inconnu ou vide, il devrait toujours pouvoir afficher les points d'entrée. Toutefois, les modifications doivent être interdites.

Les valeurs possibles sont :

  • "eventHangout" pour les Hangouts grand public (obsolète ; il est possible que ce type de solution de conférence soit proposé dans les événements existants, mais vous ne pouvez pas créer de conférences)
  • "eventNamedHangout" pour les utilisateurs de la version classique de Hangouts pour les utilisateurs de Google Workspace (obsolète ; les événements existants peuvent présenter 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 services de conférence tiers

conferenceData.createRequest.requestId string Identifiant unique généré par le client pour cette requête.

Les clients doivent générer de nouveau cet ID pour chaque nouvelle requête. Si un ID fourni est identique à celui de la requête précédente, la requête est ignorée.

conferenceData.createRequest.status nested object État de la demande de création de conférence.
conferenceData.createRequest.status.statusCode string État actuel de la demande de création de conférence. Lecture seule.

Les valeurs possibles sont :

  • "pending": la demande de création de conférence est toujours en cours de traitement.
  • "success": la requête de création de conférence a réussi, les points d'entrée sont renseignés.
  • "failure": échec de la demande de création de conférence. Il n'y a aucun point d'entrée.

conferenceData.entryPoints[] list Informations sur chaque point d'entrée d'une conférence (URL ou numéros de téléphone, par exemple).

Tous doivent appartenir à la même conférence.

conferenceSolution et au moins un élément entryPoint ou createRequest sont obligatoires.

conferenceData.entryPoints[].accessCode string Code d'accès à la conférence. Il ne doit pas dépasser 128 caractères.

Lorsque vous créez des données de conférence, remplissez uniquement le sous-ensemble des champs {meetingCode, accessCode, passcode, password, pin} qui correspondent à la terminologie utilisée par le fournisseur de conférences. Seuls les champs renseignés doivent s'afficher.

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 peut avoir zéro ou un point d'entrée video.
  • "phone" : participation à 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" : autres instructions pour participer à 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 avec un seul point d'entrée more n'est pas une conférence valide.

conferenceData.entryPoints[].label string Libellé de l'URI. Visible par les utilisateurs finaux Non localisé. Il 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 Le code de la réunion pour accéder à la conférence Il ne doit pas dépasser 128 caractères.

Lorsque vous créez des données de conférence, remplissez uniquement le sous-ensemble des champs {meetingCode, accessCode, passcode, password, pin} qui correspondent à la terminologie utilisée par le fournisseur de conférences. Seuls les champs renseignés doivent s'afficher.

Facultatif.

conferenceData.entryPoints[].passcode string Code secret d'accès à la conférence Il ne doit pas dépasser 128 caractères.

Lorsque vous créez des données de conférence, remplissez uniquement le sous-ensemble des champs {meetingCode, accessCode, passcode, password, pin} qui correspondent à la terminologie utilisée par le fournisseur de conférences. Seuls les champs renseignés doivent s'afficher.

conferenceData.entryPoints[].password string Mot de passe permettant d'accéder à la conférence. Il ne doit pas dépasser 128 caractères.

Lorsque vous créez des données de conférence, remplissez uniquement le sous-ensemble des champs {meetingCode, accessCode, passcode, password, pin} qui correspondent à la terminologie utilisée par le fournisseur de conférences. Seuls les champs renseignés doivent s'afficher.

Facultatif.

conferenceData.entryPoints[].pin string Code d'accès à la conférence Il ne doit pas dépasser 128 caractères.

Lorsque vous créez des données de conférence, remplissez uniquement le sous-ensemble des champs {meetingCode, accessCode, passcode, password, pin} qui correspondent à la terminologie utilisée par le fournisseur de conférences. Seuls les champs renseignés doivent s'afficher.

Facultatif.

conferenceData.entryPoints[].uri string URI du point d'entrée. Il ne doit pas dépasser 1 300 caractères.

Format:

  • pour le schéma video, http: ou https: est requis.
  • Pour phone, le schéma tel: est requis. L'URI doit inclure la séquence de numérotation complète (par exemple, tel:+12345678900,,123456789;1234).
  • Pour sip, un schéma sip: est requis (par exemple, sip:12345678@myprovider.com).
  • pour le schéma more, http: ou https: est requis.

conferenceData.notes string Remarques supplémentaires (instructions de l'administrateur du domaine, mentions légales, etc.) à présenter à 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.

Cette option est désactivée pour les conférences dont la demande de création a échoué.

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 d'horodatage RFC3339). Lecture seule.
creator object Créateur de l'événement. Lecture seule.
creator.displayName string Nom du créateur, si disponible
creator.email string Adresse e-mail du créateur, si disponible
creator.id string ID du profil du créateur, si disponible.
creator.self boolean Indique si le créateur correspond à l'agenda sur lequel cette copie de l'événement apparaît. Lecture seule. La valeur par défaut est "False" (faux).
description string Description de l'événement. Peut contenir du code HTML. Facultatif. accessible en écriture
end nested object Heure de fin (exclusive) de l'événement. Pour un événement périodique, il s'agit de l'heure de fin de la première occurrence.
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 forme de valeur de date et d'heure combinée (dans le format 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. (au format de 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 indique le fuseau horaire dans lequel la récurrence est étendue. Pour les événements individuels, 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:
  • "default" : événement standard ou autre élément non précisé.
  • "outOfOffice" : événement "Absent du bureau".
  • "focusTime" : événement "Moment de concentration".
  • "workingLocation" : un événement de lieu de travail.
Actuellement, seuls les événements "default" et "workingLocation" peuvent être créés à l'aide de l'API. La prise en charge étendue d'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 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 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 défini sur focusTime. accessible en écriture
focusTimeProperties.autoDeclineMode string Permet de refuser ou non les invitations à des réunions qui se chevauchent avec des événements "Moment de concentration". Les valeurs valides sont declineNone (aucune invitation à une réunion refusée), declineAllConflictingInvitations (toutes les invitations en conflit qui entrent en conflit avec l'événement) et declineOnlyNewConflictingInvitations (qui signifie que seules les nouvelles invitations en conflit reçues pendant l'événement "Moment de concentration") doivent être refusées.
focusTimeProperties.chatStatus string État à marquer pour l'utilisateur dans Chat et les produits associés. Peut être défini sur available ou doNotDisturb.
focusTimeProperties.declineMessage string Message de réponse permettant de définir si un événement existant ou une nouvelle invitation est automatiquement refusé par Agenda.
gadget object Gadget qui prolonge cet événement. Les gadgets sont obsolètes. Cette structure est uniquement utilisée pour renvoyer les métadonnées d'un calendrier d'anniversaires.
gadget.display string Mode d'affichage du gadget Obsolète. Les valeurs possibles sont:
  • "icon" : le gadget s'affiche à côté du titre de l'événement dans la vue de l'agenda.
  • "chip" : le gadget s'affiche lorsqu'un 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 à 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 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 à 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 Ce paramètre 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 d'événement, tel que défini dans le document RFC5545. Ce nom sert à identifier les événements de manière unique sur tous les systèmes d'agenda et doit être fourni lors de l'importation des événements via la méthode import.

Notez que les éléments 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 sémantiques entre les événements récurrents est que toutes les occurrences d'un événement ont des id différentes alors qu'elles partagent les mêmes iCalUID. Pour récupérer un événement à l'aide de son iCalUID, appelez la méthodeevents.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 uniques ou récurrents, vous pouvez spécifier leur ID. Les ID fournis doivent respecter les règles suivantes:
  • Les caractères autorisés dans l'ID sont ceux utilisés pour l'encodage base32hex, c'est-à-dire les lettres minuscules a-v et les chiffres de 0 à 9 (voir la section 3.1.2 du document RFC2938).
  • L'ID doit comporter entre 5 et 1 024 caractères
  • L'ID doit être unique pour chaque agenda.
En raison de la nature mondiale du système, nous ne pouvons garantir que les conflits d'ID seront détectés 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 les éléments 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 sémantiques entre les événements récurrents est que toutes les occurrences d'un événement ont des id différentes alors qu'elles 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 d'événement verrouillée dans laquelle aucune modification ne peut être apportée aux champs d'événement principaux "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é par une entrée distincte dans attendees avec le champ organizer défini sur "True". Pour changer d'organisateur, utilisez l'opération move. Lecture seule, sauf lors de l'importation d'un événement. accessible en écriture
organizer.displayName string Nom de l'organisateur, 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 dans lequel cette copie de l'événement apparaît. 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, en fonction des données de récurrence de l'événement périodique identifié par "recurrentEventId". Il identifie de manière unique l'instance au sein de la série d'événements récurrents, même si l'instance a été déplacée vers une autre heure. 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 forme de valeur de date et d'heure combinée (dans le format 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. (au format de 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 indique le fuseau horaire dans lequel la récurrence est étendue. Pour les événements individuels, 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énements d'absence du bureau. Utilisé si eventType est défini sur outOfOffice. accessible en écriture
outOfOfficeProperties.autoDeclineMode string Permet de refuser ou non les invitations à des réunions qui se chevauchent à des événements d'absence du bureau. Les valeurs valides sont declineNone (aucune invitation à une réunion n'est refusée), declineAllConflictingInvitations (toutes les invitations à des réunions en conflit qui entrent en conflit avec l'événement) sont refusées. declineOnlyNewConflictingInvitations, qui signifie que seules les nouvelles invitations à des réunions en conflit qui arrivent en cas d'absence doivent être refusées.
outOfOfficeProperties.declineMessage string Message de réponse permettant de définir si un événement existant ou une nouvelle invitation est automatiquement refusé par Agenda.
privateCopy boolean Si cette règle est définie sur "True", la propagation des événements est désactivée. Notez que cette option est différente des propriétés d'un événement privé. Facultatif. Immuable. La valeur par défaut est "False" (faux).
recurrence[] list Liste des lignes RRULE, EXRULE, RDATE et EXDATE d'un événement périodique, comme spécifié dans le document RFC5545. Notez que les lignes DTSTART et DTEND ne sont pas autorisées dans ce champ. Les heures de début et de fin des événements sont spécifiées dans les champs start et end. Ce champ est omis pour les événements individuels ou les instances d'événements périodiques. 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 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, les rappels spécifiques à l'événement s'affichent. S'il n'est pas défini, 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. Les valeurs possibles sont:
  • 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 pendant lequel le rappel doit se déclencher. Les valeurs valides sont comprises entre 0 et 40320 (quatre semaines en minutes).

Obligatoire lors de l'ajout d'un rappel.

accessible en écriture
reminders.useDefault boolean Ce paramètre 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 conformément à iCalendar. accessible en écriture
source object Source à partir de laquelle l'événement a été créé. Il peut s'agir, par exemple, d'une page Web, d'un e-mail ou de 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 le titre d'une page Web ou l'objet d'un e-mail. accessible en écriture
source.url string URL de la source pointant vers une ressource. Le schéma d'URL doit être HTTP ou HTTPS. accessible en écriture
start nested object Heure de début (incluse) de l'événement. Pour un événement périodique, il s'agit de l'heure de début de la première occurrence.
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 forme de valeur de date et d'heure combinée (dans le format 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. (au format de 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 indique le fuseau horaire dans lequel la récurrence est étendue. Pour les événements individuels, 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:
  • confirmed : l'événement est confirmé. Il s'agit de l'état par défaut.
  • tentative : l'événement est confirmé provisoirement.
  • "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 selon le type d'événement:

    1. 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 l'événement récurrent parent.

      Si vous annulez une exception, seules les valeurs des champs id, recurringEventId et originalStartTime seront renseigné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 finiront donc par disparaître. Par conséquent, ne comptez pas sur leur disponibilité indéfinie.

      Seule garantie que le champ id sera renseigné pour les événements supprimés.

    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 qu'ils puissent être restaurés (sans suppression). De même, les événements auxquels l'utilisateur a été invité et qu'il a supprimé manuellement continuent de fournir des informations. Toutefois, les demandes de synchronisation incrémentielle dont la valeur showDeleted est définie 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 sur la liste des participants, l'événement est annulé. Dans ce cas, 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 heure dans l'agenda. Facultatif. Les valeurs possibles sont:
  • "opaque" : valeur par défaut. L'événement bloquera des heures dans l'agenda. Cela revient à définir l'option Ma disponibilité sur Occupé dans l'interface utilisateur d'Agenda.
  • "transparent" : l'événement ne bloque aucune heure dans l'agenda. Cela revient à définir l'option Ma disponibilité sur Disponible dans l'interface utilisateur d'Agenda.
accessible en écriture
updated datetime Heure de la dernière modification de l'événement (en tant que code temporel RFC3339). Lecture seule.
visibility string Visibilité de l'événement. Facultatif. Les valeurs possibles sont:
  • "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 tous les lecteurs de l'agenda peuvent voir ses détails.
  • private : l'événement est privé, et seuls les participants peuvent consulter les détails de l'événement.
  • "confidential" : cet événement est privé. Cette valeur est fournie pour des raisons de compatibilité.
accessible en écriture
workingLocationProperties nested object Données d'événement liées au lieu de travail. accessible en écriture
workingLocationProperties.customLocation object S'il est présent, indique que l'utilisateur travaille à partir d'un lieu personnalisé. accessible en écriture
workingLocationProperties.customLocation.label string Une étiquette supplémentaire facultative pour des informations supplémentaires. accessible en écriture
workingLocationProperties.homeOffice any value Si présent, indique que l'utilisateur travaille à domicile. accessible en écriture
workingLocationProperties.officeLocation object S'il est présent, indique que l'utilisateur travaille dans un bureau. accessible en écriture
workingLocationProperties.officeLocation.buildingId string Identifiant de bâtiment facultatif. Ce nom doit faire référence à un ID de bâtiment figurant dans la base de données "Resources" 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 Identifiant facultatif de section d'étage. accessible en écriture
workingLocationProperties.officeLocation.label string Nom du bureau affiché dans les clients Agenda sur le Web et pour mobile. Nous vous recommandons de référencer un nom de 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 à son domicile.
  • "officeLocation" : l'utilisateur travaille dans un bureau.
  • "customLocation" : l'utilisateur travaille à partir d'un lieu personnalisé.
Tous 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 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éthodeevents.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.
insérer
Crée un événement.
instances.
Renvoie les instances de l'événement périodique spécifié.
liste
Renvoie les événements de l'agenda spécifié.
déplacement
Déplace un événement vers un autre agenda (autrement dit, modifie l'organisateur de l'événement). Notez que seuls les événements default peuvent être déplacés. Les événements outOfOffice, focusTime 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 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. S'ils sont spécifiés, les champs de tableau écrasent les tableaux existants. Cette opération supprime tous les éléments de tableau précédents.
quickAdd
Crée un événement sur la base d'une chaîne de texte simple.
mise à jour
Modifie 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 get suivie d'une update à l'aide d'etags pour garantir l'atomicité.
montre
Surveillez les modifications apportées aux ressources "Événements".