Esta página foi traduzida pela API Cloud Translation.

CalendarList

O conjunto 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,
  "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`": 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 leitor, mas os detalhes vão ficar ocultos. "`writer`": dá acesso de leitura e gravação à agenda. Os eventos particulares aparecem para os usuários com acesso de escritor, e os detalhes dos eventos ficam visíveis. "`owner`": informa 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`". Esta propriedade substitui a propriedade `colorId` baseada em índice. Para definir ou alterar essa propriedade, você precisa 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 conferências são permitidos.
`conferenceProperties.allowedConferenceSolutionTypes[]`	`list`	Os tipos de soluções de videoconferência compatíveis com essa agenda. Os valores possíveis são: `"eventHangout"` `"eventNamedHangout"` `"hangoutsMeet"` Opcional.
`defaultReminders[]`	`list`	Os lembretes padrão do usuário autenticado para esta 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 em 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 a 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 de primeiro plano da agenda no formato hexadecimal "`#ffffff`". Essa propriedade substitui a propriedade `colorId` baseada em índice. Para definir ou alterar essa propriedade, você precisa 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 do recurso ("calendar#calendarListEntry").
`location`	`string`	Localização geográfica do calendário 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 entregar 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 convidado responde ao convite do evento. "`agenda`": uma agenda com os eventos do dia (enviado no período da 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`	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

excluir: 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 existente na lista de agendas do usuário.
list: Retorna as agendas na lista de agendas do usuário.
patch: Atualiza uma agenda na lista do usuário. Este método oferece suporte à semântica de patches. Observe que 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 não forem especificados na solicitação não serão alterados. Os campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta os elementos anteriores da matriz.
update: Atualiza uma agenda na lista do usuário.
relógio: Acompanhe as mudanças nos recursos da lista Agenda.