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. LCA
  2. CalendarList
  3. Calendarios
  4. Canales
  5. Colores
  6. Eventos
  7. Disponible/ocupado
  8. Configuración

Acl

Para obtener más detalles sobre los recursos de LCA, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI 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 Devuelve 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. Es preferible 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 no se modificarán. Si se especifican, los campos de array reemplazan los arrays existentes. Esto descarta cualquier elemento de array anterior.
actualizar PUT  /calendars/calendarId/acl/ruleId Actualiza una regla de control de acceso.
reloj POST  /calendars/calendarId/acl/watch Busca cambios en los recursos de LCA.

CalendarList

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

Método Solicitud HTTP Descripción
URI 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 Muestra 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 Devuelve 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. Es preferible 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 no se modificarán. Si se especifican, los campos de array reemplazan los arrays existentes. Esto descarta cualquier elemento de array anterior.
actualizar PUT  /users/me/calendarList/calendarId Actualiza un calendario existente en la lista de calendarios del usuario.
reloj POST  /users/me/calendarList/watch Observa si hay cambios en los recursos CalendarList.

Calendarios

Para obtener más información sobre los recursos de calendarios, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI 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 calendares.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. Es preferible 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 no se modificarán. Si se especifican, los campos de array reemplazan los arrays existentes. Esto descarta cualquier elemento de array anterior.
actualizar PUT  /calendars/calendarId Actualiza los metadatos de un calendario.

Canales

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

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

Colores

Para obtener más información sobre los recursos de colores, consulta la página de representación de recursos.

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

Eventos

Para obtener más información sobre los recursos de eventos, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI 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 de Calendario de Google. Para recuperar un evento con su ID de iCalendar, llama al métodoevents.list con el parámetro iCalUID.
import POST  /calendars/calendarId/events/import Importa un evento. Esta operación permite agregar una copia privada de un evento existente a un calendario. Solo se pueden importar los eventos con un eventType de default.

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

insertar POST  /calendars/calendarId/events Crea un evento.
instancias GET  /calendars/calendarId/events/eventId/instances Muestra instancias del evento recurrente especificado.
list GET  /calendars/calendarId/events Devuelve eventos en el calendario especificado.
mover 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 outOfOffice, focusTime y 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. Es preferible 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 no se modificarán. Si se especifican, los campos de array reemplazan los arrays existentes. Esto descarta cualquier elemento de array anterior.
quickAdd POST  /calendars/calendarId/events/quickAdd Crea un evento a partir de una cadena de texto simple.

Parámetros de consulta obligatorios: text

actualizar PUT  /calendars/calendarId/events/eventId 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 un update con ETag para garantizar la atomicidad.
reloj POST  /calendars/calendarId/events/watch Presta atención a los cambios en los recursos de Eventos.

Disponible/ocupado

Para obtener más detalles sobre los recursos Freebusy, consulta la página de representación de recursos.

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

Configuración

Para obtener más detalles sobre el recurso de configuración, consulta la página de representación de recursos.

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