CalendarList

Colección de calendarios en la lista de calendarios del usuario. Consulta también Calendarios vs. CalendarList.

Para obtener una lista de los métodos de 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,
  "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
    ]
  }
}
Nombre de la propiedad Valor Descripción Notas
accessRole string Es el rol de acceso efectivo que tiene el usuario autenticado en el calendario. Solo lectura. Los valores posibles son los siguientes:
  • "freeBusyReader": Proporciona acceso de lectura a la información de disponibilidad.
  • "reader": Proporciona acceso de lectura al calendario. Los eventos privados aparecerán para los usuarios con acceso de lector, pero se ocultarán los detalles del evento.
  • "writer": Proporciona acceso de lectura y escritura al calendario. Los eventos privados aparecerán para los usuarios con acceso de escritura, y los detalles del evento serán visibles.
  • "owner": Proporciona acceso de administrador al calendario. Este rol tiene todos los permisos del rol de escritor, además de la capacidad de ver y modificar los niveles de acceso de otros usuarios.

backgroundColor string Color principal del calendario en formato hexadecimal "#0088aa". Esta propiedad reemplaza la propiedad colorId basada en el índice. 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 Color del calendario. 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 reemplaza por las propiedades backgroundColor y foregroundColor, y se puede ignorar cuando se usan estas propiedades. Opcional. admite escritura
conferenceProperties nested object Son las propiedades de conferencia de este calendario, por ejemplo, qué tipos de conferencias se permiten.
conferenceProperties.allowedConferenceSolutionTypes[] list Son los tipos de soluciones de conferencia que se admiten para este calendario.

Los siguientes son los valores posibles:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcional.
dataOwner string Es el correo electrónico del propietario del calendario. Solo se establece para los calendarios secundarios. Solo lectura.
defaultReminders[] list Son los recordatorios predeterminados que el usuario autenticado tiene para este calendario. admite escritura
defaultReminders[].method string Es el método que usa este recordatorio. Los valores posibles son los siguientes:
  • "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.

Se requiere cuando se agrega un recordatorio.

 admite escritura
defaultReminders[].minutes integer Cantidad de minutos antes del inicio del evento en que se debe activar el recordatorio. Los valores válidos están entre 0 y 40320 (4 semanas en minutos).

Se requiere cuando se agrega un recordatorio.

 admite escritura
deleted boolean Indica si se borró esta entrada de la lista de calendarios. 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 Color de primer plano del calendario en formato hexadecimal "#ffffff". Esta propiedad reemplaza la propiedad colorId basada en el índice. 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ó de la lista. Opcional. El atributo solo se devuelve 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 del recurso ("calendar#calendarListEntry").
location string Ubicación geográfica del calendario como texto de formato libre. Opcional. Solo lectura.
notificationSettings object Son las notificaciones que recibe el usuario autenticado 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.

Se requiere cuando se agrega una notificación.

 admite escritura
notificationSettings.notifications[].type string El tipo de notificación. Los valores posibles son los siguientes:
  • "eventCreation": Es la notificación que se envía cuando se agrega un evento nuevo al calendario.
  • "eventChange": Notificación que se envía cuando se cambia un evento.
  • "eventCancellation": Notificación que se envía cuando se cancela un evento.
  • "eventResponse": Notificación que se envía cuando un asistente responde a la invitación del evento.
  • "agenda": Es una agenda con los eventos del día (se envía por la mañana).

Se requiere cuando se agrega una notificación.

 admite escritura
primary boolean Indica si el calendario es el calendario principal del usuario autenticado. Solo lectura. Opcional. El valor predeterminado es False.
selected boolean Indica si el contenido del calendario aparece en la IU del calendario. Opcional. El valor predeterminado es False. admite escritura
summary string Es el título del calendario. Solo lectura.
summaryOverride string Es el resumen que el usuario autenticado estableció para este calendario. Opcional. admite escritura
timeZone string Zona horaria del calendario Opcional. Solo lectura.

Métodos

borrar
Quita un calendario de la lista de calendarios del usuario.
get
Devuelve un calendario de la lista de calendarios del usuario.
insertar
Inserta un calendario existente en la lista de calendarios del usuario.
list
Devuelve 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 un get seguido de un update. Los valores de campo que especifiques reemplazarán los valores existentes. Los campos que no especifiques en la solicitud permanecerán sin cambios. Los campos de array, si se especifican, reemplazan los arrays existentes, lo que 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.