Calendars: update

Atualiza os metadados de uma agenda. Faça o teste agora.

Solicitação

Solicitação HTTP

PUT https://www.googleapis.com/calendar/v3/calendars/calendarId

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
calendarId string Identificador da agenda. Para recuperar IDs de agenda, chame o método calendarList.list. Se você quiser acessar a agenda principal do usuário que fez login, use a palavra-chave "primary".

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos:

Escopo
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.calendars

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça um recurso Calendars com as seguintes propriedades:

Nome da propriedade Valor Descrição Observações
Propriedades opcionais
description string Descrição da agenda. Opcional. gravável
labelProperties nested object Propriedades de marcador definidas nesta agenda. Se especificado, substitui as propriedades do rótulo atual. Se não forem especificadas, as propriedades do rótulo vão permanecer inalteradas. gravável
labelProperties.eventLabels[] list Rótulos de eventos definidos nesta agenda. Se estiver presente ao atualizar a agenda, ele vai substituir os rótulos de eventos atuais.

Estenda a lista para adicionar um novo rótulo de evento e remova entidades da lista para excluir um rótulo da agenda.

Cada agenda pode ter no máximo 200 marcadores.

 gravável
labelProperties.eventLabels[].backgroundColor string Cor de fundo do marcador em formato hexadecimal, como "#039be5". Os eventos com esse rótulo aparecem nessa cor. Obrigatório. gravável
labelProperties.eventLabels[].id string O ID do rótulo. Opcional ao inserir um novo rótulo. Se não for fornecido, um ID exclusivo será gerado. Obrigatório ao atualizar um rótulo.

Se fornecido, o ID precisa ser exclusivo na agenda e seguir o formato UUID.

 gravável
labelProperties.eventLabels[].name string Nome do rótulo. Opcional.

Se fornecido, precisa ter no máximo 50 caracteres.

 gravável
location string Localização geográfica da agenda como texto de formato livre. Opcional. gravável
summary string Título da agenda. gravável
timeZone string O fuso horário da agenda. (Formatado como um nome do banco de dados de fusos horários da IANA, por exemplo, "Europe/Zurich".) Opcional. gravável
workingHours object Representa as informações sobre o horário de trabalho do usuário. Disponível apenas para agendas principais de usuários do Google Workspace. Para atualizar o horário de trabalho, é necessário transmitir todo o objeto de horário de trabalho. Se não for especificado (ou for transmitido como nulo ou um objeto vazio), o horário de trabalho atual não será alterado. Para desativar o horário de trabalho ou limpar a programação, defina workingHoursEnabled como falso (e omita availableTimes ou transmita uma lista vazia). gravável
workingHours.availableTimes[] list Horário de trabalho. Cada período de disponibilidade representa o bloco de horário de trabalho do usuário durante um dia. gravável
workingHours.availableTimes[].dayOfWeek string Dia da semana. Obrigatório. Os valores possíveis são:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
gravável
workingHours.availableTimes[].periodEnd integer Fim do período, em minutos a partir do início do dia, exclusivo. Obrigatório. gravável
workingHours.availableTimes[].periodStart integer Início do período, em minutos a partir do início do dia, inclusive. Obrigatório. gravável
workingHours.workingHoursEnabled boolean Se o horário de trabalho está ativado para esta agenda. Não pode ser definido como verdadeiro quando availableTimes está vazio. gravável

Resposta

Se for bem-sucedido, esse método vai retornar um recurso Calendars no corpo da resposta.

Confira!

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.