CalendarList

A coleção de agendas na lista de agendas do usuário. 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#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
    ]
  }
}
Nome da propriedade Valor Descrição Observações
accessRole string A função de acesso efetivo que o usuário autenticado tem na agenda. Somente leitura. Os valores possíveis são:
  • "freeBusyReader": fornece acesso de leitura a 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 ficarão ocultos.
  • "writer": concede 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 vão ficar visíveis.
  • "owner": dá acesso de administrador à agenda. Essa função tem todas as permissões da função de gravador, além da capacidade de ver e modificar os níveis de acesso de outros usuários.

backgroundColor string A cor principal da agenda no formato hexadecimal "#0088aa". Essa propriedade substitui a propriedade colorId baseada em índice. Para definir ou mudar essa propriedade, especifique colorRgbFormat=true nos parâmetros dos métodos insert, update 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 conferência para esta 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 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.
defaultReminders[] list Os lembretes padrão que o usuário autenticado tem para este calendário. gravável
defaultReminders[].method string O método usado por este 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.

Obrigató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).

Obrigatório ao adicionar um lembrete.

 gravável
deleted boolean Indica se esta 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 ETag do recurso.
foregroundColor string A cor de primeiro plano do calendário no formato hexadecimal "#ffffff". Essa propriedade substitui a propriedade colorId baseada em índice. Para definir ou mudar essa propriedade, especifique colorRgbFormat=true nos parâmetros dos métodos insert, update 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, caso em que 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 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 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 é adicionado à 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 agenda com os eventos do dia (enviada pela manhã).

Obrigató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 Se o conteúdo da agenda aparece na interface dela. 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 este calendário. 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 que você não especificar na solicitação vão permanecer inalterados. Os campos de matriz, se especificados, substituem as matrizes atuais, descartando todos os elementos anteriores.
update
Atualiza uma agenda na lista de agendas do usuário.
assistir
Monitore as mudanças nos recursos CalendarList.