CalendarList: patch
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Met à jour un agenda existant dans la liste des agendas de l'utilisateur. Cette méthode est compatible avec la sémantique "patch". Notez que chaque requête de correctif consomme trois unités de quota. Nous vous recommandons 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. Si spécifiés, les champs de tableau écrasent les tableaux existants. Tous les éléments de tableau précédents sont alors supprimés.
Essayez maintenant.
Requête
Requête HTTP
PATCH https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId
Paramè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 ".
|
Paramètres de requête facultatifs |
colorRgbFormat |
boolean |
Indique si les champs foregroundColor et backgroundColor doivent être utilisés pour écrire les couleurs de l'agenda (RVB). Si vous utilisez cette fonctionnalité, le champ colorId basé sur l'index sera automatiquement défini sur la meilleure option de correspondance. Facultatif. La valeur par défaut est "False" (faux).
|
Autorisation
Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants:
Portée |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendarlist |
Pour en savoir plus, consultez la page Authentification et autorisation.
Corps de la requête
Dans le corps de la requête, indiquez les parties pertinentes d'une ressource CalendarList, conformément aux règles de sémantique des correctifs.
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# CalendarList: patch\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates an existing calendar on the user's calendar list. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a `get` followed by an `update`. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPATCH https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `calendarId` | `string` | Calendar identifier. To retrieve calendar IDs call the [calendarList.list](/workspace/calendar/api/v3/reference/calendarList/list) method. If you want to access the primary calendar of the currently logged in user, use the \"`primary`\" keyword. |\n| **Optional query parameters** |||\n| `colorRgbFormat` | `boolean` | Whether to use the `foregroundColor` and `backgroundColor` fields to write the calendar colors (RGB). If this feature is used, the index-based `colorId` field will be set to the best matching option automatically. Optional. The default is False. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|---------------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.app.created` |\n| `https://www.googleapis.com/auth/calendar.calendarlist` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nIn the request body, supply the relevant portions of a [CalendarList resource](/workspace/calendar/api/v3/reference/calendarList#resource), according to the rules of patch semantics.\n\nResponse\n--------\n\nIf successful, this method returns a [CalendarList resource](/workspace/calendar/api/v3/reference/calendarList#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]