Se usó la API de Cloud Translation para traducir esta página.

Events: list

Devuelve los eventos del calendario especificado. Pruébalo ahora.

Solicitud

Solicitud HTTP

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

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`".
Parámetros de consulta opcionales
`alwaysIncludeEmail`	`boolean`	Dejó de estar disponible y se ignora.
`eventTypes`	`string`	Son los tipos de eventos que se mostrarán. Opcional. Este parámetro se puede repetir varias veces para devolver eventos de diferentes tipos. Si no se configura, se devuelven todos los tipos de eventos. Los valores aceptables son los siguientes: "`birthday`": Eventos especiales de todo el día con recurrencia anual. "`default`": Eventos periódicos. "`focusTime`": Eventos de tiempo dedicado. "`fromGmail`": Eventos de Gmail. "`outOfOffice`": Eventos fuera de la oficina. "`workingLocation`": Eventos de ubicación de trabajo.
`iCalUID`	`string`	Especifica un ID de evento en formato iCalendar que se proporcionará en la respuesta. Opcional. Usa este parámetro si quieres buscar un evento por su ID de iCalendar.
`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. La cantidad de eventos en la página resultante puede ser menor que este valor, o no haber ninguno, incluso si hay más eventos que coinciden con la búsqueda. Las páginas incompletas se pueden detectar con un campo `nextPageToken` no vacío en la respuesta. 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.
`orderBy`	`string`	Es el orden de los eventos que se muestran en el resultado. Opcional. El valor predeterminado es un orden estable no especificado. Los valores aceptables son los siguientes: "`startTime`": Ordena por fecha y hora de inicio (ascendente). Solo está disponible cuando se consultan eventos individuales (es decir, el parámetro `singleEvents` es verdadero). "`updated`": Ordenar por hora de la última modificación (ascendente).
`pageToken`	`string`	Es un token que especifica qué página de resultados se debe devolver. Opcional.
`privateExtendedProperty`	`string`	Restricción de propiedades extendidas especificada como propertyName=value. Solo coincide con las propiedades privadas. Este parámetro se puede repetir varias veces para devolver eventos que coincidan con todas las restricciones proporcionadas.
`q`	`string`	Términos de búsqueda de texto libre para encontrar eventos que coincidan con estos términos en los siguientes campos: `summary` `description` `location` `displayName` del asistente `email` del asistente `displayName` del organizador `email` del organizador `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` Estos términos de búsqueda también coinciden con las palabras clave predefinidas en todas las traducciones del título visible de los eventos de ubicación de trabajo, fuera de la oficina y tiempo de concentración. Por ejemplo, si buscas "Oficina" o "Oficina", se mostrarán eventos de ubicación de trabajo de tipo `officeLocation`, mientras que si buscas "Fuera de la oficina" o "Abwesend", se mostrarán eventos de fuera de la oficina. Opcional.
`sharedExtendedProperty`	`string`	Restricción de propiedades extendidas especificada como propertyName=value. Solo coincide con las propiedades compartidas. Este parámetro se puede repetir varias veces para devolver eventos que coincidan con todas las restricciones proporcionadas.
`showDeleted`	`boolean`	Indica si se deben incluir los eventos borrados (con `status` igual a "`cancelled`") en el resultado. Las instancias canceladas de eventos recurrentes (pero no el evento recurrente subyacente) se seguirán incluyendo si `showDeleted` y `singleEvents` son False. Si `showDeleted` y `singleEvents` son verdaderos, solo se devuelven instancias únicas de eventos borrados (pero no los eventos recurrentes subyacentes). Opcional. El valor predeterminado es False.
`showHiddenInvitations`	`boolean`	Indica si se deben incluir las invitaciones ocultas en el resultado. Opcional. El valor predeterminado es False.
`singleEvents`	`boolean`	Indica si se deben expandir los eventos recurrentes en instancias y solo devolver eventos únicos y las instancias de eventos recurrentes, pero no los eventos recurrentes subyacentes. Opcional. El valor predeterminado es False.
`syncToken`	`string`	Es el token que se obtuvo del campo `nextSyncToken` que se devolvió en la última página de resultados de la solicitud de lista anterior. Hace que el resultado de esta solicitud de lista contenga solo las entradas que cambiaron desde entonces. Todos los eventos borrados desde la solicitud de lista anterior siempre estarán en el conjunto de resultados, y no se permite establecer `showDeleted` como falso. Hay varios parámetros de consulta que no se pueden especificar junto con `nextSyncToken` para garantizar la coherencia del estado del cliente. Estas son: `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` Todos los demás parámetros de consulta deben ser los mismos que para la sincronización inicial para evitar un comportamiento indefinido. Si vence el `syncToken`, el servidor responderá con un código de respuesta 410 GONE y el cliente deberá borrar su almacenamiento y realizar una sincronización completa sin ningún `syncToken`. Obtén más información sobre la sincronización incremental. Opcional. La opción predeterminada es devolver todas las entradas.
`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 un desplazamiento de zona horaria obligatorio, por ejemplo, 2011-06-03T10:00:00-07:00 o 2011-06-03T10:00:00Z. Se pueden proporcionar milisegundos, pero se ignorarán. Si se establece `timeMin`, `timeMax` debe ser mayor que `timeMin`.
`timeMin`	`datetime`	Es el límite inferior (no incluido) 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 un desplazamiento de zona horaria obligatorio, por ejemplo, 2011-06-03T10:00:00-07:00 o 2011-06-03T10:00:00Z. Se pueden proporcionar milisegundos, pero se ignorarán. Si se establece `timeMax`, `timeMin` debe ser menor que `timeMax`.
`timeZone`	`string`	Zona horaria que se usa en la respuesta. Opcional. El valor predeterminado es la zona horaria del calendario.
`updatedMin`	`datetime`	Es el límite inferior de la hora de la última modificación de un evento (como una marca de tiempo RFC3339) por la que se filtrará. Cuando se especifica, las entradas borradas desde este momento siempre se incluirán, independientemente de `showDeleted`. Opcional. El valor predeterminado es no filtrar por hora de última modificación.

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. Importante: El rol de `owner` es diferente del propietario de los datos del calendario. Un calendario tiene un solo propietario de los datos, pero puede tener varios usuarios con el rol de `owner`.
`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.