CalendarList: update

Atualiza uma agenda 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 extrair os IDs de agenda, chame o método calendarList.list. Se você quiser acessar a agenda principal do usuário conectado, use a palavra-chave primary.
Parâmetros de consulta opcionais
colorRgbFormat boolean Define se os campos foregroundColor e backgroundColor vão ser usados para gravar as cores do calendário (RGB). Se esse recurso for usado, o campo colorId baseado em índice será definido automaticamente como a melhor opção correspondente. Opcional. O valor padrão é falso.

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.calendarlist

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 CalendarList com as seguintes propriedades:

Nome da propriedade Valor Descrição Observações
Propriedades opcionais
backgroundColor string A cor principal do calendário 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
defaultReminders[] list Os lembretes padrão que o usuário autenticado tem para esse calendário. 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 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 precisa ser acionado. Os valores válidos estão entre 0 e 40320 (quatro semanas em minutos).

Obrigatório ao adicionar um lembrete.

 gravável
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 oculta da lista. Opcional. O atributo só é retornado quando o calendário está oculto. Nesse caso, o valor é true. gravável
notificationSettings object As notificações que o usuário autenticado está recebendo para essa 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 é 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
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 esse calendário. 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.