API Reference

Esta referencia de la API está organizada por tipo de recurso. Cada tipo de recurso tiene una o más representaciones de datos y uno o más métodos.

Tipos de recursos

  1. Acl
  2. CalendarList
  3. Calendarios
  4. Canales
  5. Colores
  6. Eventos
  7. Libre/ocupado
  8. Configuración

LCA

Para obtener detalles sobre los recursos de ACL, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
borrar DELETE  /calendars/calendarId/acl/ruleId Borra una regla de control de acceso.
get GET  /calendars/calendarId/acl/ruleId Muestra una regla de control de acceso.
insertar POST  /calendars/calendarId/acl Crea una regla de control de acceso.
list GET  /calendars/calendarId/acl Muestra las reglas de la lista de control de acceso del calendario.
patch PATCH  /calendars/calendarId/acl/ruleId Actualiza una regla de control de acceso. Este método es compatible con la semántica de parches. Ten en cuenta que cada solicitud de parche consume tres unidades de cuota. Te recomendamos que uses 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. Si se especifican, los campos de array reemplazan los arrays existentes, lo que descarta cualquier elemento de array anterior.
actualización PUT  /calendars/calendarId/acl/ruleId Actualiza una regla de control de acceso.
mirar POST  /calendars/calendarId/acl/watch Observa los cambios en los recursos de la LCA.

CalendarList

Para obtener detalles sobre el recurso CalendarList, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
borrar DELETE  /users/me/calendarList/calendarId Quita un calendario de la lista de calendarios del usuario.
get GET  /users/me/calendarList/calendarId Devuelve un calendario de la lista de calendarios del usuario.
insertar POST  /users/me/calendarList Inserta un calendario existente en la lista de calendarios del usuario.
list GET  /users/me/calendarList Muestra los calendarios de la lista de calendarios del usuario.
patch PATCH  /users/me/calendarList/calendarId Actualiza un calendario existente en la lista de calendarios del usuario. Este método es compatible con la semántica de parches. Ten en cuenta que cada solicitud de parche consume tres unidades de cuota. Te recomendamos que uses 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. Si se especifican, los campos de array reemplazan los arrays existentes, lo que descarta cualquier elemento de array anterior.
actualización PUT  /users/me/calendarList/calendarId Actualiza un calendario existente en la lista de calendarios del usuario.
mirar POST  /users/me/calendarList/watch Presta atención a los cambios en los recursos de CalendarList.

Calendarios

Para obtener detalles sobre los recursos de Calendario, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
sencillo POST  /calendars/calendarId/clear Borra un calendario principal. Esta operación borra todos los eventos asociados con el calendario principal de una cuenta.
borrar DELETE  /calendars/calendarId Borra un calendario secundario. Usa calendars.clear para borrar todos los eventos de los calendarios principales.
get GET  /calendars/calendarId Devuelve los metadatos de un calendario.
insertar POST  /calendars Crea un calendario secundario.
patch PATCH  /calendars/calendarId Actualiza los metadatos de un calendario. Este método es compatible con la semántica de parches. Ten en cuenta que cada solicitud de parche consume tres unidades de cuota. Te recomendamos que uses 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. Si se especifican, los campos de array reemplazan los arrays existentes, lo que descarta cualquier elemento de array anterior.
actualización PUT  /calendars/calendarId Actualiza los metadatos de un calendario.

Canales

Para obtener detalles sobre los recursos de canales, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
stop POST  /channels/stop Dejar de mirar recursos a través de este canal

Colores

Para obtener detalles sobre los recursos de colores, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
get GET  /colors Muestra las definiciones de colores para los calendarios y los eventos.

Eventos

Para obtener detalles sobre los recursos de eventos, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
borrar DELETE  /calendars/calendarId/events/eventId Borra un evento.
get GET  /calendars/calendarId/events/eventId Muestra 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 POST  /calendars/calendarId/events/import Importa un evento. Esta operación se usa para agregar una copia privada de un evento existente a un calendario. Solo se pueden importar eventos con un eventType de default.

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

insertar POST  /calendars/calendarId/events Crea un evento.
instances GET  /calendars/calendarId/events/eventId/instances Muestra instancias del evento recurrente especificado.
list GET  /calendars/calendarId/events Muestra los eventos del calendario especificado.
move POST  /calendars/calendarId/events/eventId/move 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 se pueden mover los eventos birthday, focusTime, fromGmail, outOfOffice ni workingLocation.

Parámetros de consulta obligatorios: destination

patch PATCH  /calendars/calendarId/events/eventId 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. Te recomendamos que uses 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. Si se especifican, los campos de array reemplazan los arrays existentes, lo que descarta cualquier elemento de array anterior.
quickAdd POST  /calendars/calendarId/events/quickAdd Crea un evento basado en una cadena de texto simple.

Parámetros de consulta obligatorios: text

actualización PUT  /calendars/calendarId/events/eventId Actualiza un evento. Este método no es compatible con la semántica de parches y siempre actualiza todo el recurso de evento. Para realizar una actualización parcial, realiza un get seguido de un update con etags para garantizar la atomicidad.
mirar POST  /calendars/calendarId/events/watch Presta atención a los cambios en los recursos de eventos.

Disponible/ocupado

Para obtener detalles sobre los recursos de disponibilidad libre, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
query POST  /freeBusy Devuelve información de disponibilidad para un conjunto de calendarios.

Configuración

Para obtener detalles sobre los recursos de configuración, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URIs relacionados con https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario
get GET  /users/me/settings/setting Muestra la configuración de un solo usuario.
list GET  /users/me/settings Muestra todos los parámetros de configuración del usuario autenticado.
mirar POST  /users/me/settings/watch Presta atención a los cambios en los recursos de configuración.