Events: instances

Devuelve instancias del evento recurrente especificado. Pruébalo ahora.

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta de acceso
calendarId string Es el identificador del calendario. Para recuperar los IDs de calendarios, llama al método calendarList.list. Si quieres acceder al calendario principal del usuario que accedió actualmente, usa la palabra clave "primary".
eventId string Es el identificador del evento recurrente.
Parámetros de consulta opcionales
alwaysIncludeEmail boolean Dejó de estar disponible y se ignora. Siempre se devolverá un valor en el campo email para el organizador, el creador y los asistentes, incluso si no hay una dirección de correo electrónico real disponible (es decir, se proporcionará un valor generado que no funciona).
maxAttendees integer Es la cantidad máxima de asistentes que se incluirán en la respuesta. Si hay más asistentes de los que se especificaron, solo se devolverá el participante. Opcional.
maxResults integer Es la cantidad máxima de eventos que se muestran en una página de resultados. De forma predeterminada, el valor es de 250 eventos. El tamaño de la página nunca puede ser superior a 2,500 eventos. Opcional.
originalStart string Es la hora de inicio original de la instancia en el resultado. Opcional.
pageToken string Es un token que especifica qué página de resultados se debe devolver. Opcional.
showDeleted boolean Indica si se deben incluir los eventos borrados (con status igual a "cancelled") en el resultado. Las instancias canceladas de eventos recurrentes se seguirán incluyendo si singleEvents es falso. Opcional. El valor predeterminado es False.
timeMax datetime Es el límite superior (no inclusivo) de la hora de inicio de un evento por el que se filtrará. Opcional. La configuración predeterminada es no filtrar por hora de inicio. Debe ser una marca de tiempo RFC3339 con desplazamiento de zona horaria obligatorio.
timeMin datetime Es el límite inferior (inclusive) de la hora de finalización de un evento por el que se filtrará. Opcional. La configuración predeterminada es no filtrar por hora de finalización. Debe ser una marca de tiempo RFC3339 con desplazamiento de zona horaria obligatorio.
timeZone string Zona horaria que se usa en la respuesta. Opcional. El valor predeterminado es la zona horaria del calendario.

Autorización

Esta solicitud permite la autorización con al menos uno de los siguientes alcances:

Alcance
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

Para obtener más información, consulta la página de autenticación y autorización.

Cuerpo de la solicitud

No proporciones un cuerpo de la solicitud con este método.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
Nombre de la propiedad Valor Descripción Notas
kind string Tipo de la colección ("calendar#events").
etag etag ETag de la colección.
summary string Es el título del calendario. Solo lectura.
description string Es la descripción del calendario. Solo lectura.
updated datetime Fecha y hora de la última modificación del calendario (como una marca de tiempo RFC3339). Solo lectura.
timeZone string Zona horaria del calendario Solo lectura.
accessRole string Es el rol de acceso del usuario a este calendario. Solo lectura. Los valores posibles son los siguientes:
  • "none": El usuario no tiene acceso.
  • "freeBusyReader": El usuario tiene acceso de lectura a la información de disponibilidad.
  • "reader": El usuario tiene acceso de lectura al calendario. Los eventos privados aparecerán para los usuarios con acceso de lector, pero se ocultarán los detalles del evento.
  • "writer": El usuario tiene acceso de lectura y escritura al calendario. Los eventos privados aparecerán para los usuarios con acceso de escritura, y los detalles del evento serán visibles.
  • "owner": El usuario tiene acceso de administrador al calendario. Este rol tiene todos los permisos del rol de escritor, además de la capacidad de ver y modificar los niveles de acceso de otros usuarios.

defaultReminders[] list Son los recordatorios predeterminados del calendario para el usuario autenticado. Estos recordatorios se aplican a todos los eventos de este calendario que no los anulan de forma explícita (es decir, que no tienen reminders.useDefault establecido como verdadero).
defaultReminders[].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
defaultReminders[].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
nextPageToken string Es el token que se usa para acceder a la siguiente página de este resultado. Se omite si no hay más resultados disponibles, en cuyo caso se proporciona nextSyncToken.
items[] list Es la lista de eventos del calendario.
nextSyncToken string Es el token que se usa en un momento posterior para recuperar solo las entradas que cambiaron desde que se devolvió este resultado. Se omite si hay más resultados disponibles, en cuyo caso se proporciona nextPageToken.

Pruébalo

Usa el Explorador de APIs que se encuentra a continuación para llamar a este método en datos en vivo y ver la respuesta.