CalendarList

Es la 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
    ]
  },
  "autoAcceptInvitations": boolean
}
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. Estos son los posibles valores:
  • "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 los detalles del evento estarán ocultos.
  • "writerWithoutPrivateAccess": Proporciona acceso de lectura y escritura al calendario. Los eventos privados aparecerán para los usuarios con acceso de writerWithoutPrivateAccess, pero los detalles del evento estarán ocultos.
  • "writer": Proporciona acceso de lectura y escritura al calendario. Los eventos privados aparecerán para los usuarios con acceso de escritor, y los detalles del evento estarán visibles.
  • "owner": Proporciona acceso de administrador al calendario. Este rol tiene todos los permisos del rol de escritor con la capacidad adicional de ver y modificar los niveles de acceso de otros usuarios.

autoAcceptInvitations boolean Indica si este calendario acepta automáticamente las invitaciones. Solo es válido para los calendarios de recursos. Solo lectura.
backgroundColor string Es el color principal del calendario en el 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. Es opcional. admite escritura
colorId string Es el 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. Es opcional. admite escritura
conferenceProperties nested object Son las propiedades de las conferencias para este calendario, por ejemplo, qué tipos de conferencias se permiten.
conferenceProperties.allowedConferenceSolutionTypes[] list Son los tipos de soluciones de conferencias que se admiten para este calendario.

Los siguientes son los valores posibles:

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

Es obligatorio cuando se agrega un recordatorio.

 admite escritura
defaultReminders[].minutes integer Es la 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).

Es obligatorio cuando se agrega un recordatorio.

 admite escritura
deleted boolean Indica si esta entrada de la lista de calendarios se borró de la lista de calendarios. Solo lectura. Es opcional. El valor predeterminado es False.
description string Es la descripción del calendario. Es opcional. Solo lectura.
etag etag Es el ETag del recurso.
foregroundColor string Es el color de primer plano del calendario en el 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. Es opcional. admite escritura
hidden boolean Indica si el calendario se ocultó de la lista. Es 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 Es la ubicación geográfica del calendario como texto de formato libre. Es 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 establecidas para este calendario.
notificationSettings.notifications[].method string Es el método que se usa para entregar la notificación. El valor posible es el siguiente:
  • "email": Las notificaciones se envían por correo electrónico.

Es obligatorio cuando se agrega una notificación.

 admite escritura
notificationSettings.notifications[].type string El tipo de notificación. Estos son los posibles valores:
  • "eventCreation": Notificación que se envía cuando se coloca un evento nuevo en el 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 al evento.
  • "agenda": Una agenda con los eventos del día (se envía por la mañana).

Es obligatorio cuando se agrega una notificación.

 admite escritura
primary boolean Indica si el calendario es el calendario principal del usuario autenticado. Solo lectura. Es opcional. El valor predeterminado es False.
selected boolean Indica si el contenido del calendario aparece en la IU del calendario. Es 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. Es opcional. admite escritura
timeZone string Es la zona horaria del calendario. Es 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 en 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. Esto descarta cualquier elemento de array anterior.
actualizaciones
Actualiza un calendario existente en la lista de calendarios del usuario.
Mira
Supervisa los cambios en los recursos de CalendarList.