Met à jour un agenda existant dans la liste d'agendas de l'utilisateur. Essayez maintenant ou consultez un exemple.
Requête
Requête HTTP
PUT 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 s'il faut utiliser les champs foregroundColor et backgroundColor pour écrire les couleurs du calendrier (RVB). Si vous utilisez cette fonctionnalité, le champ colorId basé sur l'index sera automatiquement défini sur l'option de correspondance la plus pertinente. Facultatif. La valeur par défaut est "False" (faux).
|
Autorisation
Cette requête nécessite une autorisation ayant le champ d'application suivant:
Définition du champ d'application |
---|
https://www.googleapis.com/auth/calendar |
Pour en savoir plus, consultez la page Authentification et autorisation.
Corps de la requête
Dans le corps de la requête, indiquez une ressource CalendarList avec les propriétés suivantes:
Nom de propriété | Valeur | Description | Remarques |
---|---|---|---|
Propriétés facultatives | |||
backgroundColor |
string |
Couleur principale de l'agenda au format hexadécimal "#0088aa ". Cette propriété remplace la propriété colorId basée sur les index. Pour définir ou modifier cette propriété, vous devez spécifier colorRgbFormat=true dans les paramètres des méthodes insert, update et patch. Facultatif. |
accessible en écriture |
colorId |
string |
Couleur du calendrier. Cet ID fait référence à une entrée de la section calendar de la définition des couleurs (voir le point de terminaison des couleurs). Cette propriété est remplacée par les propriétés backgroundColor et foregroundColor et peut être ignorée lors de l'utilisation de ces propriétés. Facultatif. |
accessible en écriture |
defaultReminders[] |
list |
Rappels par défaut envoyés à l'utilisateur authentifié pour cet agenda. | accessible en écriture |
defaultReminders[].method |
string |
Méthode utilisée par ce rappel. Les valeurs possibles sont:
Obligatoire lors de l'ajout d'un rappel. |
accessible en écriture |
defaultReminders[].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 |
foregroundColor |
string |
Couleur de premier plan de l'agenda au format hexadécimal "#ffffff ". Cette propriété remplace la propriété colorId basée sur un index. Pour définir ou modifier cette propriété, vous devez spécifier colorRgbFormat=true dans les paramètres des méthodes insert, update et patch. Facultatif. |
accessible en écriture |
notificationSettings |
object |
Notifications envoyées à l'utilisateur authentifié pour cet agenda. | accessible en écriture |
notificationSettings.notifications[].method |
string |
Méthode utilisée pour envoyer la notification. La valeur possible est:
Obligatoire lors de l'ajout d'une notification. |
accessible en écriture |
notificationSettings.notifications[].type |
string |
Type de notification. Les valeurs possibles sont:
Obligatoire lors de l'ajout d'une notification. |
accessible en écriture |
selected |
boolean |
Ce paramètre indique si le contenu de l'agenda s'affiche dans l'interface utilisateur de l'agenda. Facultatif. La valeur par défaut est "False" (faux). | accessible en écriture |
summaryOverride |
string |
Résumé défini par l'utilisateur authentifié pour cet agenda. Facultatif. | accessible en écriture |
Réponse
Lorsque cette méthode fonctionne, elle renvoie une ressource CalendarList dans le corps de la réponse.
Exemples
Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).
Java
Utilise la bibliothèque cliente Java.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.CalendarListEntry; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Retrieve the calendar list entry CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute(); // Make a change calendarListEntry.setColorId("newColorId"); // Update the altered entry CalendarListEntry updatedCalendarListEntry = service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute(); System.out.println(updatedCalendarListEntry.getEtag());
Python
Utilise la bibliothèque cliente Python.
# First retrieve the calendarListEntry from the API. calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute() calendar_list_entry['colorId'] = 'newColorId' updated_calendar_list_entry = service.calendarList().update( calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute() print created_calendar_list_entry['etag']
PHP
Utilise la bibliothèque cliente PHP.
// First retrieve the calendarListEntry from the API. $calendarListEntry = $service->calendarList->get('calendarId'); $calendarListEntry->setColorId('newColorId'); $updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry); echo $updatedCalendarListEntry->getEtag();
Ruby
Utilise la bibliothèque cliente Ruby.
calendar_list_entry = client.get_calendar_list('calendarId') calendar_list_entry.colorId = 'newColorId' result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry) print result.etag
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.