CalendarList: update

Met à jour un agenda existant dans la liste des agendas de l'utilisateur. Essayez maintenant ou voir 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 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 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 l'indice. 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 de l'agenda. Il s'agit d'un ID faisant référence à une entrée de la section calendar de la définition des couleurs (voir le point de terminaison "colors"). Cette propriété est remplacée par les propriétés backgroundColor et foregroundColor, et peut être ignorée lorsque vous utilisez ces propriétés. Facultatif. accessible en écriture
defaultReminders[] list Rappels par défaut de l'utilisateur authentifié pour ce calendrier. accessible en écriture
defaultReminders[].method string Méthode utilisée par ce rappel. Les valeurs possibles sont les suivantes:
  • "email" : les rappels sont envoyés par e-mail.
  • "popup" : les rappels sont envoyés via une fenêtre pop-up de l'UI.

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 auquel le rappel doit être déclenché. 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
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 l'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
hidden boolean Indique si l'agenda a été masqué dans la liste. Facultatif. L'attribut n'est renvoyé que lorsque l'agenda est masqué, auquel cas la valeur est true. accessible en écriture
notificationSettings object Notifications que l'utilisateur authentifié reçoit pour cet agenda. accessible en écriture
notificationSettings.notifications[].method string Méthode utilisée pour envoyer la notification. La valeur possible est la suivante:
  • "email" : les notifications sont envoyées par e-mail.

Obligatoire lors de l'ajout d'une notification.

 accessible en écriture
notificationSettings.notifications[].type string Type de notification. Les valeurs possibles sont les suivantes:
  • "eventCreation" : notification envoyée lorsqu'un nouvel événement est ajouté à l'agenda.
  • "eventChange" : notification envoyée lorsqu'un événement est modifié.
  • "eventCancellation" : notification envoyée lorsqu'un événement est annulé.
  • "eventResponse" : notification envoyée lorsqu'un participant répond à l'invitation à l'événement.
  • "agenda" : agenda avec les événements du jour (envoyé le matin).

Obligatoire lors de l'ajout d'une notification.

 accessible en écriture
selected boolean Indique si le contenu de l'agenda s'affiche dans l'UI 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 ce calendrier. Facultatif. accessible en écriture

Réponse

Si la requête aboutit, cette méthode 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.