API Reference

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Esta referência da API está organizada por tipo de recurso. Cada tipo de recurso tem uma ou mais representações de dados e um ou mais métodos.

Tipos de recurso

  1. Acl
  2. Lista de agendas
  3. Agendas
  4. Canais
  5. Cores
  6. Eventos
  7. Disponível/ocupado
  8. Configurações

Acl

Para detalhes sobre o recurso Acl, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
delete DELETE  /calendars/calendarId/acl/ruleId Exclui uma regra de controle de acesso.
get GET  /calendars/calendarId/acl/ruleId Retorna uma regra de controle de acesso.
inserir POST  /calendars/calendarId/acl Cria uma regra de controle de acesso.
list GET  /calendars/calendarId/acl Retorna as regras na lista de controle de acesso da agenda.
patch PATCH  /calendars/calendarId/acl/ruleId Atualiza uma regra de controle de acesso. Este método oferece suporte à semântica de patches. Cada solicitação de patch consome três unidades de cota. Use uma get seguida por uma update. Os valores dos campos especificados substituem os valores existentes. Os campos que você não especificar na solicitação permanecerão inalterados. Campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta quaisquer elementos de matriz anteriores.
update PUT  /calendars/calendarId/acl/ruleId Atualiza uma regra de controle de acesso.
assistir POST  /calendars/calendarId/acl/watch Monitorar alterações nos recursos da ACL.

Lista de agendas

Para saber mais sobre o recurso CalendarList, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
delete DELETE  /users/me/calendarList/calendarId Remove uma agenda da lista de agendas do usuário.
get GET  /users/me/calendarList/calendarId Retorna uma agenda da lista de agendas do usuário.
inserir POST  /users/me/calendarList Insere uma agenda na lista de agendas do usuário.
list GET  /users/me/calendarList Retorna as agendas na lista de agendas do usuário.
patch PATCH  /users/me/calendarList/calendarId Atualiza uma agenda existente na lista de agendas do usuário. Este método oferece suporte à semântica de patches. Cada solicitação de patch consome três unidades de cota. Use uma get seguida por uma update. Os valores dos campos especificados substituem os valores existentes. Os campos que você não especificar na solicitação permanecerão inalterados. Campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta quaisquer elementos de matriz anteriores.
update PUT  /users/me/calendarList/calendarId Atualiza uma agenda existente na lista de agendas do usuário.
assistir POST  /users/me/calendarList/watch Fique de olho nas mudanças nos recursos da AgendaList.

Calendários

Para saber mais sobre o recurso Calendars, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
limpar POST  /calendars/calendarId/clear Limpa uma agenda principal. Essa operação exclui todos os eventos associados à agenda principal de uma conta.
delete DELETE  /calendars/calendarId Exclui uma agenda secundária. Use calendar.clear para limpar todos os eventos das agendas principais.
get GET  /calendars/calendarId Retorna metadados de uma agenda.
inserir POST  /calendars Cria uma agenda secundária.
patch PATCH  /calendars/calendarId Atualiza os metadados de uma agenda. Este método oferece suporte à semântica de patches. Cada solicitação de patch consome três unidades de cota. Use uma get seguida por uma update. Os valores dos campos especificados substituem os valores existentes. Os campos que você não especificar na solicitação permanecerão inalterados. Campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta quaisquer elementos de matriz anteriores.
update PUT  /calendars/calendarId Atualiza os metadados de uma agenda.

Canais

Para saber mais sobre o recurso Channels, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
parar POST  /channels/stop Parar de monitorar recursos neste canal.

Cores

Para detalhes sobre Colors, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
get GET  /colors Retorna as definições de cor para agendas e eventos.

Eventos

Para detalhes do recurso "Events", consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
delete DELETE  /calendars/calendarId/events/eventId Exclui um evento.
get GET  /calendars/calendarId/events/eventId Retorna um evento com base no ID do Google Agenda. Para recuperar um evento usando o ID do iCalendar, chame o método events.list usando o parâmetro iCalUID.
importar POST  /calendars/calendarId/events/import Importa um evento. Esta operação é usada para adicionar uma cópia particular de um evento existente a uma agenda.
inserir POST  /calendars/calendarId/events Cria um evento.
Instâncias GET  /calendars/calendarId/events/eventId/instances Retorna instâncias do evento recorrente especificado.
list GET  /calendars/calendarId/events Retorna eventos na agenda especificada.
mover POST  /calendars/calendarId/events/eventId/move Move um evento para outra agenda, ou seja, altera o organizador de um evento.

Parâmetros de consulta obrigatórios: destination

patch PATCH  /calendars/calendarId/events/eventId Atualiza um evento. Este método oferece suporte à semântica de patches. Cada solicitação de patch consome três unidades de cota. Use uma get seguida por uma update. Os valores dos campos especificados substituem os valores existentes. Os campos que você não especificar na solicitação permanecerão inalterados. Campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta quaisquer elementos de matriz anteriores.
quickAdd POST  /calendars/calendarId/events/quickAdd Cria um evento com base em uma string de texto simples.

Parâmetros de consulta obrigatórios:text

update PUT  /calendars/calendarId/events/eventId Atualiza um evento.
assistir POST  /calendars/calendarId/events/watch Fique de olho nas mudanças nos recursos de Eventos.

Disponível/ocupado

Para detalhes sobre o recurso "Disponível", consulte a página Representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
query POST  /freeBusy Retorna as informações de disponibilidade de um conjunto de agendas.

Configurações

Para saber mais sobre as configurações, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/calendar/v3, a menos que especificado de outra forma
get GET  /users/me/settings/setting Retorna uma única configuração do usuário.
list GET  /users/me/settings Retorna todas as configurações do usuário autenticado.
assistir POST  /users/me/settings/watch Fique de olho nas mudanças nos recursos de configuração.