Met à jour les métadonnées d'un agenda. Essayer maintenant
Requête
Requête HTTP
PUT https://www.googleapis.com/calendar/v3/calendars/calendarIdParamètres
| Nom du paramètre | Valeur | Description |
|---|---|---|
| Paramètres de chemin d'accès | ||
calendarId |
string |
Identifiant de l'agenda. Pour récupérer les ID d'agenda, appelez la méthode calendarList.list. Si vous souhaitez accéder à l'agenda principal de l'utilisateur actuellement connecté, utilisez le mot clé "primary".
|
Autorisation
Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants :
| Champ d'application |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendars |
Pour en savoir plus, consultez la page Authentification et autorisation.
Corps de la requête
Dans le corps de la requête, fournissez une ressource Calendars avec les propriétés suivantes :
| Nom de propriété | Valeur | Description | Remarques |
|---|---|---|---|
| Propriétés facultatives | |||
description |
string |
Description de l'agenda. Facultatif. | accessible en écriture |
labelProperties |
nested object |
Propriétés de libellé définies dans cet agenda. Si cette option est spécifiée, elle écrase les propriétés d'étiquette existantes. Si aucune valeur n'est spécifiée, les propriétés du libellé restent inchangées. | accessible en écriture |
labelProperties.eventLabels[] |
list |
Libellés d'événement définis dans cet agenda. Si ce champ est présent lors de la mise à jour de l'agenda, il remplace les libellés d'événement existants. Développez la liste pour ajouter un libellé d'événement, et supprimez des entités de la liste pour supprimer un libellé de l'agenda. Chaque agenda peut comporter jusqu'à 200 libellés. |
accessible en écriture |
labelProperties.eventLabels[].backgroundColor |
string |
Couleur d'arrière-plan du libellé au format hexadécimal, par exemple "#039be5". Les événements associés à ce libellé s'affichent dans cette couleur. Obligatoire. |
accessible en écriture |
labelProperties.eventLabels[].id |
string |
ID du libellé. Facultatif lors de l'insertion d'un nouveau libellé. Si aucun ID n'est fourni, un ID unique sera généré. Obligatoire lors de la mise à jour d'un libellé. S'il est fourni, l'ID doit être unique dans l'agenda et respecter le format UUID. |
accessible en écriture |
labelProperties.eventLabels[].name |
string |
Nom du libellé Facultatif. Si vous en fournissez un, il ne doit pas dépasser 50 caractères. |
accessible en écriture |
location |
string |
Emplacement géographique de l'agenda sous forme de texte libre. Facultatif. | accessible en écriture |
summary |
string |
Titre de l'agenda. | accessible en écriture |
timeZone |
string |
Fuseau horaire de l'agenda. (au format d'un nom de la base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich"). Facultatif. | accessible en écriture |
workingHours |
object |
Représente les informations sur les heures de travail de l'utilisateur. Disponible uniquement pour les agendas principaux des utilisateurs Google Workspace. Pour mettre à jour les heures de travail, l'intégralité de l'objet "working hours" doit être transmise. Si aucune valeur n'est spécifiée (ou si la valeur est nulle ou un objet vide), les horaires de travail existants restent inchangés. Pour désactiver les horaires de travail ou effacer le planning, définissez workingHoursEnabled sur "false" (et omettez availableTimes ou transmettez une liste vide). |
accessible en écriture |
workingHours.availableTimes[] |
list |
Heures de travail. Chaque période de disponibilité représente le bloc d'heures de travail de l'utilisateur au cours d'une journée. | accessible en écriture |
workingHours.availableTimes[].dayOfWeek |
string |
Jour de la semaine. Obligatoire. Les valeurs possibles sont les suivantes :
|
accessible en écriture |
workingHours.availableTimes[].periodEnd |
integer |
Fin de la période, en minutes à partir du début de la journée, non inclus. Obligatoire. | accessible en écriture |
workingHours.availableTimes[].periodStart |
integer |
Début de la période, en minutes à partir du début de la journée (inclus). Obligatoire. | accessible en écriture |
workingHours.workingHoursEnabled |
boolean |
Indique si les heures de travail sont activées pour cet agenda. Ne peut pas être défini sur "true" lorsque availableTimes est vide. |
accessible en écriture |
Réponse
Si la requête aboutit, cette méthode renvoie une ressource Calendars dans le corps de la réponse.
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.