Cette page a été traduite par l'API Cloud Translation.

CalendarList: insert

Insère un agenda existant dans la liste des agendas de l'utilisateur. Essayez dès maintenant ou consultez un exemple.

Requête

Requête HTTP

POST https://www.googleapis.com/calendar/v3/users/me/calendarList

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de requête facultatifs
`colorRgbFormat`	`boolean`	Permet d'utiliser ou non les champs `foregroundColor` et `backgroundColor` pour écrire les couleurs de l'agenda (RVB). Si cette fonctionnalité est utilisée, le champ `colorId` basé sur l'index est 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 ayant le champ d'application suivant:

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 obligatoires
`id`	`string`	Identifiant de l'agenda.
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'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 de l'agenda. Cet ID fait 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 les utilisez. Facultatif.	accessible en écriture
`defaultReminders[]`	`list`	Rappels par défaut dont dispose l'utilisateur authentifié pour cet agenda.	accessible en écriture
`defaultReminders[].method`	`string`	Méthode utilisée pour ce rappel. Les valeurs possibles sont: "`email`" - Les rappels sont envoyés par e-mail. "`popup`" - Les rappels sont envoyés via un pop-up d'interface utilisateur. 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 lesquelles le rappel doit se déclencher. 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`	Les 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: "`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: "`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`" - Un ordre du jour avec les événements de la journée (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'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 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

Elle 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();

// Create a new calendar list entry
CalendarListEntry calendarListEntry = new CalendarListEntry();
calendarListEntry.setId("calendarId");

// Insert the new calendar list entry
CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute();

System.out.println(createdCalendarListEntry.getSummary());

Python

Elle utilise la bibliothèque cliente Python.

calendar_list_entry = {
    'id': 'calendarId'
}

created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute()

print created_calendar_list_entry['summary']

PHP

Elle utilise la bibliothèque cliente PHP.

$calendarListEntry = new Google_Service_Calendar_CalendarListEntry();
$calendarListEntry->setId("calendarId");

$createdCalendarListEntry = $service->calendarList->insert($calendarListEntry);

echo $createdCalendarListEntry->getSummary();

Ruby

Elle utilise la bibliothèque cliente Ruby.

entry = Google::Apis::CalendarV3::CalendarListEntry.new(
 id: 'calendarId'
)

result = client.insert_calendar_list(entry)
print result.summary

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.