CalendarList

Ensemble des agendas figurant dans la liste des agendas de l'utilisateur. Voir aussi Calendars vs CalendarList.

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
Nom de propriété Valeur Description Remarques
accessRole string Rôle d'accès effectif dont dispose l'utilisateur authentifié sur l'agenda. Lecture seule. Les valeurs possibles sont les suivantes :
  • "freeBusyReader" : permet d'accéder en lecture seule aux informations sur la disponibilité.
  • "reader" : permet d'accéder à l'agenda en lecture seule. Les événements privés s'affichent pour les utilisateurs ayant accès en lecture, mais leurs détails sont masqués.
  • "writer" : fournit un accès en lecture et en écriture à l'agenda. Les événements privés s'affichent pour les utilisateurs disposant d'un accès en écriture, et les détails des événements sont visibles.
  • "owner" : donne un accès administrateur à l'agenda. Ce rôle dispose de toutes les autorisations du rôle Rédacteur, ainsi que de la possibilité de consulter et de modifier les niveaux d'accès des autres utilisateurs.

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. Il s'agit d'un ID faisant référence à une entrée dans 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 lorsque vous utilisez ces propriétés. Facultatif. accessible en écriture
conferenceProperties nested object Propriétés de visioconférence pour cet agenda, par exemple les types de visioconférences autorisés.
conferenceProperties.allowedConferenceSolutionTypes[] list Types de solutions de visioconférence compatibles avec cet agenda.

Les valeurs possibles sont :

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
 Facultatif.
dataOwner string Adresse e-mail du propriétaire de l'agenda. Défini uniquement pour les agendas secondaires. Lecture seule.
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 un pop-up de l'UI.

Obligatoire lorsque vous ajoutez un rappel.

 accessible en écriture
defaultReminders[].minutes integer Nombre de minutes avant le début de l'événement où le rappel doit être déclenché. Les valeurs valides sont comprises entre 0 et 40 320 (4 semaines en minutes).

Obligatoire lorsque vous ajoutez un rappel.

 accessible en écriture
deleted boolean Indique si cette entrée de liste d'agendas a été supprimée de la liste d'agendas. Lecture seule. Facultatif. La valeur par défaut est "False" (faux).
description string Description de l'agenda. Facultatif. Lecture seule.
etag etag ETag de la ressource.
foregroundColor string Couleur de premier plan du calendrier 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
id string Identifiant de l'agenda.
kind string Type de la ressource ("calendar#calendarListEntry").
location string Emplacement géographique de l'agenda sous forme de texte libre. Facultatif. Lecture seule.
notificationSettings object Notifications que l'utilisateur authentifié reçoit pour cet agenda. accessible en écriture
notificationSettings.notifications[] list Liste des notifications définies pour cet agenda.
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" : un agenda avec les événements de la journée (envoyé le matin).

Obligatoire lors de l'ajout d'une notification.

 accessible en écriture
primary boolean Indique si l'agenda est l'agenda principal de l'utilisateur authentifié. Lecture seule. Facultatif. La valeur par défaut est "False" (faux).
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
summary string Titre de l'agenda. Lecture seule.
summaryOverride string Récapitulatif défini par l'utilisateur authentifié pour ce calendrier. Facultatif. accessible en écriture
timeZone string Fuseau horaire de l'agenda. Facultatif. Lecture seule.

Méthodes

supprimer
Supprime un agenda de la liste des agendas de l'utilisateur.
get
Renvoie un agenda de la liste d'agendas de l'utilisateur.
insérer
Insère un agenda existant dans la liste des agendas de l'utilisateur.
liste
Renvoie les agendas de la liste d'agendas de l'utilisateur.
patch
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 PATCH consomme trois unités de quota. Il est préférable 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 des champs de tableau sont spécifiés, ils écrasent les tableaux existants, ce qui supprime tous les éléments de tableau précédents.
update
Met à jour un agenda existant dans la liste des agendas de l'utilisateur.
regarder
Surveillez les modifications apportées aux ressources CalendarList.