Events

La API de Calendar ofrece diferentes variantes de recursos de eventos. Puedes encontrar más información en el artículo Acerca de los eventos.

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

Representaciones de recursos

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Nombre de la propiedad Valor Descripción Notas
anyoneCanAddSelf boolean Si cualquiera puede invitarse a sí mismo al evento (no disponible) Opcional. El valor predeterminado es False. admite escritura
attachments[] list Archivos adjuntos del evento

Para modificar archivos adjuntos, el parámetro de solicitud supportsAttachments debe establecerse en true.

Puede haber como máximo 25 archivos adjuntos por evento,
attachments[].fileId string Es el ID del archivo adjunto. Solo lectura.

En el caso de los archivos de Google Drive, es el ID de la entrada del recurso Files correspondiente en la API de Drive.
attachments[].fileUrl string URL que dirige al archivo adjunto.

Para agregar archivos adjuntos de Google Drive, usa el mismo formato que en la propiedad alternateLink del recurso Files en la API de Drive.

Es obligatorio cuando se agrega un archivo adjunto.

 admite escritura
attachments[].mimeType string Tipo de medio de Internet (tipo MIME) del archivo adjunto.
attachments[].title string Título del archivo adjunto.
attendeesOmitted boolean Si es posible que los asistentes se hayan omitido en la representación del evento Cuando se recupera un evento, puede deberse a una restricción especificada por el parámetro de consulta maxAttendee. Cuando se actualiza un evento, se puede usar solo para actualizar la respuesta del participante. Opcional. El valor predeterminado es False. admite escritura
attendees[] list Los asistentes al evento. Consulta la guía Eventos con asistentes para obtener más información sobre cómo programar eventos con otros usuarios del calendario. Las cuentas de servicio deben usar la delegación de autoridad de todo el dominio para propagar la lista de asistentes. admite escritura
attendees[].additionalGuests integer Cantidad de huéspedes adicionales. Opcional. El valor predeterminado es 0. admite escritura
attendees[].comment string Comentario de la respuesta del asistente. Opcional. admite escritura
attendees[].displayName string El nombre del asistente, si está disponible. Opcional. admite escritura
attendees[].email string Dirección de correo electrónico del asistente, si está disponible. Este campo debe estar presente cuando se agrega un asistente. Debe ser una dirección de correo electrónico válida, según RFC5322.

Es obligatorio para agregar un asistente.

 admite escritura
attendees[].id string El ID de perfil del asistente, si está disponible.
attendees[].optional boolean Si se trata de un asistente opcional. Opcional. El valor predeterminado es False. admite escritura
attendees[].organizer boolean Si el asistente es el organizador del evento Solo lectura. El valor predeterminado es False.
attendees[].resource boolean Indica si el asistente es un recurso. Solo se puede configurar cuando se agrega al asistente al evento por primera vez. Las modificaciones posteriores se ignorarán. Opcional. El valor predeterminado es False. admite escritura
attendees[].responseStatus string Estado de respuesta del asistente. Los valores posibles son:
  • “needsAction”: El asistente no respondió a la invitación (recomendado para nuevos eventos).
  • "declined": El asistente rechazó la invitación.
  • "tentative": El asistente aceptó la invitación de manera provisoria.
  • "accepted": El asistente aceptó la invitación.
 admite escritura
attendees[].self boolean Indica si esta entrada representa el calendario en el que aparece esta copia del evento. Solo lectura. El valor predeterminado es False.
colorId string Indica el color del evento. Este es un ID que hace referencia a una entrada en la sección event de la definición de colores (consulta el extremo de colores). Opcional. admite escritura
conferenceData nested object Información relacionada con la conferencia, como los detalles de una conferencia de Google Meet Para crear nuevos detalles de la conferencia, usa el campo createRequest. Para conservar tus cambios, recuerda establecer el parámetro de solicitud conferenceDataVersion en 1 para todas las solicitudes de modificación de eventos. admite escritura
conferenceData.conferenceId string El ID de la conferencia.

Pueden usarla los desarrolladores para hacer un seguimiento de las conferencias y no deben mostrarse a los usuarios.

El valor del ID se forma de manera diferente para cada tipo de solución de conferencia:

  • eventHangout: No se estableció el ID. (Este tipo de conferencia ya no está disponible).
  • eventNamedHangout: ID es el nombre del Hangout. (Este tipo de conferencia ya no está disponible).
  • hangoutsMeet: El ID es el código de reunión de 10 letras, por ejemplo aaa-bbbb-ccc.
  • addOn: El proveedor de terceros define el ID.
Opcional.
conferenceData.conferenceSolution nested object La solución de conferencia, como Google Meet

No establecida para una conferencia con solicitud de creación fallida.

Se requiere conferenceSolution y al menos un entryPoint, o bien createRequest.
conferenceData.conferenceSolution.iconUri string El ícono visible para el usuario de esta solución.
conferenceData.conferenceSolution.key nested object Es la clave que puede identificar de manera única la solución de la conferencia para este evento.
conferenceData.conferenceSolution.key.type string Es el tipo de solución de conferencia.

Si un cliente encuentra un tipo desconocido o vacío, debería poder mostrar los puntos de entrada. Sin embargo, debería rechazar las modificaciones.

Los siguientes son los valores posibles:

  • "eventHangout" para Hangouts para consumidores (obsoleto; es posible que los eventos existentes muestren este tipo de solución de conferencias, pero no se pueden crear conferencias nuevas)
  • "eventNamedHangout" para los usuarios de la versión clásica de Hangouts para Google Workspace (obsoleto; es posible que los eventos existentes muestren este tipo de solución de conferencias, pero no se pueden crear conferencias nuevas)
  • "hangoutsMeet" para Google Meet (http://meet.google.com)
  • "addOn" para proveedores de conferencias externos

conferenceData.conferenceSolution.name string El nombre visible para el usuario de esta solución. No se localizó.
conferenceData.createRequest nested object Una solicitud para generar una conferencia nueva y adjuntarla al evento. Los datos se generan de forma asíncrona. Para ver si los datos están presentes, consulta el campo status.

Se requiere conferenceSolution y al menos un entryPoint, o bien createRequest.
conferenceData.createRequest.conferenceSolutionKey nested object La solución de conferencia, como Hangouts o Google Meet
conferenceData.createRequest.conferenceSolutionKey.type string Es el tipo de solución de conferencia.

Si un cliente encuentra un tipo desconocido o vacío, debería poder mostrar los puntos de entrada. Sin embargo, debería rechazar las modificaciones.

Los siguientes son los valores posibles:

  • "eventHangout" para Hangouts para consumidores (obsoleto; es posible que los eventos existentes muestren este tipo de solución de conferencias, pero no se pueden crear conferencias nuevas)
  • "eventNamedHangout" para los usuarios de la versión clásica de Hangouts para Google Workspace (obsoleto; es posible que los eventos existentes muestren este tipo de solución de conferencias, pero no se pueden crear conferencias nuevas)
  • "hangoutsMeet" para Google Meet (http://meet.google.com)
  • "addOn" para proveedores de conferencias externos

conferenceData.createRequest.requestId string El ID único generado por el cliente para esta solicitud.

Los clientes deben volver a generar este ID para cada solicitud nueva. Si un ID proporcionado es el mismo que el de la solicitud anterior, esta se ignora.
conferenceData.createRequest.status nested object El estado de la solicitud de creación de la conferencia.
conferenceData.createRequest.status.statusCode string El estado actual de la solicitud de creación de conferencia. Solo lectura.

Los siguientes son los valores posibles:

  • "pending": Todavía se está procesando la solicitud de creación de conferencia.
  • "success": La solicitud de creación de la conferencia se realizó correctamente. Se completaron los puntos de entrada.
  • "failure": Se produjo un error en la solicitud de creación de la conferencia. No hay puntos de entrada.

conferenceData.entryPoints[] list Información sobre los puntos de entrada de la conferencia individual, como las URL o los números de teléfono.

Todos deben pertenecer a la misma conferencia.

Se requiere conferenceSolution y al menos un entryPoint, o bien createRequest.
conferenceData.entryPoints[].accessCode string El código de acceso para acceder a la conferencia. La longitud máxima es de 128 caracteres.

Cuando crees nuevos datos de conferencia, propaga solo el subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que coincida con la terminología que utiliza el proveedor de conferencias. Solo se deben mostrar los campos completados.

Opcional.
conferenceData.entryPoints[].entryPointType string El tipo de punto de entrada de la conferencia.

Los valores posibles son:

  • "video": se une a una conferencia a través de HTTP. Una conferencia puede tener cero o un punto de entrada video.
  • "phone": Marca un número de teléfono para unirte a una conferencia. Una conferencia puede tener cero o más puntos de entrada phone.
  • "sip": Se está uniendo a una conferencia a través de SIP. Una conferencia puede tener cero o un punto de entrada sip.
  • "more": Incluye instrucciones adicionales para unirse a la conferencia, por ejemplo, números de teléfono adicionales. Una conferencia puede tener cero o un punto de entrada more. Una conferencia que solo tiene un punto de entrada para more no es válida.

conferenceData.entryPoints[].label string Es la etiqueta del URI. Visible para los usuarios finales No se localizó. La longitud máxima es de 512 caracteres.

Ejemplos:

  • para video: meet.google.com/aaa-bbbb-ccc
  • para phone: +1 123 268 2601
  • para sip: 12345678@altostrat.com
  • para more: no se debe completar

Opcional.
conferenceData.entryPoints[].meetingCode string El código de reunión para acceder a la conferencia. La longitud máxima es de 128 caracteres.

Cuando crees nuevos datos de conferencia, propaga solo el subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que coincida con la terminología que utiliza el proveedor de conferencias. Solo se deben mostrar los campos completados.

Opcional.
conferenceData.entryPoints[].passcode string El código para acceder a la conferencia. La longitud máxima es de 128 caracteres.

Cuando crees nuevos datos de conferencia, propaga solo el subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que coincida con la terminología que utiliza el proveedor de conferencias. Solo se deben mostrar los campos completados.
conferenceData.entryPoints[].password string La contraseña para acceder a la conferencia. La longitud máxima es de 128 caracteres.

Cuando crees nuevos datos de conferencia, propaga solo el subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que coincida con la terminología que utiliza el proveedor de conferencias. Solo se deben mostrar los campos completados.

Opcional.
conferenceData.entryPoints[].pin string El PIN para acceder a la conferencia. La longitud máxima es de 128 caracteres.

Cuando crees nuevos datos de conferencia, propaga solo el subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que coincida con la terminología que utiliza el proveedor de conferencias. Solo se deben mostrar los campos completados.

Opcional.
conferenceData.entryPoints[].uri string El URI del punto de entrada. La longitud máxima es de 1,300 caracteres.

Formato:

  • para los esquemas video, http: o https:.
  • para phone, se requiere el esquema tel:. El URI debe incluir la secuencia de marcado completa (p. ej., tel.:+12345678900,,123456789;1234).
  • Para sip, se requiere el esquema sip:, p.ej., sip:12345678@myprovider.com.
  • para los esquemas more, http: o https:.

conferenceData.notes string Notas adicionales (como instrucciones del administrador del dominio, avisos legales) para mostrar al usuario. Puede contener HTML. La longitud máxima es de 2,048 caracteres. Opcional.
conferenceData.signature string La firma de los datos de la conferencia.

Se genera en el servidor.

No establecida para una conferencia con solicitud de creación fallida.

Opcional para una conferencia con una solicitud de creación pendiente.
created datetime Hora de creación del evento (como una marca de tiempo RFC3339). Solo lectura.
creator object Corresponde al creador del evento. Solo lectura.
creator.displayName string El nombre del creador, si está disponible.
creator.email string Dirección de correo electrónico del creador, si está disponible.
creator.id string El ID de perfil del creador, si está disponible.
creator.self boolean Si el creador corresponde al calendario en el que aparece esta copia del evento. Solo lectura. El valor predeterminado es False.
description string Descripción del evento. Puede contener HTML. Opcional. admite escritura
end nested object Hora de finalización (exclusiva) del evento. En el caso de un evento recurrente, esta es la hora de finalización de la primera instancia.
end.date date Es la fecha, en el formato “aaaa-mm-dd”, si el evento dura todo el día. admite escritura
end.dateTime datetime La hora, como un valor de fecha y hora combinado (con un formato acorde a RFC3339). Se requiere un desplazamiento de zona horaria, a menos que se especifique explícitamente una zona horaria en timeZone. admite escritura
end.timeZone string Es la zona horaria en la que se especifica la hora. (Tiene el formato de un nombre de la base de datos de zonas horarias de IANA, p.ej., "Europa/Zúrich"). Para los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en la que se expande la recurrencia. Para los eventos individuales, este campo es opcional e indica una zona horaria personalizada para el inicio y la finalización del evento. admite escritura
endTimeUnspecified boolean Si la hora de finalización no está realmente especificada. Se proporciona una hora de finalización por motivos de compatibilidad, incluso si este atributo se establece en True. El valor predeterminado es False.
etag etag ETag del recurso.
eventType string Es el tipo específico de evento. No se puede modificar después de crear el evento. Los valores posibles son:
  • "default": Es un evento normal o sin especificar más.
  • "outOfOffice": Es un evento fuera de la oficina.
  • "focusTime": Es un evento de tiempo dedicado.
  • "workingLocation": Es un evento de ubicación de trabajo.
  • "fromGmail": Es un evento de Gmail. No se puede crear este tipo de evento.
 admite escritura
extendedProperties object Propiedades extendidas del evento.
extendedProperties.private object Propiedades que son privadas para la copia del evento que aparece en este calendario. admite escritura
extendedProperties.private.(key) string El nombre de la propiedad privada y el valor correspondiente
extendedProperties.shared object Propiedades que se comparten entre copias del evento en los calendarios de otros asistentes. admite escritura
extendedProperties.shared.(key) string El nombre de la propiedad compartida y el valor correspondiente
focusTimeProperties nested object Datos de eventos de Tiempo dedicado. Se usa si eventType es focusTime. admite escritura
focusTimeProperties.autoDeclineMode string Establece si se deben rechazar invitaciones a reuniones que se superpongan con los eventos de tiempo dedicado. Los valores válidos son declineNone, lo que significa que no se rechaza ninguna invitación a reuniones; declineAllConflictingInvitations, que se rechazan todas las invitaciones a reuniones en conflicto que entren en conflicto con el evento, y declineOnlyNewConflictingInvitations, lo que significa que solo se rechazarán las nuevas invitaciones a reuniones en conflicto que lleguen mientras esté presente el evento de tiempo dedicado.
focusTimeProperties.chatStatus string El estado para marcar al usuario en Chat y los productos relacionados. Puede ser available o doNotDisturb.
focusTimeProperties.declineMessage string Mensaje de respuesta para establecer si el Calendario rechaza automáticamente un evento existente o una invitación nueva.
gadget object Un gadget que extiende el evento. Los gadgets dejaron de estar disponibles; esta estructura solo se utiliza para mostrar los metadatos del calendario de cumpleaños.
gadget.display string El modo de visualización del gadget. Ya no está disponible. Los valores posibles son:
  • "icon": El gadget se muestra junto al título del evento en la vista de calendario.
  • "chip": El gadget se muestra cuando se hace clic en el evento.
 admite escritura
gadget.height integer La altura del gadget en píxeles. La altura debe ser un número entero mayor que 0. Opcional. Ya no está disponible. admite escritura
gadget.preferences object Preferencias. admite escritura
gadget.preferences.(key) string El nombre de preferencia y el valor correspondiente.
gadget.title string Título del gadget. Ya no está disponible. admite escritura
gadget.type string El tipo de gadget. Ya no está disponible. admite escritura
gadget.width integer Es el ancho del gadget en píxeles. El ancho debe ser un número entero mayor que 0. Opcional. Ya no está disponible. admite escritura
guestsCanInviteOthers boolean Indica si los asistentes que no sean el organizador pueden invitar a otras personas al evento. Opcional. El valor predeterminado es True. admite escritura
guestsCanModify boolean Indica si los asistentes que no sean el organizador pueden modificar el evento. Opcional. El valor predeterminado es False. admite escritura
guestsCanSeeOtherGuests boolean Si los asistentes que no sean el organizador pueden ver quiénes son los asistentes del evento Opcional. El valor predeterminado es True. admite escritura
iCalUID string Es el identificador único del evento, como se define en RFC5545. Se utiliza para identificar de forma única los eventos en los sistemas de calendario y debe proporcionarse cuando se importan eventos a través del método import.

Ten en cuenta que iCalUID y id no son idénticos y que solo se debe proporcionar uno de ellos en el momento de la creación del evento. Una diferencia en su semántica es que, en los eventos recurrentes, todos los casos de un evento tienen diferentes id, mientras que todos comparten los mismos iCalUID. Para recuperar un evento usando su iCalUID, llama al método events.list mediante el parámetro iCalUID. Para recuperar un evento mediante su id, llama al método events.get.
id string Es el identificador opaco del evento. Al crear nuevos eventos únicos o recurrentes, puedes especificar sus IDs. Los IDs proporcionados deben seguir estas reglas:
  • Los caracteres permitidos en el ID son los que se usan en la codificación base32hex, es decir, letras minúsculas de la "a" a la "v" y los dígitos del 0 al 9; consulta la sección 3.1.2 de RFC2938.
  • la longitud del ID debe tener entre 5 y 1,024 caracteres
  • el ID debe ser único por calendario
Debido a la naturaleza distribuida a nivel global del sistema, no podemos garantizar que las colisiones de IDs se detecten en el momento de la creación del evento. Para minimizar el riesgo de colisiones, recomendamos usar un algoritmo de UUID establecido, como el que se describe en RFC4122.

Si no especificas un ID, el servidor lo generará automáticamente.

Ten en cuenta que icalUID y id no son idénticos y que solo se debe proporcionar uno de ellos en el momento de la creación del evento. Una diferencia en su semántica es que, en los eventos recurrentes, todos los casos de un evento tienen diferentes id, mientras que todos comparten los mismos icalUID.

 admite escritura
kind string Es el tipo de recurso (“calendar#event”).
location string Ubicación geográfica del evento como texto de formato libre. Opcional. admite escritura
locked boolean Indica si se trata de una copia de un evento bloqueado en el que no se pueden realizar cambios en los campos del evento principal "summary", "description", "location", "start", "end" o "recurrence". El valor predeterminado es False. Solo lectura.
organizer object Es el organizador del evento. Si el organizador también es un asistente, esto se indica con una entrada separada en attendees con el campo organizer establecido en Verdadero. Para cambiar el organizador, usa la operación de mover. Solo lectura, excepto cuando se importa un evento admite escritura
organizer.displayName string Nombre del organizador, si está disponible. admite escritura
organizer.email string Dirección de correo electrónico del organizador, si está disponible. Debe ser una dirección de correo electrónico válida, según RFC5322. admite escritura
organizer.id string ID de perfil del organizador, si está disponible.
organizer.self boolean Indica si el organizador corresponde al calendario en el que aparece esta copia del evento. Solo lectura. El valor predeterminado es False.
originalStartTime nested object En el caso de un evento recurrente, esta es la hora a la que se iniciaría el evento de acuerdo con los datos de recurrencia del evento recurrente identificado por periódicamenteEventId. Identifica de manera única la instancia dentro de la serie de eventos recurrentes, incluso si la instancia se trasladó a un horario diferente. Inmutable.
originalStartTime.date date Es la fecha, en el formato “aaaa-mm-dd”, si el evento dura todo el día. admite escritura
originalStartTime.dateTime datetime La hora, como un valor de fecha y hora combinado (con un formato acorde a RFC3339). Se requiere un desplazamiento de zona horaria, a menos que se especifique explícitamente una zona horaria en timeZone. admite escritura
originalStartTime.timeZone string Es la zona horaria en la que se especifica la hora. (Tiene el formato de un nombre de la base de datos de zonas horarias de IANA, p.ej., "Europa/Zúrich"). Para los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en la que se expande la recurrencia. Para los eventos individuales, este campo es opcional e indica una zona horaria personalizada para el inicio y la finalización del evento. admite escritura
outOfOfficeProperties nested object Datos de eventos fuera de la oficina. Se usa si eventType es outOfOffice. admite escritura
outOfOfficeProperties.autoDeclineMode string Indica si se deben rechazar las invitaciones a reuniones que se superponen con los eventos fuera de la oficina. Los valores válidos son declineNone, lo que significa que no se rechaza ninguna invitación a reuniones; declineAllConflictingInvitations, que se rechazan todas las invitaciones a reuniones en conflicto que entren en conflicto con el evento, y declineOnlyNewConflictingInvitations, lo que significa que solo se rechazarán las nuevas invitaciones a reuniones en conflicto que lleguen mientras esté presente el evento fuera de la oficina.
outOfOfficeProperties.declineMessage string Mensaje de respuesta para establecer si el Calendario rechaza automáticamente un evento existente o una invitación nueva.
privateCopy boolean Si la estableces como verdadera, se inhabilitará la Propagación de eventos. Ten en cuenta que no es lo mismo que las propiedades de eventos privados. Opcional. Inmutable. El valor predeterminado es False.
recurrence[] list Lista de líneas RRULE, EXRULE, RDATE y EXDATE para un evento recurrente, como se especifica en RFC5545. Ten en cuenta que no se permiten las líneas DTSTART y DTEND en este campo. Las horas de inicio y finalización del evento se especifican en los campos start y end. Este campo se omite para eventos individuales o instancias de eventos recurrentes. admite escritura
recurringEventId string Para la instancia de un evento recurrente, esta es la id del evento recurrente al que pertenece esta instancia. Inmutable.
reminders object Información sobre los recordatorios del evento para el usuario autenticado. Ten en cuenta que cambiar los recordatorios no modifica la propiedad updated del evento de cierre.
reminders.overrides[] list Si el evento no utiliza los recordatorios predeterminados, se muestran los recordatorios específicos del evento o, si no se establece, se indica que no se estableció ningún recordatorio para este evento. La cantidad máxima de recordatorios de anulación es 5. admite escritura
reminders.overrides[].method string Indica 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 cuando se agrega un recordatorio.

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

Obligatorio cuando se agrega un recordatorio.

 admite escritura
reminders.useDefault boolean Establece si los recordatorios predeterminados del calendario se aplican al evento. admite escritura
sequence integer Número de secuencia según iCalendario. admite escritura
source object Fuente desde la que se creó el evento. Por ejemplo, una página web, un mensaje de correo electrónico o cualquier documento identificable por una URL con esquema HTTP o HTTPS. Solo el creador del evento puede verlo o modificarlo.
source.title string Título de la fuente; por ejemplo, el título de una página web o el asunto de un correo electrónico admite escritura
source.url string URL de la fuente que apunta a un recurso. El esquema de URL debe ser HTTP o HTTPS. admite escritura
start nested object Hora de inicio (inclusiva) del evento. En el caso de un evento recurrente, esta es la hora de inicio de la primera instancia.
start.date date Es la fecha, en el formato “aaaa-mm-dd”, si el evento dura todo el día. admite escritura
start.dateTime datetime La hora, como un valor de fecha y hora combinado (con un formato acorde a RFC3339). Se requiere un desplazamiento de zona horaria, a menos que se especifique explícitamente una zona horaria en timeZone. admite escritura
start.timeZone string Es la zona horaria en la que se especifica la hora. (Tiene el formato de un nombre de la base de datos de zonas horarias de IANA, p.ej., "Europa/Zúrich"). Para los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en la que se expande la recurrencia. Para los eventos individuales, este campo es opcional e indica una zona horaria personalizada para el inicio y la finalización del evento. admite escritura
status string Estado del evento. Opcional. Los valores posibles son:
  • "confirmed": El evento se confirmó. Este es el estado predeterminado.
  • "tentative": El evento se confirmó de manera provisoria.
  • "cancelled": El evento se cancela (se borra). El método list muestra eventos cancelados solo durante la sincronización incremental (cuando se especifican syncToken o updatedMin) o si la marca showDeleted se establece en true. El método get siempre las muestra.

    Un estado cancelado representa dos estados diferentes según el tipo de evento:

    1. Las excepciones canceladas de un evento recurrente sin cancelar indican que esta instancia ya no se debe presentar al usuario. Los clientes deben almacenar estos eventos durante toda la vida útil del evento principal recurrente.

      Solo se garantiza que las excepciones canceladas tengan propagados los valores de los campos id, recurringEventId y originalStartTime. Es posible que los otros campos estén vacíos.

    2. Todos los demás eventos cancelados representan eventos borrados. Los clientes deben quitar sus copias sincronizadas de manera local. Esos eventos cancelados desaparecerán con el tiempo, así que no dependas de que estén disponibles de forma indefinida.

      Solo se garantiza que los eventos borrados tengan propagado el campo id.

    En el calendario del organizador, los eventos cancelados siguen mostrando los detalles del evento (resumen, ubicación, etc.) para que se puedan restablecer (no borrar). De manera similar, seguirán proporcionando detalles los eventos a los que se haya invitado al usuario y que este haya quitado manualmente. Sin embargo, las solicitudes de sincronización incrementales con showDeleted establecido en falso no mostrarán estos detalles.

    Si un evento cambia de organizador (por ejemplo, mediante la operación mover) y el organizador original no está en la lista de asistentes, dejará un evento cancelado en el que solo se garantizará que se complete el campo id.

admite escritura
summary string Corresponde al título del evento. admite escritura
transparency string Indica si el evento bloquea tiempo en el calendario. Opcional. Los valores posibles son:
  • "opaque": Valor predeterminado. Sin embargo, el evento establece un horario en el calendario. Esto equivale a configurar Mostrarme como como Ocupado en la IU del Calendario.
  • "transparent": El evento no bloquea un horario en el calendario. Esto equivale a configurar Mostrar como como Disponible en la IU del Calendario.
 admite escritura
updated datetime Hora de la última modificación de los datos del evento principal (como una marca de tiempo RFC3339). Los recordatorios de eventos no cambiarán. Solo lectura.
visibility string Visibilidad del evento Opcional. Los valores posibles son:
  • "default": Usa la visibilidad predeterminada de los eventos del calendario. Este es el valor predeterminado.
  • "public": El evento es público, y los detalles son visibles para todos los lectores del calendario.
  • "private": El evento es privado y solo los asistentes pueden ver los detalles.
  • "confidential": El evento es privado. Este valor se proporciona por motivos de compatibilidad.
 admite escritura
workingLocationProperties nested object Datos de eventos de ubicación de trabajo. admite escritura
workingLocationProperties.customLocation object Si está presente, especifica que el usuario está trabajando desde una ubicación personalizada. admite escritura
workingLocationProperties.customLocation.label string Una etiqueta adicional opcional para obtener información adicional. admite escritura
workingLocationProperties.homeOffice any value Si está presente, especifica que el usuario está trabajando desde casa. admite escritura
workingLocationProperties.officeLocation object Si está presente, especifica que el usuario está trabajando desde una oficina. admite escritura
workingLocationProperties.officeLocation.buildingId string Un identificador de edificio opcional. Debe hacer referencia a un ID de edificio en la base de datos de recursos de la organización. admite escritura
workingLocationProperties.officeLocation.deskId string Un identificador de escritorio opcional. admite escritura
workingLocationProperties.officeLocation.floorId string Un identificador de piso opcional. admite escritura
workingLocationProperties.officeLocation.floorSectionId string Un identificador opcional de la sección del piso. admite escritura
workingLocationProperties.officeLocation.label string El nombre de la oficina que se muestra en los clientes de Calendario web y Dispositivos móviles. Te recomendamos hacer referencia al nombre de un edificio en la base de datos de recursos de la organización. admite escritura
workingLocationProperties.type string El tipo de ubicación de trabajo. Los valores posibles son:
  • "homeOffice": El usuario está trabajando en su casa.
  • "officeLocation": El usuario está trabajando desde una oficina.
  • "customLocation": El usuario está trabajando desde una ubicación personalizada.
Los detalles se especifican en un subcampo del nombre especificado, pero es posible que falte este campo si está vacío. Se ignorará cualquier otro campo.

Es obligatorio cuando se agregan propiedades de ubicación de trabajo.

 admite escritura

Métodos

borrar
Borra un evento.
get
Muestra un evento en función del ID de su Calendario de Google. Para recuperar un evento por medio de su ID de iCalendario, llama al método events.list mediante el parámetro iCalUID.
import
Importa un evento. Esta operación se usa para agregar una copia privada de un evento existente a un calendario. Solo se pueden importar eventos con una eventType de default.

Comportamiento obsoleto: Si se importa un evento que no es default, su tipo se cambiará a default y se descartarán todas las propiedades específicas de un tipo de evento que pueda tener.

insertar
Crea un evento.
instancias
Muestra instancias del evento recurrente especificado.
list
Muestra los eventos del calendario especificado.
mover
Mueve un evento a otro calendario, es decir, cambia el organizador de un evento. Ten en cuenta que solo puedes trasladar los eventos default. No podrás mover los eventos outOfOffice, focusTime, workingLocation y fromGmail.
patch
Actualiza un evento. 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 no se modificarán. Los campos de array, si se especifican, reemplazan los arrays existentes. Esto descarta cualquier elemento del array anterior.
quickAdd
Crea un evento basado en una cadena de texto simple.
actualización
Actualiza un evento. Este método no admite la semántica de parches y siempre actualiza todo el recurso del evento. Para hacer una actualización parcial, realiza un get seguido de un update usando ETags para garantizar la atomicidad.
reloj
Presta atención a los cambios en los recursos de eventos.