Se usó la API de Cloud Translation para traducir esta página.

CalendarList: update

Actualiza un calendario existente en la lista de calendarios del usuario. Pruébalo ahora y ve un ejemplo.

Solicitud

Solicitud HTTP

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

Parámetros

Nombre del parámetro	Valor	Descripción
Parámetros de ruta de acceso
`calendarId`	`string`	Es el identificador del calendario. Para recuperar los IDs de calendario, llama al método calendarList.list. Si deseas acceder al calendario principal del usuario que accedió actualmente, usa la palabra clave "`primary`".
Parámetros de consulta opcionales
`colorRgbFormat`	`boolean`	Indica si se deben usar los campos `foregroundColor` y `backgroundColor` para escribir los colores del calendario (RGB). Si se usa esta función, el campo `colorId` basado en el índice se establecerá automáticamente en la mejor opción de coincidencia. Opcional. El valor predeterminado es False.

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes permisos:

Alcance
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.app.created`
`https://www.googleapis.com/auth/calendar.calendarlist`

Para obtener más información, consulta la página autenticación y autorización.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporciona un recurso CalendarList con las siguientes propiedades:

Nombre de la propiedad	Valor	Descripción	Notas
Propiedades opcionales
`backgroundColor`	`string`	Es el color principal del calendario en el formato hexadecimal "`#0088aa`". Esta propiedad reemplaza a la propiedad `colorId` basada en índices. Para establecer o cambiar esta propiedad, debes especificar `colorRgbFormat=true` en los parámetros de los métodos insert, update y patch. Opcional.	admite escritura
`colorId`	`string`	Es el color del calendario. Es un ID que hace referencia a una entrada en la sección `calendar` de la definición de colores (consulta el extremo de colores). Esta propiedad se reemplaza por las propiedades `backgroundColor` y `foregroundColor`, y se puede ignorar cuando se usan estas propiedades. Opcional.	admite escritura
`defaultReminders[]`	`list`	Los recordatorios predeterminados que tiene el usuario autenticado para este calendario.	admite escritura
`defaultReminders[].method`	`string`	Es el método que usa este recordatorio. Los valores posibles son los siguientes: "`email`": Los recordatorios se envían por correo electrónico. "`popup`": Los recordatorios se envían a través de una ventana emergente de la IU. Obligatorio cuando se agrega un recordatorio.	admite escritura
`defaultReminders[].minutes`	`integer`	Es la cantidad de minutos antes del inicio del evento en los que se debe activar el recordatorio. Los valores válidos están entre 0 y 40320 (4 semanas en minutos). Obligatorio cuando se agrega un recordatorio.	admite escritura
`foregroundColor`	`string`	Es el color de primer plano del calendario en el formato hexadecimal "`#ffffff`". Esta propiedad reemplaza a la propiedad `colorId` basada en índices. Para establecer o cambiar esta propiedad, debes especificar `colorRgbFormat=true` en los parámetros de los métodos insert, update y patch. Opcional.	admite escritura
`hidden`	`boolean`	Indica si el calendario se ocultó de la lista. Opcional. El atributo solo se muestra cuando el calendario está oculto, en cuyo caso el valor es `true`.	admite escritura
`notificationSettings`	`object`	Las notificaciones que recibe el usuario autenticado para este calendario	admite escritura
`notificationSettings.notifications[].method`	`string`	Es el método que se usa para entregar la notificación. El valor posible es: "`email`": Las notificaciones se envían por correo electrónico. Obligatorio cuando se agrega una notificación.	admite escritura
`notificationSettings.notifications[].type`	`string`	El tipo de notificación. Los valores posibles son los siguientes: "`eventCreation`": Notificación que se envía cuando se agrega un evento nuevo al calendario. "`eventChange`": Notificación que se envía cuando se cambia un evento. "`eventCancellation`": Notificación que se envía cuando se cancela un evento. "`eventResponse`": Notificación que se envía cuando un asistente responde a la invitación al evento. "`agenda`": Es una agenda con los eventos del día (se envía por la mañana). Obligatorio cuando se agrega una notificación.	admite escritura
`selected`	`boolean`	Indica si el contenido del calendario aparece en la IU del calendario. Opcional. El valor predeterminado es False.	admite escritura
`summaryOverride`	`string`	Es el resumen que el usuario autenticado estableció para este calendario. Opcional.	admite escritura

Respuesta

Si se aplica correctamente, este método muestra un recurso CalendarList en el cuerpo de la respuesta.

Ejemplos

Nota: Los ejemplos de código disponibles para este método no representan todos los lenguajes de programación admitidos (consulta la página de bibliotecas cliente para consultar una lista de lenguajes admitidos).

Java

Usa la 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 la 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 la 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 la biblioteca cliente de 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

Pruébalo

Usa el Explorador de APIs que aparece a continuación para llamar a este método en datos en vivo y ver la respuesta.