CalendarList: update

Atualiza uma agenda existente na lista de agendas do usuário. Faça um teste agora ou veja um exemplo.

Solicitação

Solicitação HTTP

PUT https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
calendarId string Identificador da agenda. Para recuperar IDs de agendas, chame o método calendarList.list. Para acessar a agenda principal do usuário conectado, use "primary" palavra-chave.
Parâmetros de consulta opcionais
colorRgbFormat boolean Define se os campos foregroundColor e backgroundColor serão usados para gravar as cores da agenda (RGB). Se esse recurso for usado, o campo colorId com base em índice será definido automaticamente com a melhor opção de correspondência. Opcional. O valor padrão é falso.

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/calendar

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

Corpo da solicitação

No corpo da solicitação, informe um recurso CalendarList com as seguintes propriedades:

Nome da propriedade Valor Descrição Observações
Propriedades opcionais
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
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
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
notificationSettings object As notificações que o usuário autenticado está recebendo para esta agenda. gravável
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
selected boolean Indica se o conteúdo da agenda aparece na interface da agenda. Opcional. O valor padrão é falso. gravável
summaryOverride string O resumo que o usuário autenticado definiu para esta agenda. Opcional. gravável

Resposta

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

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a biblioteca cliente de Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Retrieve the calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

// Make a change
calendarListEntry.setColorId("newColorId");

// Update the altered entry
CalendarListEntry updatedCalendarListEntry =
    service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute();

System.out.println(updatedCalendarListEntry.getEtag());

Python

Usa a biblioteca cliente de Python.

# First retrieve the calendarListEntry from the API.
calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()
calendar_list_entry['colorId'] = 'newColorId'

updated_calendar_list_entry = service.calendarList().update(
    calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute()

print created_calendar_list_entry['etag']

PHP

Usa a biblioteca cliente de PHP.

// First retrieve the calendarListEntry from the API.
$calendarListEntry = $service->calendarList->get('calendarId');
$calendarListEntry->setColorId('newColorId');

$updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry);

echo $updatedCalendarListEntry->getEtag();

Ruby

Usa a biblioteca de cliente Ruby.

calendar_list_entry = client.get_calendar_list('calendarId')
calendar_list_entry.colorId = 'newColorId'
result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry)
print result.etag

Confira!

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