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

CalendarList

Collection d'agendas figurant dans la liste d'agendas de l'utilisateur. Consultez également Agendas et 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,
  "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 de l'utilisateur authentifié à l'agenda. Lecture seule. Les valeurs possibles sont: "`freeBusyReader`" : fournit un accès en lecture aux informations de disponibilité. "`reader`" : fournit un accès en lecture à l'agenda. Les événements privés seront visibles par les utilisateurs disposant d'un accès en lecture, mais les détails les concernant seront masqués. "`writer`" : fournit un accès en lecture et en écriture à l'agenda. Les événements privés seront visibles par les utilisateurs autorisés à écrire, et les détails les concernant seront visibles. "`owner`" : indique la propriété de l'agenda. Ce rôle dispose de toutes les autorisations du rôle de rédacteur, mais il peut également afficher et manipuler les LCA.
`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
`conferenceProperties`	`nested object`	Propriétés de conférence de cet agenda, par exemple les types de conférences autorisés.
`conferenceProperties.allowedConferenceSolutionTypes[]`	`list`	Types de solutions de conférence compatibles avec cet agenda. Les valeurs possibles sont : `"eventHangout"` `"eventNamedHangout"` `"hangoutsMeet"` (Facultatif)
`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: `email` : les rappels sont envoyés par e-mail. `popup` : les rappels sont envoyés via un pop-up dans l'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 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
`deleted`	`boolean`	Indique si cette entrée de la liste des agendas a été supprimée de la liste. 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 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
`hidden`	`boolean`	Indique si l'agenda a été masqué dans la liste. Facultatif. L'attribut n'est renvoyé que lorsque le calendrier 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 du calendrier sous forme de texte libre. Facultatif. Lecture seule.
`notificationSettings`	`object`	Notifications envoyées à l'utilisateur authentifié 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: "`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`" : ordre du jour avec les événements du jour (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`	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
`summary`	`string`	Titre de l'agenda. Lecture seule.
`summaryOverride`	`string`	Résumé défini par l'utilisateur authentifié pour cet agenda. Facultatif.	accessible en écriture
`timeZone`	`string`	Fuseau horaire de l'agenda. Facultatif. Lecture seule.

Méthodes

supprimer: Supprime un agenda de la liste d'agendas de l'utilisateur.
get: Renvoie un agenda à partir de la liste d'agendas de l'utilisateur.
insérer: Insère un agenda existant dans la liste d'agendas de l'utilisateur.
liste: Renvoie les agendas figurant dans la liste d'agendas de l'utilisateur.
patch: Met à jour un agenda existant dans la liste d'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. S'ils sont spécifiés, les champs de tableau écrasent les tableaux existants. Cette opération supprime tous les éléments de tableau précédents.
mise à jour: Met à jour un agenda existant dans la liste d'agendas de l'utilisateur.
montre: Surveillez les modifications apportées aux ressources CalendarList.