Calendars

Es una colección de todos los calendarios existentes. Consulta también Calendars 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#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean
}
Nombre de la propiedad Valor Descripción Notas
autoAcceptInvitations boolean Indica si este calendario acepta automáticamente las invitaciones. Solo es válido para los calendarios de recursos.
conferenceProperties nested object Propiedades de las conferencias de este calendario, por ejemplo, qué tipos de conferencias se permiten.
conferenceProperties.allowedConferenceSolutionTypes[] list Los tipos de soluciones de conferencias que se admiten para este calendario.

Los siguientes son los valores posibles:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcional.
dataOwner string El correo electrónico del propietario del calendario. Solo se establece para los calendarios secundarios. Solo lectura.
description string Descripción del calendario. Opcional. admite escritura
etag etag ETag del recurso.
id string Identificador del calendario. Para recuperar IDs, llama al método calendarList.list().
kind string Tipo de recurso ("calendar#calendar").
labelProperties nested object Propiedades de las etiquetas definidas en este calendario. Si se especifica, reemplaza las propiedades de las etiquetas existentes. Si no se especifica, las propiedades de las etiquetas no cambian. admite escritura
labelProperties.eventLabels[] list Etiquetas de eventos definidas en este calendario. Si está presente cuando se actualiza el calendario, reemplazará las etiquetas de eventos existentes.

Extiende la lista para agregar una etiqueta de evento nueva y quita entidades de la lista para borrar una etiqueta del calendario.

Cada calendario puede tener un máximo de 200 etiquetas.

 admite escritura
labelProperties.eventLabels[].backgroundColor string Color de fondo de la etiqueta en formato hexadecimal, como "#039be5". Los eventos con esta etiqueta se muestran en este color. Obligatorio. admite escritura
labelProperties.eventLabels[].id string El ID de la etiqueta. Es opcional cuando se inserta una etiqueta nueva. Si no se proporciona, se generará un ID único. Es obligatorio cuando se actualiza una etiqueta.

Si se proporciona, el ID debe ser único dentro del calendario y seguir el formato UUID.

 admite escritura
labelProperties.eventLabels[].name string Nombre de la etiqueta. Opcional.

Si se proporciona, debe tener como máximo 50 caracteres.

 admite escritura
location string Ubicación geográfica del calendario como texto de formato libre. Opcional. admite escritura
summary string Título del calendario. admite escritura
timeZone string Zona horaria del calendario (con formato de nombre de la base de datos de zonas horarias de IANA, p.ej., "Europe/Zurich"). Opcional. admite escritura

Métodos

sencillo
Borra un calendario principal. Esta operación borra todos los eventos asociados con el calendario principal de una cuenta.
borrar
Borra un calendario secundario. Usa calendars.clear para borrar todos los eventos de los calendarios principales.
get
Muestra los metadatos de un calendario.
insertar
Crea un calendario secundario.

El usuario autenticado para la solicitud se convierte en el propietario de los datos del calendario nuevo.

patch
Actualiza los metadatos de un calendario. 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 los campos que especifiques reemplazarán los valores existentes. Los campos que no especifiques en la solicitud no cambiarán. Los campos de array, si se especifican, reemplazan los arrays existentes; esto descarta cualquier elemento de array anterior.
transferOwnership
Transfiere un calendario secundario entre usuarios dentro de una organización de Google Workspace. Requiere la autenticación del usuario con el privilegio de administrador Administrar calendarios y uno de los siguientes alcances de autorización:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
En la solicitud, establece useAdminAccess en true. El calendario secundario debe estar activo para transferirse. No se admite la transferencia de calendarios inhabilitados o borrados.
actualizaciones
Actualiza los metadatos de un calendario.