API Reference

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. CalendarList
  3. Agendas
  4. Canais
  5. Cores
  6. Eventos
  7. Disponível/ocupado
  8. Configurações

Acl

Para saber mais 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, salvo indicação em contrário
excluir 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. Observe que cada solicitação de patch consome três unidades de cota. Prefira usar um get seguido por um update. Os valores de campo especificados substituem os atuais. Os campos não especificados na solicitação permanecem inalterados. Os campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta todos os elementos anteriores da matriz.
update PUT  /calendars/calendarId/acl/ruleId Atualiza uma regra de controle de acesso.
relógio POST  /calendars/calendarId/acl/watch Fique atento a alterações nos recursos da ACL.

CalendarList

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, salvo indicação em contrário
excluir 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 existente 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 na lista de agendas do usuário. Este método oferece suporte à semântica de patches. Observe que cada solicitação de patch consome três unidades de cota. Prefira usar um get seguido por um update. Os valores de campo especificados substituem os atuais. Os campos não especificados na solicitação permanecem inalterados. Os campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta todos os elementos anteriores da matriz.
update PUT  /users/me/calendarList/calendarId Atualiza uma agenda na lista de agendas do usuário.
relógio POST  /users/me/calendarList/watch Fique atento a alterações 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, salvo indicação em contrário
limpar POST  /calendars/calendarId/clear Apaga uma agenda principal. Esta operação exclui todos os eventos associados à agenda principal de uma conta.
excluir DELETE  /calendars/calendarId Exclui uma agenda secundária. Use calendar.clear para limpar todos os eventos nas 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. Observe que cada solicitação de patch consome três unidades de cota. Prefira usar um get seguido por um update. Os valores de campo especificados substituem os atuais. Os campos não especificados na solicitação permanecem inalterados. Os campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta todos os elementos anteriores da matriz.
update PUT  /calendars/calendarId Atualiza os metadados de uma agenda.

Canais

Para detalhes 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, salvo indicação em contrário
parar POST  /channels/stop Parar de assistir recursos por este canal.

Cores

Para saber mais sobre o recurso 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, salvo indicação em contrário
get GET  /colors Retorna definições de cores para agendas e eventos.

Eventos

Para saber mais sobre o recurso Events, 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, salvo indicação em contrário
excluir 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.
import POST  /calendars/calendarId/events/import Importa um evento. Essa operação é usada para adicionar uma cópia privada de um evento a uma agenda. Apenas eventos com eventType de default podem ser importados.

Comportamento descontinuado:se um evento não default for importado, o tipo dele vai ser alterado para default, e todas as propriedades específicas do tipo de evento serão descartadas.
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. Apenas eventos default podem ser movidos; eventos outOfOffice, focusTime, workingLocation e fromGmail não podem ser movidos.

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. Observe que cada solicitação de patch consome três unidades de cota. Prefira usar um get seguido por um update. Os valores de campo especificados substituem os atuais. Os campos não especificados na solicitação permanecem inalterados. Os campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta todos os elementos anteriores da matriz.
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. Esse método não é compatível com a semântica de patch e sempre atualiza todo o recurso do evento. Para fazer uma atualização parcial, execute uma get seguida por uma update usando etags para garantir a atomicidade.
relógio POST  /calendars/calendarId/events/watch Fique atento às mudanças nos recursos de Eventos.

Disponível/ocupado

Para obter detalhes sobre o recurso Disponívelocupado, 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, salvo indicação em contrário
query POST  /freeBusy Retorna as informações de disponibilidade de um conjunto de agendas.

Configurações

Para saber mais sobre o recurso Settings, 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, salvo indicação em contrário
get GET  /users/me/settings/setting Retorna uma única configuração de usuário.
list GET  /users/me/settings Retorna todas as configurações do usuário autenticado.
relógio POST  /users/me/settings/watch Fique atento às mudanças nos recursos de configurações.