CalendarList

O conjunto de agendas na lista de agendas do usuário. Consulte também Agendas x AgendaList.

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,
  "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
    ]
  }
}
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" - Dá acesso de leitura às informações de disponibilidade.
  • "reader" - Dá acesso de leitura à agenda. Os eventos particulares vão aparecer para os usuários com acesso de leitura, mas os detalhes deles vão ficar ocultos.
  • "writer" - Dá acesso de leitura e gravação à agenda. Os eventos particulares serão exibidos para os usuários com acesso de gravador, e os detalhes dos eventos ficarão visíveis.
  • "owner" - Fornece a propriedade da agenda. Esse papel tem todas as permissões da função de gravador, com a capacidade adicional de ver e manipular ACLs.
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, é necessário especificar colorRgbFormat=true nos parâmetros dos métodos insert, update e patch. Opcional. gravável
colorId string A cor da agenda. Esse é um ID que se refere a uma entrada na seção calendar da definição de cores (consulte o endpoint de cores). Essa propriedade foi substituída pelas propriedades backgroundColor e foregroundColor e pode ser ignorada ao usar essas propriedades. Opcional. gravável
conferenceProperties nested object Propriedades de conferência desta 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 esta agenda.

Os valores possíveis são:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcional.
defaultReminders[] list Os lembretes padrão para esta agenda que o usuário autenticado tem. gravável
defaultReminders[].method string O método usado pelo lembrete. Os valores possíveis são:
  • "email" - Os lembretes são enviados por e-mail.
  • "popup" - Os lembretes são enviados por uma janela pop-up na interface.

Obrigatório ao adicionar um lembrete.

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

Obrigatório ao adicionar um lembrete.

 gravável
deleted boolean Indica se esta entrada da lista de agendas foi excluída da lista de agendas. Somente leitura. Opcional. O valor padrão é falso.
description string Descrição da agenda. Opcional. Somente leitura.
etag etag ETag do recurso.
foregroundColor string A cor do primeiro plano da agenda no formato hexadecimal "#ffffff". Essa propriedade substitui a propriedade colorId baseada em índice. Para definir ou alterar essa propriedade, é necessário especificar colorRgbFormat=true nos parâmetros dos métodos insert, update e patch. Opcional. gravável
hidden boolean Se a agenda está oculta na 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 de recurso ("calendar#calendarListEntry").
location string Localização geográfica da agenda como texto em formato livre. Opcional. Somente leitura.
notificationSettings object As notificações que o usuário autenticado está recebendo para esta agenda. gravável
notificationSettings.notifications[] list A lista de notificações definidas para esta agenda.
notificationSettings.notifications[].method string O método usado para enviar a notificação. O valor possível é:
  • "email" - As notificações são enviadas por e-mail.

Obrigató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 é incluído na agenda.
  • "eventChange" - Notificação enviada quando um evento é alterado.
  • "eventCancellation" - Notificação enviada quando um evento é cancelado.
  • "eventResponse" - Notificação enviada quando um participante responde ao convite do evento.
  • "agenda" - Uma programação com os eventos do dia (enviados pela manhã).

Obrigatório ao adicionar uma notificação.

 gravável
primary boolean 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 da agenda. 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 esta 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 do usuário.
list
Retorna as agendas na lista de agendas do usuário.
patch
Atualiza uma agenda existente 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. prefira usar uma get seguida por uma update. Os valores de campo especificados substituem os atuais. Os campos não especificados na solicitação permanecem inalterados. Campos de matriz, se especificados, substituem as matrizes existentes. isso descartará os elementos anteriores da matriz.
update
Atualiza uma agenda existente na lista de agendas do usuário.
relógio
Monitorar as mudanças nos recursos da AgendaList.