CalendarList: update

Aggiorna un calendario esistente nell'elenco dei calendari dell'utente. Prova ora o guarda un esempio.

Richiesta

Richiesta HTTP

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

Parametri

Nome del parametro Valore Descrizione
Parametri del percorso
calendarId string Identificatore del calendario. Per recuperare gli ID calendario, chiama il metodo calendarList.list. Se vuoi accedere al calendario principale dell'utente che ha eseguito l'accesso, utilizza la parola chiave "primary".
Parametri di query facoltativi
colorRgbFormat boolean Indica se utilizzare i campi foregroundColor e backgroundColor per scrivere i colori del calendario (RGB). Se viene utilizzata questa funzionalità, il campo colorId basato sull'indice verrà impostato automaticamente sull'opzione di corrispondenza migliore. Facoltativo. Il valore predefinito è False.

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti:

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

Per ulteriori informazioni, consulta la pagina Autenticazione e autorizzazione.

Corpo della richiesta

Nel corpo della richiesta, fornisci una risorsa CalendarList con le seguenti proprietà:

Nome proprietà Valore Descrizione Note
Proprietà facoltative
backgroundColor string Il colore principale del calendario nel formato esadecimale "#0088aa". Questa proprietà sostituisce la proprietà colorId basata sull'indice. Per impostare o modificare questa proprietà, devi specificare colorRgbFormat=true nei parametri dei metodi insert, update e patch. Facoltativo. scrivibile
colorId string Il colore del calendario. Si tratta di un ID che fa riferimento a una voce nella sezione calendar della definizione dei colori (vedi l'endpoint colors). Questa proprietà è sostituita dalle proprietà backgroundColor e foregroundColor e può essere ignorata quando le utilizzi. Facoltativo. scrivibile
defaultReminders[] list I promemoria predefiniti dell'utente autenticato per questo calendario. scrivibile
defaultReminders[].method string Il metodo utilizzato da questo promemoria. I valori possibili sono:
  • "email": i promemoria vengono inviati via email.
  • "popup": i promemoria vengono inviati tramite un popup dell'interfaccia utente.

Obbligatorio quando aggiungi un promemoria.

scrivibile
defaultReminders[].minutes integer Numero di minuti prima dell'inizio dell'evento in cui deve essere attivato il promemoria. I valori validi sono compresi tra 0 e 40320 (4 settimane in minuti).

Obbligatorio quando aggiungi un promemoria.

scrivibile
foregroundColor string Il colore di primo piano del calendario nel formato esadecimale "#ffffff". Questa proprietà sostituisce la proprietà colorId basata sull'indice. Per impostare o modificare questa proprietà, devi specificare colorRgbFormat=true nei parametri dei metodi insert, update e patch. Facoltativo. scrivibile
hidden boolean Indica se il calendario è stato nascosto dall'elenco. Facoltativo. L'attributo viene restituito solo quando il calendario è nascosto, nel qual caso il valore è true. scrivibile
notificationSettings object Le notifiche che l'utente autenticato riceve per questo calendario. scrivibile
notificationSettings.notifications[].method string Il metodo utilizzato per inviare la notifica. Il valore possibile è:
  • "email": le notifiche vengono inviate via email.

Obbligatorio quando aggiungi una notifica.

scrivibile
notificationSettings.notifications[].type string Il tipo di notifica. I valori possibili sono:
  • "eventCreation": notifica inviata quando un nuovo evento viene inserito nel calendario.
  • "eventChange": notifica inviata quando viene modificato un evento.
  • "eventCancellation": notifica inviata quando un evento viene annullato.
  • "eventResponse": notifica inviata quando un partecipante risponde all'invito all'evento.
  • "agenda": un programma con gli eventi della giornata (inviato al mattino).

Obbligatorio quando aggiungi una notifica.

scrivibile
selected boolean Indica se i contenuti del calendario vengono visualizzati nell'interfaccia utente del calendario. Facoltativo. Il valore predefinito è False. scrivibile
summaryOverride string Il riepilogo impostato dall'utente autenticato per questo calendario. Facoltativo. scrivibile

Risposta

In caso di esito positivo, questo metodo restituisce una risorsa CalendarList nel corpo della risposta.

Esempi

Nota: gli esempi di codice disponibili per questo metodo non rappresentano tutti i linguaggi di programmazione supportati (consulta la pagina relativa alle librerie client per un elenco dei linguaggi supportati).

Java

Utilizza la libreria client 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

Utilizza la libreria client 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

Utilizza la libreria client 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

Utilizza la libreria client 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

Prova

Utilizza l'Explorer API di seguito per chiamare questo metodo sui dati in tempo reale e visualizzare la risposta.