Calendars

Uma coleção de todas as agendas existentes. Consulte também Calendars 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
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
Nome da propriedade Valor Descrição Observações
autoAcceptInvitations boolean Se esta agenda aceita convites automaticamente. Válido apenas para agendas de recursos.
conferenceProperties nested object Propriedades de conferência para esta agenda, por exemplo, quais tipos de conferência são permitidos.
conferenceProperties.allowedConferenceSolutionTypes[] list Os tipos de soluções de videoconferência compatíveis com esta 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").
labelProperties nested object Propriedades de marcador definidas nesta agenda. Se especificado, substitui as propriedades do rótulo atual. Se não forem especificadas, as propriedades do rótulo vão permanecer inalteradas. gravável
labelProperties.eventLabels[] list Rótulos de eventos definidos nesta agenda. Se estiver presente ao atualizar a agenda, ele vai substituir os rótulos de eventos atuais.

Estenda a lista para adicionar um novo rótulo de evento e remova entidades da lista para excluir um rótulo da agenda.

Cada agenda pode ter no máximo 200 marcadores.

 gravável
labelProperties.eventLabels[].backgroundColor string Cor de fundo do marcador em formato hexadecimal, como "#039be5". Os eventos com esse rótulo aparecem nessa cor. Obrigatório. gravável
labelProperties.eventLabels[].id string O ID do rótulo. Opcional ao inserir um novo rótulo. Se não for fornecido, um ID exclusivo será gerado. Obrigatório ao atualizar um rótulo.

Se fornecido, o ID precisa ser exclusivo na agenda e seguir o formato UUID.

 gravável
labelProperties.eventLabels[].name string Nome do rótulo. Opcional.

Se fornecido, precisa ter no máximo 50 caracteres.

 gravável
location string Localização geográfica da agenda como texto de formato 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
workingHours object Representa as informações sobre o horário de trabalho do usuário. Disponível apenas para agendas principais de usuários do Google Workspace. Para atualizar o horário de trabalho, é necessário transmitir todo o objeto de horário de trabalho. Se não for especificado (ou for transmitido como nulo ou um objeto vazio), o horário de trabalho atual não será alterado. Para desativar o horário de trabalho ou limpar a programação, defina workingHoursEnabled como falso (e omita availableTimes ou transmita uma lista vazia). gravável
workingHours.availableTimes[] list Horário de trabalho. Cada período de disponibilidade representa o bloco de horário de trabalho do usuário durante um dia. gravável
workingHours.availableTimes[].dayOfWeek string Dia da semana. Obrigatório. Os valores possíveis são:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
gravável
workingHours.availableTimes[].periodEnd integer Fim do período, em minutos a partir do início do dia, exclusivo. Obrigatório. gravável
workingHours.availableTimes[].periodStart integer Início do período, em minutos a partir do início do dia, inclusive. Obrigatório. gravável
workingHours.workingHoursEnabled boolean Se o horário de trabalho está ativado para esta agenda. Não pode ser definido como verdadeiro quando availableTimes está vazio. gravável

Métodos

clear
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 da solicitação se torna 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. Prefira usar um get seguido por um update. Os valores de campo especificados substituem os valores atuais. Os campos que você não especificar na solicitação vão permanecer inalterados. Os campos de matriz, se especificados, substituem as matrizes atuais, o que descarta todos os elementos de matriz anteriores.
transferOwnership
Transfere uma agenda secundária entre usuários em uma organização do Google Workspace. Exige a 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.