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. Freebusy
  8. Configuración

LCA

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

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 Devuelve 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 usar 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. Los campos de array, si se especifican, reemplazan los arrays existentes, lo que 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 Observa los cambios en los recursos de LCA.

CalendarList

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

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 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 usar 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. Los campos de array, si se especifican, reemplazan los arrays existentes, lo que 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 los cambios en los recursos de CalendarList.

Calendarios

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

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 al 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.

El usuario autenticado para la solicitud se convierte en propietario de los datos del calendario nuevo.

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 usar 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. Los campos de array, si se especifican, reemplazan los arrays existentes, lo que descarta cualquier elemento de array anterior.
actualizar PUT  /calendars/calendarId Actualiza los metadatos de un calendario.

Canales

Para obtener detalles sobre el recurso Channels, consulta la página de representación del recurso.

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 el recurso Colors, consulta la página de representación de recursos.

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

Eventos

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

Método Solicitud HTTP Descripción
Los URIs son relativos a 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 Devuelve 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 los eventos con un eventType de default.

Comportamiento desaprobado: Si se importa un evento que no es de tipo default, su tipo 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 Devuelve instancias del evento recurrente especificado.
list GET  /calendars/calendarId/events Devuelve los eventos del calendario especificado.
mover POST  /calendars/calendarId/events/eventId/move Transfiere un evento a otro calendario, es decir, cambia el organizador del evento. Ten en cuenta que solo se pueden mover los eventos default; los eventos birthday, focusTime, fromGmail, outOfOffice y workingLocation no se pueden mover.

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 usar 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. Los campos de array, si se especifican, 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

actualizar PUT  /calendars/calendarId/events/eventId Actualiza un evento. Este método no admite la semántica de parches y siempre actualiza todo el recurso del evento. Para realizar una actualización parcial, ejecuta un get seguido de un update con etiquetas ETag para garantizar la atomicidad.
reloj POST  /calendars/calendarId/events/watch Observa los cambios en los recursos de Events.

Disponible/ocupado

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

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

Configuración

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

Método Solicitud HTTP Descripción
Los URIs son relativos a https://www.googleapis.com/calendar/v3, a menos que se indique lo contrario.
get GET  /users/me/settings/setting Devuelve un solo parámetro de configuración del usuario.
list GET  /users/me/settings Devuelve todos los parámetros de configuración del usuario autenticado.
reloj POST  /users/me/settings/watch Observa los cambios en los recursos de configuración.