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

CalendarList

Collection d'agendas figurant dans la liste des agendas de l'utilisateur. Consultez également la section 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 dont dispose l'utilisateur authentifié sur l'agenda. En 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 des événements seront masqués. "`writer`" - Fournit un accès en lecture et en écriture à l'agenda. Les utilisateurs ayant un accès en écriture pourront voir les événements privés, et les détails des événements seront visibles. "`owner`" - Fournit la propriété de l'agenda. Il dispose de toutes les autorisations du rôle de rédacteur, ainsi que de la possibilité supplémentaire de voir et de 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 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
`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 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
`deleted`	`boolean`	Indique si cette entrée de la liste des agendas a été supprimée de la liste des agendas. En lecture seule. Facultatif. La valeur par défaut est "False" (faux).
`description`	`string`	Description de l'agenda. Facultatif. En 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 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 au format libre Facultatif. En lecture seule.
`notificationSettings`	`object`	Les 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: "`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
`primary`	`boolean`	Indique si l'agenda est l'agenda principal de l'utilisateur authentifié. En 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. En 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. En lecture seule.

Méthodes

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