CalendarList

A coleção de agendas na lista de agendas do usuário. 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#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "autoAcceptInvitations": boolean
}
Nome da propriedade Valor Descrição Observações
accessRole string É o papel de acesso efetivo que o usuário autenticado tem na agenda. Somente leitura. Os valores possíveis são:
  • "freeBusyReader" - Fornece acesso de leitura às informações de disponibilidade.
  • "reader" - Fornece acesso de leitura à agenda. Os eventos particulares vão aparecer para usuários com acesso de leitura, mas os detalhes do evento ficarão ocultos.
  • "writerWithoutPrivateAccess" - Fornece acesso de leitura e gravação à agenda. Os eventos particulares vão aparecer para usuários com acesso de gravação sem acesso particular, mas os detalhes do evento ficarão ocultos.
  • "writer" - Fornece acesso de leitura e gravação à agenda. Os eventos particulares vão aparecer para usuários com acesso de gravação, e os detalhes do evento ficarão visíveis.
  • "owner" - Fornece acesso de administrador à agenda. Esse papel tem todas as permissões do papel de gravação, além da capacidade de visualizar e modificar os níveis de acesso de outros usuários.

autoAcceptInvitations boolean Indica se essa agenda aceita convites automaticamente. Válido apenas para agendas de recursos. Somente leitura.
backgroundColor string É a cor principal da agenda no formato hexadecimal "#0088aa". Essa propriedade substitui a propriedade colorId baseada em índice. Para definir ou alterar essa propriedade, especifique colorRgbFormat=true nos parâmetros dos métodos de inserção, atualização e patch. Opcional. gravável
colorId string É a cor da agenda. É um ID que se refere a uma entrada na seção calendar da definição de cores (consulte o endpoint de cores). Essa propriedade é substituída pelas propriedades backgroundColor e foregroundColor e pode ser ignorada ao usar essas propriedades. Opcional. gravável
conferenceProperties nested object Propriedades de videoconferência para essa agenda, por exemplo, quais tipos de videoconferê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.
defaultReminders[] list Os lembretes padrão que o usuário autenticado tem para essa agenda. gravável
defaultReminders[].method string O método usado por esse lembrete. Os valores possíveis são:
  • "email" - Os lembretes são enviados por e-mail.
  • "popup" - Os lembretes são enviados por um pop-up da interface.

Necessário ao adicionar um lembrete.

 gravável
defaultReminders[].minutes integer Número de minutos antes do início do evento em que o lembrete deve ser acionado. Os valores válidos estão entre 0 e 40320 (4 semanas em minutos).

Necessário ao adicionar um lembrete.

 gravável
deleted boolean Indica se essa entrada da lista de agendas foi excluída da lista. Somente leitura. Opcional. O valor padrão é falso.
description string Descrição da agenda. Opcional. Somente leitura.
etag etag É a ETag do recurso.
foregroundColor string É a cor de primeiro plano da agenda no formato hexadecimal "#ffffff". Essa propriedade substitui a propriedade colorId baseada em índice. Para definir ou alterar essa propriedade, especifique colorRgbFormat=true nos parâmetros dos métodos de inserção, atualização e patch. Opcional. gravável
hidden boolean Indica se a agenda foi ocultada da lista. Opcional. O atributo só é retornado quando a agenda está oculta. Nesse caso, o valor é true. gravável
id string Identificador da agenda.
kind string Tipo do recurso ("calendar#calendarListEntry").
location string Localização geográfica da agenda como texto de formato livre. Opcional. Somente leitura.
notificationSettings object As notificações que o usuário autenticado está recebendo para essa agenda. gravável
notificationSettings.notifications[] list A lista de notificações definidas para essa agenda.
notificationSettings.notifications[].method string O método usado para entregar a notificação. O valor possível é:
  • "email" - As notificações são enviadas por e-mail.

Necessário ao adicionar uma notificação.

 gravável
notificationSettings.notifications[].type string O tipo de notificação. Os valores possíveis são:
  • "eventCreation" - Notificação enviada quando um novo evento é colocado na agenda.
  • "eventChange" - Notificação enviada quando um evento é alterado.
  • "eventCancellation" - Notificação enviada quando um evento é cancelado.
  • eventResponse - Notificação enviada quando um convidado responde ao convite do evento.
  • "agenda" - Uma agenda com os eventos do dia (enviada pela manhã).

Necessário ao adicionar uma notificação.

 gravável
primary boolean Indica se a agenda é a principal do usuário autenticado. Somente leitura. Opcional. O valor padrão é falso.
selected boolean Indica se o conteúdo da agenda aparece na interface. Opcional. O valor padrão é falso. gravável
summary string Título da agenda. Somente leitura.
summaryOverride string O resumo que o usuário autenticado definiu para essa agenda. Opcional. gravável
timeZone string O fuso horário da agenda. Opcional. Somente leitura.

Métodos

delete
Remove uma agenda da lista de agendas do usuário.
get
Retorna uma agenda da lista de agendas do usuário.
inserir
Insere uma agenda na lista de agendas do usuário.
list
Retorna as agendas na lista de agendas do usuário.
patch
Atualiza uma agenda na lista de agendas do usuário. Esse método é compatível com a semântica de patch. Cada solicitação de patch consome três unidades de cota. É melhor 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.
update
Atualiza uma agenda na lista de agendas do usuário.
watch
Monitora as mudanças nos recursos do CalendarList.