Calendars

Uma coleção de todas as agendas existentes. Consulte também Agendas x CalendarList.

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "autoAcceptInvitations": boolean
}
Nome da propriedade Valor Descrição Observações
autoAcceptInvitations boolean Indica se essa agenda aceita convites automaticamente. Válido apenas para agendas de recursos.
conferenceProperties nested object Propriedades de videoconferência dessa agenda, por exemplo, quais tipos de conferências são permitidos.
conferenceProperties.allowedConferenceSolutionTypes[] list Os tipos de soluções de conferência compatíveis com essa agenda.

Os valores possíveis são:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcional.
dataOwner string O e-mail do proprietário da agenda. Definido apenas para agendas secundárias. Somente leitura.
description string Descrição da agenda. Opcional. gravável
etag etag ETag do recurso.
id string Identificador da agenda. Para recuperar IDs, chame o método calendarList.list().
kind string Tipo do recurso ("calendar#calendar").
location string Localização geográfica da agenda como texto livre. Opcional. gravável
summary string Título da agenda. gravável
timeZone string O fuso horário da agenda. (Formatado como um nome do banco de dados de fusos horários da IANA, por exemplo, "Europe/Zurich".) Opcional. gravável

Métodos

limpar
Limpa uma agenda principal. Essa operação exclui todos os eventos associados à agenda principal de uma conta.
delete
Exclui uma agenda secundária. Use calendars.clear para limpar todos os eventos nas agendas principais.
get
Retorna metadados de uma agenda.
inserir
Cria uma agenda secundária.

O usuário autenticado para a solicitação é o proprietário dos dados da nova agenda.

patch
Atualiza os metadados de uma agenda. Esse método é compatível com a semântica de patch. Cada solicitação de patch consome três unidades de cota. É preferível usar um get seguido de um update. Os valores de campo especificados substituem os valores atuais. Os campos não especificados na solicitação permanecem inalterados. Os campos de matriz, se especificados, substituem as matrizes atuais. Isso descarta todos os elementos de matriz anteriores.
transferOwnership
Transfere uma agenda secundária entre usuários em uma organização do Google Workspace. Requer autenticação do usuário com o privilégio de administrador "Gerenciar agendas" e um dos seguintes escopos de autorização:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
Na solicitação, defina useAdminAccess como true. A agenda secundária precisa estar ativa para ser transferida. Não é possível transferir agendas desativadas ou excluídas.
update
Atualiza os metadados de uma agenda.