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
    }
  ],
  "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 Pièces jointes à l'événement

Pour modifier les pièces jointes, le paramètre de requête supportsAttachments doit être défini sur true.

Le nombre maximal de pièces jointes par événement est de 25.
attachments[].fileId string ID du fichier joint. En 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 l'URL de 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 support 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 dans la représentation de l'événement. Une restriction spécifiée par le paramètre de requête maxAttendee peut s'expliquer par la récupération d'un événement. 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 d'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 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 du 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. En lecture seule. La valeur par défaut est "False" (faux).
attendees[].resource boolean Indique si le participant est une ressource. Ne peut être défini que lorsque le participant est ajouté à l'événement pour la première fois. Les modifications ultérieures sont ignorées. Facultatif. La valeur par défaut est "False" (faux). accessible en écriture
attendees[].responseStatus string État de la réponse du participant. 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é 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. En 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 liées à 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 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ée par les développeurs pour suivre les conférences, ne doit pas être affichée pour 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 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 La solution de conférence, telle que 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 devrait toujours être en mesure d'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 de Google Workspace (obsolète ; les événements existants peuvent afficher ce type de solution de conférence, mais il est impossible d'en créer d'autres)
  • "hangoutsMeet" pour Google Meet (http://meet.google.com)
  • "addOn" pour les fournisseurs de services de conférence tiers

conferenceData.conferenceSolution.name string Nom de la solution visible par l'utilisateur. 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 des données sont présentes, vérifiez le champ status.

Vous devez renseigner conferenceSolution et au moins un élément entryPoint, ou createRequest.
conferenceData.createRequest.conferenceSolutionKey nested object La solution de conférence, telle que Hangouts ou Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Type de solution de conférence.

Si un client rencontre un type inconnu ou vide, il devrait toujours être en mesure d'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 de Google Workspace (obsolète ; les événements existants peuvent afficher ce type de solution de conférence, mais il est impossible d'en créer d'autres)
  • "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 à 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. En 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 réussi. 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 les points d'entrée d'une conférence, tels que les URL ou les 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} 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 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, un 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 complémentaires pour participer à une conférence (numéros de téléphone supplémentaires, par exemple) Une conférence peut avoir zéro ou un point d'entrée more. Une conférence avec seulement un 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é. La longueur maximale est de 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 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} 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 Code secret permettant d'accéder à la conférence. La longueur maximale est de 128 caractères.

Lorsque vous créez des données de conférence, renseignez uniquement le sous-ensemble des 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 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} 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. 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} 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. La longueur maximale est de 1 300 caractères.

Format:

  • pour le schéma video, http: ou https: est requis.
  • Pour phone, un schéma tel: est requis. L'URI doit inclure la séquence d'appels complète (par exemple, +12345678900,,123456789;1234).
  • Pour sip, un schéma sip: est requis (par exemple, sip:12345678@monfournisseur.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.) à afficher à l'utilisateur Peut contenir du code HTML. La longueur maximale est de 2 048 caractères. Facultatif.
conferenceData.signature string Signature des données de la conférence.

Généré côté serveur.

Non défini pour une conférence dont la demande de création a échoué.

Facultatif pour les conférences avec une demande de création en attente.
created datetime Heure de création de l'événement (sous forme d'horodatage RFC3339). En lecture seule.
creator object Créateur de l'événement En 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. En 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 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 la forme d'une valeur combinée de date et heure (formatée conformément à la norme 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. (présenté sous la forme d'un nom de base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich".) Pour les événements périodiques, ce champ est obligatoire. Il spécifie 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 non spécifié.
  • "outOfOffice" : absence du bureau.
  • "focusTime" : événement "Moment de concentration".
  • "workingLocation" : un événement lié au lieu de travail.
  • "fromGmail" : un événement ajouté à Gmail. Impossible de créer ce type d'événement.
 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 défini sur focusTime. accessible en écriture
focusTimeProperties.autoDeclineMode string Permet de refuser les invitations à des réunions qui chevauchent des événements "Moment de concentration". 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) et declineOnlyNewConflictingInvitations (sinon, seules les nouvelles invitations en conflit reçues pendant l'événement "Moment de concentration") seront refusées.
focusTimeProperties.chatStatus string État pour marquer l'utilisateur dans Chat et dans 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 étant obsolètes, cette structure sert uniquement à renvoyer les métadonnées de l'agenda des 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 lorsque l'utilisateur clique sur l'événement.
 accessible en écriture
gadget.height integer Hauteur du gadget en pixels. La hauteur doit être un nombre entier supérieur à 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 de 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 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 des 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 d'é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 et doit être fourni lors de l'importation d'événements via la méthode import.

Notez que iCalUID et id ne sont pas identiques. Vous ne devez fournir qu'un seul d'entre eux 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 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 dans l'encodage hexadécimal base32, 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 distribuée à l'échelle mondiale du système, nous ne pouvons pas garantir que des 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. 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.

 accessible en écriture
kind string Type de la ressource ("calendar#event").
location string Emplacement géographique de l'événement (texte au format libre). Facultatif. accessible en écriture
locked boolean Indique s'il s'agit d'une copie d'événement verrouillée où aucune modification ne peut être apportée aux champs d'événement principal "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 sur lequel cette copie de l'événement apparaît. En 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". Elle identifie de manière unique l'instance dans la série d'événements périodiques, même si l'instance a été déplacée à 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 combinée de date et heure (formatée conformément à la norme 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. (présenté sous la forme d'un nom de base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich".) Pour les événements périodiques, ce champ est obligatoire. Il spécifie 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'absence du bureau. Utilisé si eventType est défini sur 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 (aucune invitation à une réunion n'est refusée), declineAllConflictingInvitations (toutes les invitations à des réunions en conflit qui sont en conflit avec l'événement) et declineOnlyNewConflictingInvitations (sinon, seules les nouvelles invitations à des réunions en conflit qui arrivent alors que l'événement "Absent du bureau" est présente seront refusées).
outOfOfficeProperties.declineMessage string Message de réponse à définir si un événement existant ou une nouvelle invitation est automatiquement refusé 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 de la même chose que les propriétés d'événement privé. Facultatif. Immuable. La valeur par défaut est "False" (faux).
recurrence[] list Liste des lignes RRULE, EXRULE, RDATE et EXDATE pour un événement périodique, comme spécifié dans le RFC5545. Notez que les lignes DTSTART et DTEND ne sont pas autorisées dans ce champ. Les heures de début et de fin de l'événement sont spécifiées dans les champs start et end. Ce champ est omis pour les événements ponctuels ou 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é. 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 s'affichent. Si aucun rappel n'est défini, cela indique qu'aucun rappel n'est défini pour cet événement. Vous ne pouvez pas définir plus de cinq rappels. accessible en écriture
reminders.overrides[].method string Méthode utilisée pour 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 lesquelles le rappel doit se déclencher. 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 conformément à 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, 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 la forme d'une valeur combinée de date et heure (formatée conformément à la norme 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. (présenté sous la forme d'un nom de base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich".) Pour les événements périodiques, ce champ est obligatoire. Il spécifie 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é.
  • "cancelled" : l'événement a été annulé (supprimé). La méthode list ne renvoie les événements annulés que lors de la synchronisation incrémentielle (lorsque les champs syncToken ou updatedMin sont spécifiés) ou si l'option showDeleted est définie sur true. La méthode get les renvoie toujours.

    Un état "Annulé" peut représenter 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 conserver ces événements pendant toute la durée de vie de l'événement récurrent parent.

      Les exceptions annulées ne garantissent que les valeurs des champs id, recurringEventId et originalStartTime renseignés. 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 par disparaître. Par conséquent, ne comptez pas sur leur disponibilité indéfiniment.

      Seul le champ id sera 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é manuellement continuent de fournir des informations. Toutefois, les requêtes de synchronisation incrémentielles 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, il laissera un événement annulé où 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 du temps dans l'agenda. Facultatif. Les valeurs possibles sont:
  • "opaque" : valeur par défaut. En revanche, l'événement bloque du temps dans l'agenda. Cela équivaut à définir l'option Ma disponibilité en tant que sur Occupé dans l'interface utilisateur d'Agenda.
  • "transparent" : l'événement ne bloque pas de temps dans l'agenda. Cela revient à définir l'option Ma disponibilité en tant que sur Disponible dans l'interface utilisateur d'Agenda.
 accessible en écriture
updated datetime Heure de la dernière modification des données de l'événement principal (sous forme d'horodatage RFC3339). La mise à jour des rappels d'événement n'a aucune incidence sur ces changements. En lecture seule.
visibility string Visibilité de l'événement. Facultatif. Les valeurs possibles sont:
  • "default" : utilise la visibilité par défaut des événements de 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 les détails de l'événement.
  • "private" : l'événement est privé, et seuls ses participants peuvent en consulter les détails.
  • "confidential" : l'événement est privé. Cette valeur est fournie pour des raisons de compatibilité.
 accessible en écriture
workingLocationProperties nested object Données d'événement sur le lieu de travail. accessible en écriture
workingLocationProperties.customLocation object 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 fournir 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 dans un bureau. accessible en écriture
workingLocationProperties.officeLocation.buildingId string Identifiant facultatif du bâtiment. Celui-ci doit référencer un identifiant de bâtiment dans la base de données "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 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 référencer un nom de bâtiment dans la base de données "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 indiqué, 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é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. 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 sera remplacé par default, et toutes ses propriétés spécifiques au type d'événement seront supprimées.

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éplacer
Déplace un événement vers un autre agenda, c'est-à-dire modifie l'organisateur d'un événement. Notez que seuls les événements default peuvent être déplacés. Les événements outOfOffice, focusTime, workingLocation et fromGmail 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. Utilisez de préférence 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. Les champs de tableau, s'ils sont spécifiés, écrasent les tableaux existants. Les éléments précédents du tableau sont supprimés.
quickAdd
Crée un événement à partir d'une simple chaîne de texte.
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, exécutez une commande get suivie d'une opération update à l'aide d'etags afin de garantir l'atomicité.
montre
Surveillez les modifications apportées aux ressources "Événements".