L'API Calendar propose 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 | Notes |
---|---|---|---|
anyoneCanAddSelf |
boolean |
Indique si une personne peut s'inviter à l'événement (obsolète). Facultatif. La valeur par défaut est "False" (faux). | accessible en écriture |
attachments[] |
list |
Pièces jointes de l'événement. Pour modifier des pièces jointes, le paramètre de requête Il peut y avoir au maximum 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 |
|
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é Obligatoire lors de l'ajout d'une pièce jointe. |
accessible en écriture |
attachments[].iconLink |
string |
Lien URL vers l'icône de la pièce jointe. Ce champ ne peut être modifié que pour les pièces jointes tierces personnalisées. | |
attachments[].mimeType |
string |
Type de média Internet (type MIME) de la pièce jointe | |
attachments[].title |
string |
Titre de la pièce jointe | |
attendeesOmitted |
boolean |
Indique si des participants ont é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 Consultez le guide Événements avec des participants pour savoir comment planifier des événements avec d'autres utilisateurs d'agenda. Les comptes de service doivent utiliser la délégation 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 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 pour 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. Ce paramètre 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:
|
accessible en écriture |
attendees[].self |
boolean |
Indique si cette entrée représente l'agenda sur 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, 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é par les développeurs pour suivre les conférences et ne doit pas être affiché aux utilisateurs. La valeur de l'ID se présente différemment pour chaque type de solution de conférence:
|
|
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é. Veuillez renseigner |
|
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 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, cela devrait interdire les modifications. Les valeurs possibles sont :
|
|
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 . Veuillez renseigner |
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
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 pouvoir afficher les points d'entrée. Toutefois, cela devrait interdire les modifications. Les valeurs possibles sont :
|
|
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, celle-ci 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 :
|
|
conferenceData.entryPoints[] |
list |
Informations sur les points d'entrée à la conférence (URL ou numéros de téléphone, par exemple). Tous doivent appartenir à la même conférence. Veuillez renseigner |
|
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, renseignez uniquement le sous-ensemble des champs { Facultatif. |
|
conferenceData.entryPoints[].entryPointType |
string |
Type de point d'entrée de la conférence. Les valeurs possibles sont :
|
|
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 :
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, renseignez uniquement le sous-ensemble des champs { Facultatif. |
|
conferenceData.entryPoints[].passcode |
string |
Code secret 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, renseignez uniquement le sous-ensemble des champs { |
|
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, renseignez uniquement le sous-ensemble des champs { 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, renseignez uniquement le sous-ensemble des champs { Facultatif. |
|
conferenceData.entryPoints[].uri |
string |
URI du point d'entrée. La longueur maximale est de 1 300 caractères. Format:
|
|
conferenceData.notes |
string |
Remarques supplémentaires (telles que des instructions de l'administrateur du domaine, des mentions légales) à présenter à l'utilisateur. Peut contenir du code HTML. Il 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éfini pour une conférence 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 |
Le 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, le cas échéant | |
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 combinée date/heure (formatée conformément au 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. (sous la forme d'un nom de base de données des fuseaux horaires 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 développée. 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:
|
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 affiché dans 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. | |
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 chevauchant des événements "Moment de concentration". Les valeurs valides sont declineNone (aucune invitation à une réunion n'est refusée), declineAllConflictingInvitations (toutes les invitations en conflit qui entrent en conflit avec l'événement) sont refusées, et declineOnlyNewConflictingInvitations signifie que seules les nouvelles invitations en conflit qui arrivent alors que l'événement "Moment de concentration" est présent doivent être refusées. |
|
focusTimeProperties.chatStatus |
string |
État à indiquer 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 à indiquer si un événement existant ou une nouvelle invitation est automatiquement refusé par Agenda. | |
gadget |
object |
Gadget étendant cet événement. Les gadgets sont obsolètes. Cette structure est uniquement utilisée pour renvoyer les métadonnées de l'agenda des anniversaires. | |
gadget.display |
string |
Mode d'affichage du gadget Obsolète. Les valeurs possibles sont:
|
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.iconLink |
string |
URL de l'icône du gadget. Le schéma d'URL doit être HTTPS. Obsolète. | accessible en écriture |
gadget.link |
string |
URL du gadget. Le schéma d'URL doit être HTTPS. Obsolète. | accessible en écriture |
gadget.preferences |
object |
Préférences. | accessible en écriture |
gadget.preferences.(key) |
string |
Nom de la préférence et valeur correspondante. | |
gadget.title |
string |
Titre du gadget Obsolète. | accessible en écriture |
gadget.type |
string |
Type du gadget. Obsolète. | accessible en écriture |
gadget.width |
integer |
Largeur du gadget en pixels La largeur doit être un nombre entier supérieur à 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 |
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 |
hangoutLink |
string |
Lien absolu vers le Hangout Google associé à cet événement. Lecture seule. | |
htmlLink |
string |
Lien absolu vers cet événement dans l'interface utilisateur Web de Google Agenda. Lecture seule. | |
iCalUID |
string |
Identifiant unique d'événement, tel que défini dans la norme RFC5545. Il permet d'identifier de manière unique les événements de tous les systèmes d'agenda et doit être fourni lors de l'importation des événements via la méthode import. Notez que |
|
id |
string |
Identifiant opaque de l'événement. Lorsque vous créez des événements uniques ou périodiques, vous pouvez spécifier leur ID. Les ID fournis doivent respecter les règles suivantes:
Si vous ne spécifiez pas d'ID, il sera automatiquement généré par le serveur. Notez que |
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 de l'événement verrouillé où 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 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 |
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 récurrent identifié par "récurrentEventId". 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 combinée date/heure (formatée conformément au 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. (sous la forme d'un nom de base de données des fuseaux horaires 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 développée. 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 ou non les invitations à des réunions se chevauchant lors des absences du bureau. Les valeurs valides sont declineNone (aucune invitation à une réunion n'est refusée), declineAllConflictingInvitations signifie que toutes les invitations en conflit en conflit avec l'événement sont refusées ; et declineOnlyNewConflictingInvitations , ce qui signifie que seules les nouvelles invitations à des réunions en conflit qui arrivent alors que l'événement "Absent du bureau" est présent doivent être refusées. |
|
outOfOfficeProperties.declineMessage |
string |
Message de réponse à indiquer 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 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 d'un événement récurrent, 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 ponctuels ou récurrents. |
accessible en écriture |
recurringEventId |
string |
Pour une instance d'événement périodique, il s'agit de l'id de l'événement périodique auquel cette occurrence 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 sont listés. S'ils ne sont pas définis, aucun rappel n'est défini pour cet événement. Le nombre maximal de rappels de remplacement est de 5. | accessible en écriture |
reminders.overrides[].method |
string |
Méthode utilisée par ce rappel. Les valeurs possibles sont:
Obligatoire pour 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 40 320 (quatre semaines en minutes). Obligatoire pour 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éé. Il peut s'agir, par exemple, d'une page Web, d'un e-mail ou de tout document identifiable par une URL utilisant un schéma HTTP ou HTTPS. Seul le créateur de l'événement peut les voir ou les modifier. | |
source.title |
string |
Titre de la source ; par exemple, le titre d'une page Web ou l'objet d'un e-mail. | accessible en écriture |
source.url |
string |
URL de la source pointant vers une ressource. Le schéma d'URL doit être HTTP ou HTTPS. | accessible en écriture |
start |
nested object |
Heure de début (incluse) de l'événement. Pour un événement 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 combinée date/heure (formatée conformément au 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. (sous la forme d'un nom de base de données des fuseaux horaires 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 développée. 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:
|
accessible en écriture |
summary |
string |
Titre de l'événement. | accessible en écriture |
transparency |
string |
Indique si l'événement bloque un moment dans l'agenda. Facultatif. Les valeurs possibles sont:
|
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:
|
accessible en écriture |
workingLocationProperties |
nested object |
Données d'événement liées au lieu de travail. | accessible en écriture |
workingLocationProperties.customLocation |
object |
Si ce champ est présent, indique que l'utilisateur travaille depuis un lieu personnalisé. | accessible en écriture |
workingLocationProperties.customLocation.label |
string |
Libellé supplémentaire facultatif contenant des informations supplémentaires. | accessible en écriture |
workingLocationProperties.homeOffice |
any value |
Si ce champ est présent, indique que l'utilisateur est en télétravail. | 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. Celui-ci doit faire référence à un ID de bâtiment dans la base de données de 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 sur le Web et sur mobile. 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:
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'
eventType
correspond àdefault
peuvent être importés.Comportement obsolète:si un événement autre que
default
est importé, son type sera remplacé pardefault
et toutes ses propriétés spécifiques au type d'événement seront ignoré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 ou change l'organisateur de l'événement. Notez que seuls les événements
default
peuvent être déplacés ; les événementsoutOfOffice
,focusTime
,workingLocation
etfromGmail
ne peuvent pas être déplacés. - 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'unupdate
. 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. Tous les éléments précédents du tableau sont alors supprimés. - quickAdd
- Crée un événement en fonction 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, effectuez une
get
suivie d'uneupdate
à l'aide d'etags pour garantir l'atomicité. - montre
- Surveillez les modifications apportées aux ressources Événements.