Se usó la API de Cloud Translation para traducir esta página.

CalendarList

La colección de calendarios en la lista de calendarios del usuario. Consulta también Comparación entre Calendarios y CalendarList.

Para ver una lista de métodos para este recurso, consulta el final de esta página.

Representaciones de recursos

{
  "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
    ]
  }
}

Nombre de la propiedad	Valor	Descripción	Notas
`accessRole`	`string`	El rol de acceso efectivo que tiene el usuario autenticado en el calendario. Solo lectura. Los valores posibles son: "`freeBusyReader`": Proporciona acceso de lectura a la información de disponible/ocupado. "`reader`": Proporciona acceso de lectura al calendario. Los eventos privados se mostrarán a los usuarios con acceso de lectura, pero se ocultarán los detalles de los eventos. "`writer`": Proporciona acceso de lectura y escritura al calendario. Los eventos privados serán visibles para los usuarios con acceso de escritor y los detalles del evento serán visibles. "`owner`": Proporciona la propiedad del calendario. Este rol cuenta con todos los permisos del rol de escritor, además de la capacidad adicional de ver y manipular las LCA.
`backgroundColor`	`string`	Es el color principal del calendario en formato hexadecimal "`#0088aa`". Esta propiedad sustituye a la propiedad `colorId` basada en índices. Para establecer o cambiar esta propiedad, debes especificar `colorRgbFormat=true` en los parámetros de los métodos insert, update y patch. Opcional.	admite escritura
`colorId`	`string`	El color del calendario. Este es un ID que hace referencia a una entrada en la sección `calendar` de la definición de colores (consulta el extremo de colores). Esta propiedad se sustituye por las propiedades `backgroundColor` y `foregroundColor`, y se puede ignorar cuando se usan estas propiedades. Opcional.	admite escritura
`conferenceProperties`	`nested object`	Propiedades de conferencias para este calendario, por ejemplo, qué tipos de conferencias están permitidas
`conferenceProperties.allowedConferenceSolutionTypes[]`	`list`	Los tipos de soluciones de conferencia compatibles con este calendario. Los siguientes son los valores posibles: `"eventHangout"` `"eventNamedHangout"` `"hangoutsMeet"` Opcional.
`defaultReminders[]`	`list`	Los recordatorios predeterminados que tiene el usuario autenticado sobre este calendario.	admite escritura
`defaultReminders[].method`	`string`	Es el método que usa este recordatorio. Los valores posibles son: "`email`": Los recordatorios se envían por correo electrónico. "`popup`": Los recordatorios se envían a través de una ventana emergente de la IU. Obligatorio al agregar un recordatorio.	admite escritura
`defaultReminders[].minutes`	`integer`	Cantidad de minutos antes del inicio del evento en los que se debe activar el recordatorio. Los valores válidos se encuentran entre 0 y 40,320 (4 semanas en minutos). Obligatorio al agregar un recordatorio.	admite escritura
`deleted`	`boolean`	Indica si esta entrada de la lista de calendarios se eliminó de la lista. Solo lectura. Opcional. El valor predeterminado es False.
`description`	`string`	Es la descripción del calendario. Opcional. Solo lectura.
`etag`	`etag`	ETag del recurso.
`foregroundColor`	`string`	El color de primer plano del calendario en formato hexadecimal "`#ffffff`". Esta propiedad sustituye a la propiedad `colorId` basada en índices. Para establecer o cambiar esta propiedad, debes especificar `colorRgbFormat=true` en los parámetros de los métodos insert, update y patch. Opcional.	admite escritura
`hidden`	`boolean`	Indica si el calendario se ocultó en la lista. Opcional. El atributo solo se muestra cuando el calendario está oculto, en cuyo caso el valor es `true`.	admite escritura
`id`	`string`	Es el identificador del calendario.
`kind`	`string`	Es el tipo de recurso ("calendar#calendarListEntry").
`location`	`string`	Ubicación geográfica del calendario como texto sin formato. Opcional. Solo lectura.
`notificationSettings`	`object`	Las notificaciones que el usuario autenticado recibe para este calendario.	admite escritura
`notificationSettings.notifications[]`	`list`	Es la lista de notificaciones configuradas para este calendario.
`notificationSettings.notifications[].method`	`string`	Es el método que se usa para enviar la notificación. El valor posible es: "`email`": Las notificaciones se envían por correo electrónico. Obligatorio cuando se agrega una notificación.	admite escritura
`notificationSettings.notifications[].type`	`string`	El tipo de notificación. Los valores posibles son: "`eventCreation`": Se envía una notificación cuando se agrega un nuevo evento al calendario. "`eventChange`": Se envía una notificación cuando se cambia un evento. "`eventCancellation`": Se envía una notificación cuando se cancela un evento. "`eventResponse`": Se envía una notificación cuando un asistente responde la invitación al evento. "`agenda`": Es una agenda con los eventos del día (que se envía en la mañana). Obligatorio cuando se agrega una notificación.	admite escritura
`primary`	`boolean`	Indica si el calendario es el principal del usuario autenticado. Solo lectura. Opcional. El valor predeterminado es False.
`selected`	`boolean`	Si el contenido de calendario aparece en la IU de calendario. Opcional. El valor predeterminado es False.	admite escritura
`summary`	`string`	Es el título del calendario. Solo lectura.
`summaryOverride`	`string`	Resumen que el usuario autenticado estableció para este calendario. Opcional.	admite escritura
`timeZone`	`string`	La zona horaria del calendario. Opcional. Solo lectura.

Métodos

borrar: Quita un calendario de la lista de calendarios del usuario.
get: Muestra un calendario de la lista de calendarios del usuario.
insertar: Inserta un calendario existente en la lista de calendarios del usuario.
list: Muestra los calendarios de la lista de calendarios del usuario.
patch: Actualiza un calendario existente en la lista de calendarios del usuario. Este método es compatible con la semántica de parches. Ten en cuenta que cada solicitud de parche consume tres unidades de cuota. Es preferible usar get seguido de update. Los valores de campo que especifiques reemplazarán los valores existentes. Los campos que no especifiques en la solicitud no se modificarán. Los campos de array, si se especifican, reemplazan los arrays existentes. Esto descarta cualquier elemento de array anterior.
actualizar: Actualiza un calendario existente en la lista de calendarios del usuario.
reloj: Presta atención a los cambios en los recursos de CalendarList.