Calendars

Es una colección de todos los calendarios existentes. 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#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,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}

Nombre de la propiedad	Valor	Descripción	Notas
autoAcceptInvitations	boolean	Indica si este calendario acepta invitaciones automáticamente. Solo es válido para los calendarios de recursos.
conferenceProperties	nested object	Son las propiedades de videoconferencia de este calendario, por ejemplo, qué tipos de videoconferencias se permiten.
conferenceProperties.allowedConferenceSolutionTypes[]	list	Son los tipos de soluciones para conferencias que se admiten en este calendario. Los siguientes son los valores posibles: "eventHangout" "eventNamedHangout" "hangoutsMeet" Opcional.
dataOwner	string	Es el correo electrónico del propietario del calendario. Se establece solo para calendarios secundarios. Solo lectura.
description	string	Es la descripción del calendario. Opcional.	admite escritura
etag	etag	Es la ETag del recurso.
id	string	Es el identificador del calendario. Para recuperar los IDs, llama al método calendarList.list().
kind	string	Es el tipo de recurso ("calendar#calendar").
labelProperties	nested object	Son las propiedades de las etiquetas definidas en este calendario. Si se especifica, reemplaza las propiedades de la etiqueta existente. Si no se especifica, las propiedades de la etiqueta no se modifican.	admite escritura
labelProperties.eventLabels[]	list	Son las etiquetas de eventos definidas en este calendario. Si este parámetro está presente cuando se actualiza el calendario, reemplazará las etiquetas de eventos existentes. Extiende la lista para agregar una nueva etiqueta de evento 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	Es el 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	Es el ID de la etiqueta. 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	Es el nombre de la etiqueta. Opcional. Si se proporciona, debe tener 50 caracteres como máximo.	admite escritura
location	string	Ubicación geográfica del calendario como texto de formato libre. Opcional.	admite escritura
summary	string	Es el título del calendario.	admite escritura
timeZone	string	La zona horaria del calendario. (Con el formato de un nombre de la base de datos de zonas horarias de IANA, p.ej., "Europe/Zurich"). Opcional.	admite escritura
workingHours	object	Representa la información sobre el horario laboral del usuario. Solo está disponible para los calendarios principales de los usuarios de Google Workspace. Para actualizar el horario laboral, se debe pasar todo el objeto de horario laboral. Si no se especifica (o se pasa como nulo o un objeto vacío), el horario laboral existente no se modifica. Para inhabilitar el horario laboral o borrar el programa, establece workingHoursEnabled como falso (y omite availableTimes o pasa una lista vacía).	admite escritura
workingHours.availableTimes[]	list	Horario laboral Cada período de disponibilidad representa el bloque de horario laboral del usuario durante un día.	admite escritura
workingHours.availableTimes[].dayOfWeek	string	Día de la semana. Obligatorio. Los valores posibles son los siguientes: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"	admite escritura
workingHours.availableTimes[].periodEnd	integer	Es el final del período, en minutos desde el comienzo del día, exclusivo. Obligatorio.	admite escritura
workingHours.availableTimes[].periodStart	integer	Es el inicio del período, en minutos desde el comienzo del día, inclusive. Obligatorio.	admite escritura
workingHours.workingHoursEnabled	boolean	Indica si el horario laboral está habilitado para este calendario. No se puede establecer como verdadero cuando availableTimes está vacío.	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

Devuelve 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.

Nota: Te recomendamos que te autentiques como el propietario de los datos del calendario. Puedes usar la delegación de autoridad para todo el dominio para permitir que las aplicaciones actúen en nombre de un usuario específico. No uses una cuenta de servicio para la autenticación. Si usas una cuenta de servicio para la autenticación, esta será la propietaria de los datos, lo que puede provocar un comportamiento inesperado. Por ejemplo, si una cuenta de servicio es la propietaria de los datos, no se puede transferir la propiedad de los datos.

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. Se recomienda 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.

transferOwnership

Transfiere un calendario secundario entre usuarios 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 permisos de autorización:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.calendars

En la solicitud, configura useAdminAccess como true. El calendario secundario debe estar activo para transferirse. No se admite la transferencia de calendarios inhabilitados o borrados.

update

Actualiza los metadatos de un calendario.