CalendarList

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

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 A função de acesso efetivo do usuário autenticado 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 aparecem para os usuários com acesso de leitor, mas os detalhes dos eventos ficam ocultos.
  • "writer": fornece acesso de leitura e gravação à agenda. Os eventos privados serão exibidos para os usuários com acesso de gravação, e os detalhes dos eventos ficarão visíveis.
  • "owner": fornece a propriedade da agenda. Esse papel tem todas as permissões do papel 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 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 foi 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 esta agenda, por exemplo, que tipos de videoconferências são permitidos.
conferenceProperties.allowedConferenceSolutionTypes[] list Os tipos de soluções de conferência compatíveis com este calendário.

Os valores possíveis são:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcional.
defaultReminders[] list Os lembretes padrão que o usuário autenticado tem para esta agenda. 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 meio de um pop-up da IU.

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 será acionado. Os valores válidos estão entre 0 e 40.320 (4 semanas em minutos).

Obrigatório ao adicionar um lembrete.

 gravável
deleted boolean 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". Ela 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 Mostra 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 em formato livre. Opcional. Somente leitura.
notificationSettings object As notificações que o usuário autenticado está recebendo pela agenda. gravável
notificationSettings.notifications[] list 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": a notificação é enviada quando um novo evento é inserido na agenda.
  • "eventChange": a notificação é enviada quando um evento é alterado.
  • "eventCancellation": a notificação é enviada quando um evento é cancelado.
  • "eventResponse": notificação enviada quando um convidado responde ao convite do evento.
  • "agenda": uma programação com os eventos do dia (enviada de 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 Indica se o conteúdo da agenda aparece na IU 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 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 existente na lista de agendas do usuário. Este método oferece suporte à semântica de patches. Cada solicitação de patch consome três unidades de cota. Use uma get seguida por uma update. Os valores dos campos especificados substituem os valores existentes. Os campos que você não especificar na solicitação permanecerão inalterados. Campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta quaisquer elementos de matriz anteriores.
update
Atualiza uma agenda existente na lista de agendas do usuário.
assistir
Acompanhe as mudanças nos recursos do AgendaList.