Events

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

Para ver una lista de métodos para 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
    }
  ],
  "eventType": string
}
Nombre de la propiedad Valor Descripción Notas
anyoneCanAddSelf boolean Indica si alguien puede invitarse a sí mismo al evento (obsoleto). Opcional. El valor predeterminado es False. admite escritura
attachments[] list Archivos adjuntos para el evento

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

Puede haber un máximo de 25 archivos adjuntos por evento,

attachments[].fileId string ID del archivo adjunto. Solo lectura.

Para archivos de Google Drive, es el ID de la entrada del recurso Files correspondiente en la API de Drive.

attachments[].fileUrl string vínculo de 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.

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 los asistentes se pueden haber omitido de 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, esto solo se puede usar para actualizar la respuesta del participante. Opcional. El valor predeterminado es False. admite escritura
attendees[] list Los asistentes del evento. Consulta la guía Eventos con asistentes para obtener más información sobre cómo programar eventos con otros usuarios de 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 invitados adicionales Opcional. El valor predeterminado es 0. admite escritura
attendees[].comment string Comentario en la respuesta del asistente. Opcional. admite escritura
attendees[].displayName string Nombre del asistente, si está disponible. Opcional. admite escritura
attendees[].email string La dirección de correo electrónico del asistente, si está disponible Este campo debe estar presente cuando se agregue un asistente. Debe ser una dirección de correo electrónico válida según RFC5322.

Obligatorio cuando se agrega 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 Si el asistente es un recurso Solo se puede establecer cuando el asistente se agrega al evento por primera vez. Se ignorarán las modificaciones posteriores. 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 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 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 El ID de la conferencia.

Los desarrolladores pueden utilizarlo para hacer un seguimiento de las conferencias; no se debe mostrar a los usuarios.

El valor de ID tiene un formato diferente para cada tipo de solución de conferencia:

  • eventHangout: No se estableció el ID. (Este tipo de conferencia dejó de estar disponible).
  • eventNamedHangout: El ID es el nombre del Hangout. (Este tipo de conferencia dejó de estar disponible).
  • hangoutsMeet: El ID corresponde al 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 se estableció para una conferencia con una solicitud de creación con errores.

Se requieren conferenceSolution y, al menos, un entryPoint o createRequest.

conferenceData.conferenceSolution.iconUri string El ícono visible para el usuario de esta solución.
conferenceData.conferenceSolution.key nested object La clave que puede identificar de manera única la solución de conferencia para este evento.
conferenceData.conferenceSolution.key.type string El tipo de solución de conferencia

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

Los siguientes son los valores posibles:

  • "eventHangout" para Hangouts para consumidores (obsoleto; los eventos existentes pueden mostrar este tipo de solución de conferencia, pero no se pueden crear conferencias nuevas)
  • "eventNamedHangout" para los usuarios de la versión clásica de Hangouts para los 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. Sin localizar.
conferenceData.createRequest nested object 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, verifica el campo status.

Se requieren conferenceSolution y, al menos, un entryPoint o createRequest.

conferenceData.createRequest.conferenceSolutionKey nested object La solución de conferencia, como Hangouts o Google Meet
conferenceData.createRequest.conferenceSolutionKey.type string El tipo de solución de conferencia

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

Los siguientes son los valores posibles:

  • "eventHangout" para Hangouts para consumidores (obsoleto; los eventos existentes pueden mostrar este tipo de solución de conferencia, pero no se pueden crear conferencias nuevas)
  • "eventNamedHangout" para los usuarios de la versión clásica de Hangouts para los 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 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 igual que el de la solicitud anterior, se ignorará la solicitud.

conferenceData.createRequest.status nested object El estado de la solicitud para crear la conferencia
conferenceData.createRequest.status.statusCode string El estado actual de la solicitud para crear la conferencia Solo lectura.

Los siguientes son los valores posibles:

  • "pending": La solicitud para crear la conferencia aún se está procesando.
  • "success": La solicitud de creación de la conferencia se completó correctamente; los puntos de entrada se propagan.
  • "failure": Falló la solicitud de creación de la conferencia, ya que no hay puntos de entrada.

conferenceData.entryPoints[] list Incluye información sobre los puntos de entrada individuales a la conferencia, como URLs o números de teléfono.

Todos deben pertenecer a la misma conferencia.

Se requieren conferenceSolution y, al menos, un entryPoint o 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 datos de conferencias nuevos, propaga solo el subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que coincidan con la terminología que utiliza el proveedor de conferencias. Solo se deben mostrar los campos propagados.

Opcional.

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

Los valores posibles son:

  • "video": Se une a una conferencia a través de HTTP. Una conferencia puede tener un punto de entrada de video o cero.
  • "phone": Marca un número de teléfono para unirte a una conferencia. Una conferencia puede tener cero o más puntos de entrada de phone.
  • "sip": Te permite unirte a una conferencia a través de SIP. Una conferencia puede tener un punto de entrada de sip o cero.
  • "more": Son instrucciones adicionales para unirse a la conferencia, como números de teléfono adicionales. Una conferencia puede tener un punto de entrada de more o cero. Una conferencia con solo un punto de entrada de more no es válida.

conferenceData.entryPoints[].label string Es la etiqueta del URI. Visible para los usuarios finales Sin localizar. 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 datos de conferencias nuevos, propaga solo el subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que coincidan con la terminología que utiliza el proveedor de conferencias. Solo se deben mostrar los campos propagados.

Opcional.

conferenceData.entryPoints[].passcode string La contraseña para acceder a la conferencia. La longitud máxima es de 128 caracteres.

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

conferenceData.entryPoints[].password string La contraseña para acceder a la conferencia. La longitud máxima es de 128 caracteres.

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

Opcional.

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

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

Opcional.

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

Formato:

  • se requiere el esquema de 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.
  • se requiere el esquema de more, http: o https:.

conferenceData.notes string Notas adicionales (como instrucciones del administrador del dominio o avisos legales) para mostrar 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 del servidor.

No se estableció para una conferencia con una solicitud de creación con errores.

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 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 El 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 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 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 combinado de fecha y hora (con el formato RFC3339) El desfase de zona horaria es obligatorio, a menos que se especifique una zona horaria de forma explícita en timeZone. admite escritura
end.timeZone string La zona horaria en la que se especifica el horario. (tiene el formato del nombre de la base de datos de zonas horarias de IANA, p.ej., “Europe/Zurich”). Para los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en que se expande la recurrencia. En el caso de 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 en realidad no se especifica Por motivos de compatibilidad, se proporciona una hora de finalización, 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. No se puede modificar después de crear el evento. Los valores posibles son:
  • "default": Es un evento normal o no especificado.
  • "outOfOffice": Un evento fuera de la oficina.
  • "focusTime": Es un evento de tiempo dedicado.
  • "workingLocation": Un evento de ubicación de trabajo.
Actualmente, solo se pueden crear eventos "default " y "workingLocation" con la API. La compatibilidad ampliada con otros tipos de eventos estará disponible en versiones posteriores.
admite escritura
extendedProperties object Propiedades extendidas del evento.
extendedProperties.private object Las 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 su valor correspondiente
extendedProperties.shared object Propiedades que se comparten entre las 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 Indica 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 una reunión; declineAllConflictingInvitations, que significa que se rechazan todas las invitaciones a reuniones en conflicto que entren en conflicto con el evento; y declineOnlyNewConflictingInvitations, que solo se rechazan las nuevas invitaciones a reuniones en conflicto que lleguen mientras esté presente el evento de tiempo dedicado.
focusTimeProperties.chatStatus string Es el estado en el que se marca al usuario en Chat y productos relacionados. Puede ser available o doNotDisturb.
focusTimeProperties.declineMessage string Mensaje de respuesta para establecer si Calendario rechaza automáticamente un evento existente o una invitación nueva.
gadget object Un gadget que amplía el evento. Los gadgets dejaron de estar disponibles. Esta estructura solo se utiliza para mostrar metadatos de calendario de cumpleaños.
gadget.display string 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 del 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 la preferencia y su 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 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 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 son 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, como se define en RFC5545. Se utiliza para identificar eventos de manera única en 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 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 mediante su iCalUID, llama al método events.list con el parámetro iCalUID. Para recuperar un evento mediante su id, llama al método events.get.

id string Identificador opaco del evento Cuando creas eventos nuevos únicos o recurrentes, puedes especificar sus ID. Los IDs proporcionados deben seguir estas reglas:
  • los caracteres permitidos en el ID son los que se utilizan en la codificación base32hex, es decir, las letras minúsculas a-v y los dígitos del 0 al 9; consulta la sección 3.1.2 de RFC2938
  • el ID debe tener entre 5 y 1,024 caracteres
  • el ID debe ser único en cada calendario
Debido a la naturaleza global del sistema, no podemos garantizar que se detecten colisiones de IDs 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, 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 sin formato. Opcional. admite escritura
locked boolean Indica si es una copia del evento bloqueado en la que no se pueden realizar cambios en los campos principales del evento “resumen”, “descripción”, “ubicación”, “inicio”, “finalización” o “recurrencia”. 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 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 Es la 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 El 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, se trata del momento en el que comenzará el evento según los datos de recurrencia del evento recurrente identificado pornasEventId. Identifica de manera única la instancia dentro de la serie de eventos recurrentes, incluso si la instancia se movió a una hora diferente. Inmutable.
originalStartTime.date date 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 combinado de fecha y hora (con el formato RFC3339) El desfase de zona horaria es obligatorio, a menos que se especifique una zona horaria de forma explícita en timeZone. admite escritura
originalStartTime.timeZone string La zona horaria en la que se especifica el horario. (tiene el formato del nombre de la base de datos de zonas horarias de IANA, p.ej., “Europe/Zurich”). Para los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en que se expande la recurrencia. En el caso de 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 una reunión; declineAllConflictingInvitations, que significa que se rechazan todas las invitaciones a reuniones en conflicto que entren en conflicto con el evento; y declineOnlyNewConflictingInvitations, que solo se rechazan 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 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 evento privado. 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 una instancia de un evento recurrente, este es el valor de id del evento recurrente al que pertenece esa instancia. Inmutable.
reminders object Información sobre los recordatorios del evento para el usuario autenticado.
reminders.overrides[] list Si el evento no utiliza los recordatorios predeterminados, se muestran los recordatorios específicos del evento o, si no se establecen, se indican que no hay recordatorios establecidos para ese evento. La cantidad máxima de recordatorios de anulación es 5. admite escritura
reminders.overrides[].method string Es 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 al agregar 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 se encuentran entre 0 y 40,320 (4 semanas en minutos).

Obligatorio al agregar un recordatorio.

admite escritura
reminders.useDefault boolean 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 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 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 La hora de inicio (incluida) del evento En el caso de un evento recurrente, esta es la hora de inicio de la primera instancia.
start.date date 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 combinado de fecha y hora (con el formato RFC3339) El desfase de zona horaria es obligatorio, a menos que se especifique una zona horaria de forma explícita en timeZone. admite escritura
start.timeZone string La zona horaria en la que se especifica el horario. (tiene el formato del nombre de la base de datos de zonas horarias de IANA, p.ej., “Europe/Zurich”). Para los eventos recurrentes, este campo es obligatorio y especifica la zona horaria en que se expande la recurrencia. En el caso de 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 (borrado). El método list muestra eventos cancelados solo en la sincronización incremental (cuando se especifica syncToken o updatedMin) o si la marca showDeleted se establece en true. El método get siempre los 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 recurrente principal.

      Solo se garantiza que las excepciones canceladas tengan completados 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 las copias sincronizadas de forma local. Esos eventos cancelados desaparecerán con el tiempo, así que no confíes en 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 (recuperar). Del mismo modo, los eventos a los que se invitó al usuario y que este quitó manualmente siguen brindando detalles. Sin embargo, las solicitudes de sincronización incremental con showDeleted establecido en falso no mostrarán estos detalles.

    Si un evento cambia de su organizador (por ejemplo, mediante la operación move) y el organizador original no está en la lista de asistentes, dejará un evento cancelado, en el que solo se garantiza que se propagará 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. El evento sí asigna un horario en el calendario. Esto equivale a configurar Show me as como Busy en la IU del calendario.
  • "transparent": El evento no bloquea la hora del calendario. Esto equivale a configurar Mostrar como en Disponible en la IU del Calendario.
admite escritura
updated datetime Hora de la última modificación del evento (como una marca de tiempo RFC3339) Solo lectura.
visibility string Visibilidad del evento Opcional. Los valores posibles son:
  • "default": Usa la visibilidad predeterminada para los eventos del calendario. Este es el valor predeterminado.
  • "public": El evento es público y los detalles del evento son visibles para todos los lectores del calendario.
  • "private": El evento es privado y solo los asistentes pueden ver los detalles del evento.
  • "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 en casa. admite escritura
workingLocationProperties.officeLocation object Si está presente, especifica que el usuario está trabajando en una oficina. admite escritura
workingLocationProperties.officeLocation.buildingId string Es 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 para la Web y dispositivos móviles. 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:
  • "homeOffice": El usuario está trabajando en su casa.
  • "officeLocation": El usuario está trabajando en 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.

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 de su ID del Calendario de Google. Para recuperar un evento con su ID de iCalendar, llama al método eventos.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.
insertar
Crea un evento.
instancias
Muestra instancias del evento recurrente especificado.
list
Muestra eventos en el 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, no los eventos outOfOffice, focusTime y workingLocation.
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 get seguido de 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 de array anterior.
quickAdd
Crea un evento basado en una cadena de texto simple.
actualizar
Actualiza un evento. Este método no admite semánticas de parches y siempre actualiza todo el recurso del evento. Para realizar una actualización parcial, realiza un get seguido de una update con ETag para garantizar la atomicidad.
reloj
Presta atención a los cambios en los recursos de Eventos.