Events

La API de Calendar proporciona diferentes versiones de los recursos de eventos. Puedes encontrar más información en Acerca de los eventos.

Para obtener una lista de los métodos de este recurso, consulta el 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
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
Nombre de la propiedad Valor Descripción Notas
anyoneCanAddSelf boolean Indica si cualquier persona puede invitarse al evento (obsoleto). Opcional. El valor predeterminado es False. admite escritura
attachments[] list Son los archivos adjuntos del evento.

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

Puede haber hasta 25 archivos adjuntos por evento.
attachments[].fileId string 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 Es el vínculo URL 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.

Se requiere cuando se agrega un archivo adjunto.

 admite escritura
attachments[].mimeType string Tipo de medio de Internet (tipo de MIME) del archivo adjunto.
attachments[].title string Título del archivo adjunto.
attendeesOmitted boolean Indica si es posible que se hayan omitido asistentes de la representación del evento. Cuando se recupera un evento, esto puede deberse a una restricción especificada por el parámetro de consulta maxAttendee. Cuando se actualiza un evento, se puede usar para actualizar solo la respuesta del participante. Opcional. El valor predeterminado es False. admite escritura
attendees[] list Son 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 en todo el dominio para completar la lista de asistentes. admite escritura
attendees[].additionalGuests integer Es la cantidad de huéspedes adicionales. Opcional. El valor predeterminado es 0. admite escritura
attendees[].comment string Es el comentario de respuesta del asistente. Opcional. admite escritura
attendees[].displayName string 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 el RFC5322.

Se requiere cuando se agrega un asistente.

 admite escritura
attendees[].id string ID del perfil del asistente, si está disponible.
attendees[].optional boolean Indica si el asistente es opcional. Opcional. El valor predeterminado es False. admite escritura
attendees[].organizer boolean Indica 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 el asistente al evento por primera vez. Se ignoran las modificaciones posteriores. Opcional. El valor predeterminado es False. admite escritura
attendees[].responseStatus string Es el estado de respuesta del asistente. Los valores posibles son los siguientes:
  • "needsAction": El asistente no respondió la invitación (se recomienda para eventos nuevos).
  • "declined": El asistente rechazó la invitación.
  • "tentative": El asistente aceptó la invitación de forma 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.
birthdayProperties nested object Datos de cumpleaños o eventos especiales Se usa si eventType es "birthday". Inmutable. admite escritura
birthdayProperties.contact string Es el nombre del recurso del contacto al que está vinculado este evento de cumpleaños. Se puede usar para recuperar detalles de contacto de la API de People. Formato: "people/c12345". Solo lectura.
birthdayProperties.customTypeName string Es la etiqueta de tipo personalizada especificada para este evento. Este campo se propaga si birthdayProperties.type se establece en "custom". Solo lectura.
birthdayProperties.type string Tipo de cumpleaños o evento especial. Los valores posibles son los siguientes:
  • "anniversary": Es un aniversario que no es de cumpleaños. Siempre tiene un contact.
  • "birthday": Es un evento de cumpleaños. Este es el valor predeterminado.
  • "custom": Es una fecha especial cuya etiqueta se especifica aún más en el campo customTypeName. Siempre tiene un contact.
  • "other": Es una fecha especial que no se incluye en las otras categorías y no tiene una etiqueta personalizada. Siempre tiene un contact.
  • "self": Cumpleaños del propietario del calendario. No puede tener un contact.
La API de Calendar solo admite la creación de eventos con el tipo "birthday". No se puede cambiar el tipo después de crear el evento.		 admite escritura
colorId string Color del evento. 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 Es la información relacionada con la conferencia, como los detalles de una conferencia de Google Meet. Para crear detalles de conferencia nuevos, usa el campo createRequest. Para conservar los 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 Es el ID de la conferencia.

Los desarrolladores pueden usarlo para hacer un seguimiento de las conferencias. No se debe mostrar a los usuarios.

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

  • eventHangout: El ID no está configurado. (Este tipo de conferencia ya no está disponible).
  • eventNamedHangout: El 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 ID lo define el proveedor externo.
Opcional.
conferenceData.conferenceSolution nested object Es la solución de conferencia, como Google Meet.

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

Se requiere conferenceSolution y al menos un entryPoint, o bien createRequest.
conferenceData.conferenceSolution.iconUri string Ícono visible para el usuario de esta solución.
conferenceData.conferenceSolution.key nested object Es la clave que puede identificar de forma única la solución de 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, no debería permitir 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 conferencia, pero no se pueden crear conferencias nuevas)
  • "eventNamedHangout" para la versión clásica de Hangouts para usuarios de Google Workspace (obsoleto; es posible que los eventos existentes muestren este tipo de solución de conferencia, 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 Es el nombre visible para el usuario de esta solución. No está localizada.
conferenceData.createRequest nested object Es una solicitud para generar una nueva conferencia 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 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, no debería permitir 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 conferencia, pero no se pueden crear conferencias nuevas)
  • "eventNamedHangout" para la versión clásica de Hangouts para usuarios de Google Workspace (obsoleto; es posible que los eventos existentes muestren este tipo de solución de conferencia, 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 Es el ID único generado por el cliente para esta solicitud.

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

Los siguientes son los valores posibles:

  • "pending": La solicitud de creación de la conferencia aún se está procesando.
  • "success": La solicitud de creación de la conferencia se realizó correctamente y se propagaron los puntos de entrada.
  • "failure": Falló la solicitud de creación de la conferencia. No hay puntos de entrada.

conferenceData.entryPoints[] list Es la información sobre los puntos de entrada individuales de la conferencia, como URLs o 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 Es el código de acceso para ingresar a la conferencia. La longitud máxima es de 128 caracteres.

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

Opcional.
conferenceData.entryPoints[].entryPointType string Es 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": Unirse a una conferencia marcando un número de teléfono. Una conferencia puede tener cero o más puntos de entrada phone.
  • "sip": Se une a una conferencia a través de SIP. Una conferencia puede tener cero o un punto de entrada sip.
  • "more": 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 con solo un punto de entrada more no es válida.

conferenceData.entryPoints[].label string Es la etiqueta del URI. Es visible para los usuarios finales. No está localizada. 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 Es el código de la reunión para acceder a la conferencia. La longitud máxima es de 128 caracteres.

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

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

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

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

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

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

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

Formato:

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

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

Se genera en el servidor.

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

Es opcional para una conferencia con una solicitud de creación pendiente.
created datetime Es la fecha y hora de creación del evento (como una marca de tiempo RFC3339). Solo lectura.
creator object Es el creador del evento. Solo lectura.
creator.displayName string Nombre del creador, si está disponible.
creator.email string Dirección de correo electrónico del creador, si está disponible.
creator.id string ID del perfil del creador, si está disponible.
creator.self boolean Indica 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 Es la 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 Fecha, en formato "aaaa-mm-dd", si se trata de un evento de todo el día. admite escritura
end.dateTime datetime Es la hora, como un valor combinado de fecha y hora (con formato según RFC3339). Se requiere una compensación 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. (Con el formato de un nombre de la base de datos de zonas horarias de IANA, p.ej., "Europe/Zurich"). En el caso de los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en la que se expande la recurrencia. En el caso de eventos únicos, este campo es opcional y muestra una zona horaria personalizada para el inicio y el final del evento. admite escritura
endTimeUnspecified boolean Indica si la hora de finalización no se especificó. Aun así, se proporciona una hora de finalización por motivos de compatibilidad, incluso si este atributo se establece como verdadero. El valor predeterminado es False.
etag etag ETag del recurso.
eventType string Es el tipo específico del evento. Este parámetro no se puede modificar después de crear el evento. Los valores posibles son los siguientes:
  • "birthday": Es un evento especial de todo el día con recurrencia anual.
  • "default": Es un evento normal o no se especifica más.
  • "focusTime": Es un evento de tiempo dedicado.
  • "fromGmail": Es un evento de Gmail. No se puede crear este tipo de evento.
  • "outOfOffice": Es un evento fuera de la oficina.
  • "workingLocation": Es un evento de ubicación de trabajo.
 admite escritura
extendedProperties object Son las propiedades extendidas del evento.
extendedProperties.private object Son las propiedades privadas de la copia del evento que aparece en este calendario. admite escritura
extendedProperties.private.(key) string Es el nombre de la propiedad privada y el valor correspondiente.
extendedProperties.shared object Son las propiedades que se comparten entre las copias del evento en los calendarios de otros asistentes. admite escritura
extendedProperties.shared.(key) string Es el nombre de la propiedad compartida y el valor correspondiente.
focusTimeProperties nested object Son los datos del evento de tiempo dedicado. Se usa si eventType es focusTime. admite escritura
focusTimeProperties.autoDeclineMode string Indica si se deben rechazar las invitaciones a reuniones que se superponen con eventos de tiempo dedicado. Los valores válidos son declineNone, lo que significa que no se rechazan las invitaciones a reuniones; declineAllConflictingInvitations, lo que significa que se rechazan todas las invitaciones a reuniones que se superponen con el evento; y declineOnlyNewConflictingInvitations, lo que significa que solo se rechazan las invitaciones a reuniones nuevas que se superponen y que llegan mientras está presente el evento de tiempo dedicado.
focusTimeProperties.chatStatus string Es el estado para marcar al usuario en Chat y los productos relacionados. Puede ser available o doNotDisturb.
focusTimeProperties.declineMessage string Es el mensaje de respuesta que se establece si el Calendario rechaza automáticamente un evento existente o una invitación nueva.
gadget object Es un gadget que extiende este evento. Los gadgets están obsoletos. En cambio, esta estructura solo se usa para devolver metadatos del calendario de cumpleaños.
gadget.display string Es el modo de visualización del gadget. Obsoleta. Los valores posibles son los siguientes:
  • "icon": El gadget se muestra junto al título del evento en la vista del calendario.
  • "chip": El gadget se muestra cuando se hace clic en el evento.
 admite escritura
gadget.height integer Altura del gadget en píxeles. La altura debe ser un número entero mayor que 0. Opcional. Obsoleta. admite escritura
gadget.preferences object Preferencias. admite escritura
gadget.preferences.(key) string Nombre de la preferencia y valor correspondiente.
gadget.title string Es el título del gadget. Obsoleta. admite escritura
gadget.type string Es el tipo de gadget. Obsoleta. admite escritura
gadget.width integer Ancho del gadget en píxeles. El ancho debe ser un número entero mayor que 0. Opcional. Obsoleta. admite escritura
guestsCanInviteOthers boolean Indica si los asistentes que no son 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 Indica si los asistentes que no son el organizador pueden ver quiénes son los asistentes al evento. Opcional. El valor predeterminado es True. admite escritura
iCalUID string Es el identificador único del evento, según se define en RFC5545. Se usa para identificar de forma única los eventos en los sistemas de calendario y se debe proporcionar cuando se importan eventos a través del método import.

Ten en cuenta que iCalUID y id no son idénticos y 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, todas las ocurrencias de un evento tienen diferentes id, pero todas comparten los mismos iCalUID. Para recuperar un evento con su iCalUID, llama al método events.list con el parámetro iCalUID. Para recuperar un evento con su id, llama al método events.get.
id string Es el identificador opaco del evento. Cuando creas eventos únicos o recurrentes nuevos, 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 en minúsculas de la a a la v y dígitos del 0 al 9.Consulta la sección 3. 1.2 en RFC2938.
  • La longitud del ID debe estar 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 se detecten colisiones de ID 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 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, todas las ocurrencias de un evento tienen diferentes id, pero todas comparten los mismos icalUID.

 admite escritura
kind string 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 bloqueada del evento en la que no se pueden realizar cambios en los campos principales del evento: "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 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 move. Es de 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 el RFC5322. admite escritura
organizer.id string ID del 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 una instancia de un evento recurrente, es la hora a la que comenzaría este evento según los datos de recurrencia del evento recurrente identificado por recurringEventId. Identifica de forma única la instancia dentro de la serie de eventos recurrentes, incluso si la instancia se trasladó a otro horario. Inmutable.
originalStartTime.date date Fecha, en formato "aaaa-mm-dd", si se trata de un evento de todo el día. admite escritura
originalStartTime.dateTime datetime Es la hora, como un valor combinado de fecha y hora (con formato según RFC3339). Se requiere una compensación 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. (Con el formato de un nombre de la base de datos de zonas horarias de IANA, p.ej., "Europe/Zurich"). En el caso de los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en la que se expande la recurrencia. En el caso de eventos únicos, este campo es opcional y muestra una zona horaria personalizada para el inicio y el final del evento. admite escritura
outOfOfficeProperties nested object Son los datos del evento 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 rechazan las invitaciones a reuniones; declineAllConflictingInvitations, lo que significa que se rechazan todas las invitaciones a reuniones que se superponen con el evento, y declineOnlyNewConflictingInvitations, lo que significa que solo se rechazan las invitaciones a reuniones nuevas que llegan mientras está presente el evento de Fuera de la oficina.
outOfOfficeProperties.declineMessage string Es el mensaje de respuesta que se establece si el Calendario rechaza automáticamente un evento existente o una invitación nueva.
privateCopy boolean Si se establece en verdadero, se inhabilita 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 Es una 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 únicos o instancias de eventos recurrentes. admite escritura
recurringEventId string En el caso de una instancia de un evento recurrente, este es el id del evento recurrente al que pertenece esta instancia. Inmutable.
reminders object Es información sobre los recordatorios del evento para el usuario autenticado. Ten en cuenta que cambiar los recordatorios no cambia la propiedad updated del evento que los contiene.
reminders.overrides[] list Si el evento no usa los recordatorios predeterminados, se enumeran los recordatorios específicos del evento o, si no se configuraron, se indica que no hay recordatorios establecidos para este evento. La cantidad máxima de recordatorios de reemplazo es 5. admite escritura
reminders.overrides[].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
reminders.overrides[].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
reminders.useDefault boolean Indica si los recordatorios predeterminados del calendario se aplican al evento. admite escritura
sequence integer Número de secuencia según iCalendar. admite escritura
source object Es la 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 el esquema HTTP o HTTPS. Solo el creador del evento puede verla o modificarla.
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 Es la URL de la fuente que apunta a un recurso. El esquema de URL debe ser HTTP o HTTPS. admite escritura
start nested object Es la hora de inicio (inclusive) del evento. En el caso de un evento recurrente, esta es la hora de inicio de la primera instancia.
start.date date Fecha, en formato "aaaa-mm-dd", si se trata de un evento de todo el día. admite escritura
start.dateTime datetime Es la hora, como un valor combinado de fecha y hora (con formato según RFC3339). Se requiere una compensación 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. (Con el formato de un nombre de la base de datos de zonas horarias de IANA, p.ej., "Europe/Zurich"). En el caso de los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en la que se expande la recurrencia. En el caso de eventos únicos, este campo es opcional y muestra una zona horaria personalizada para el inicio y el final del evento. admite escritura
status string Es el estado del evento. Opcional. Los valores posibles son los siguientes:
  • "confirmed": Se confirmó el evento. Este es el estado predeterminado.
  • "tentative": El evento se confirmó de forma tentativa.
  • "cancelled": Se canceló (eliminó) el evento. El método list solo devuelve los eventos cancelados en la sincronización incremental (cuando se especifican syncToken o updatedMin) o si la marca showDeleted se establece en true. El método get siempre los devuelve.

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

    1. Las excepciones canceladas de un evento recurrente no cancelado indican que esta instancia ya no se debe presentar al usuario. Los clientes deben almacenar estos eventos durante el ciclo de vida del evento recurrente principal.

      Solo se garantiza que las excepciones canceladas tengan valores para 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 las copias sincronizadas de forma local. Estos eventos cancelados desaparecerán con el tiempo, por lo que no debes confiar en que estarán disponibles de forma indefinida.

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

    En el calendario del organizador, los eventos cancelados siguen exponiendo los detalles del evento (resumen, ubicación, etcétera) para que se puedan restablecer (deshacer la eliminación). Del mismo modo, los eventos a los que se invitó al usuario y que quitó manualmente siguen proporcionando detalles. Sin embargo, las solicitudes de sincronización incrementales con showDeleted establecido como falso no devolverán estos detalles.

    Si un evento cambia de organizador (por ejemplo, a través de la operación move) y el organizador original no está en la lista de asistentes, quedará un evento cancelado en el que solo se garantiza que se completará 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 los siguientes:
  • "opaque": Es el valor predeterminado. El evento bloquea tiempo en el calendario. Esto equivale a configurar Mostrarme como en Ocupado en la IU del Calendario.
  • "transparent": El evento no bloquea tiempo en el calendario. Esto equivale a configurar Mostrarme como en Disponible en la IU del Calendario.
 admite escritura
updated datetime Es la fecha y hora de la última modificación de los datos del evento principal (como una marca de tiempo RFC3339). Actualizar los recordatorios de eventos no cambiará esto. Solo lectura.
visibility string Visibilidad del evento. Opcional. Los valores posibles son los siguientes:
  • "default": Usa la visibilidad predeterminada para los eventos del calendario. Este es el valor predeterminado.
  • "public": El evento es público y todos los lectores del calendario pueden ver sus detalles.
  • "private": El evento es privado y solo los asistentes pueden ver sus detalles.
  • "confidential": El evento es privado. Este valor se proporciona por motivos de compatibilidad.
 admite escritura
workingLocationProperties nested object Son los 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 Es una etiqueta adicional opcional para brindar información adicional. admite escritura
workingLocationProperties.homeOffice any value Si está presente, especifica que el usuario está trabajando en casa. admite escritura
workingLocationProperties.officeLocation object Si está presente, especifica que el usuario trabaja desde una oficina. admite escritura
workingLocationProperties.officeLocation.buildingId string Es un identificador de compilación 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 Es un identificador de escritorio opcional. admite escritura
workingLocationProperties.officeLocation.floorId string Es un identificador de piso opcional. admite escritura
workingLocationProperties.officeLocation.floorSectionId string Es un identificador de sección de piso opcional. admite escritura
workingLocationProperties.officeLocation.label string Es el nombre de la oficina que se muestra en los clientes web y móviles de Calendar. Te recomendamos que hagas referencia al nombre de un edificio en la base de datos de recursos de la organización. admite escritura
workingLocationProperties.type string Es el tipo de ubicación de trabajo. Los valores posibles son los siguientes:
  • "homeOffice": El usuario está trabajando en casa.
  • "officeLocation": El usuario trabaja desde una oficina.
  • "customLocation": El usuario trabaja desde una ubicación personalizada.
Los detalles se especifican en un subcampo del nombre especificado, pero este campo puede faltar si está vacío. Se ignorarán los demás campos.

Se requiere cuando se agregan propiedades de ubicación de trabajo.

 admite escritura

Métodos

borrar
Borra un evento.
get
Devuelve un evento según su ID del Calendario de Google. Para recuperar un evento con su ID de iCalendar, llama al método events.list con 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 los eventos con un eventType de default.

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

insertar
Crea un evento.
instances
Devuelve instancias del evento recurrente especificado.
list
Devuelve 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 se pueden mover los eventos default; los eventos birthday, focusTime, fromGmail, outOfOffice y workingLocation no se pueden mover.
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 permanecerán sin cambios. Los campos de array, si se especifican, reemplazan los arrays existentes, lo que descarta cualquier elemento de array anterior.
quickAdd
Crea un evento basado en una cadena de texto simple.
actualizar
Actualiza un evento. Este método no admite la semántica de parches y siempre actualiza todo el recurso del evento. Para realizar una actualización parcial, ejecuta un get seguido de un update con etiquetas ETag para garantizar la atomicidad.
reloj
Presta atención a los cambios en los recursos de Events.