Consente di aggiornare un calendario esistente nell'elenco di calendari dell'utente. Prova subito 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 percorso | ||
calendarId |
string |
Identificatore di calendario. Per recuperare gli ID calendario, chiama il metodo calendarList.list. Se vuoi accedere al calendario principale dell'utente che ha eseguito l'accesso, usa "primary " parola chiave.
|
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 su indice verrà impostato automaticamente sull'opzione di corrispondenza migliore. (Facoltativo) Il valore predefinito è False.
|
Autorizzazione
Questa richiesta richiede l'autorizzazione con il seguente ambito:
Ambito |
---|
https://www.googleapis.com/auth/calendar |
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 su indice. Per impostare o modificare questa proprietà, devi specificare colorRgbFormat=true nei parametri dei metodi insert, update e patch. (Facoltativo) |
accessibile in scrittura |
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 dei colori). Questa proprietà ha la precedenza sulle proprietà backgroundColor e foregroundColor e può essere ignorata quando utilizzi queste proprietà. (Facoltativo) |
accessibile in scrittura |
defaultReminders[] |
list |
I promemoria predefiniti di cui l'utente autenticato dispone per questo calendario. | accessibile in scrittura |
defaultReminders[].method |
string |
Il metodo utilizzato da questo promemoria. I valori possibili sono:
Obbligatorio quando aggiungi un promemoria. |
accessibile in scrittura |
defaultReminders[].minutes |
integer |
Numero di minuti prima dell'inizio dell'evento quando deve essere attivato il promemoria. I valori validi sono compresi tra 0 e 40320 (4 settimane in minuti). Obbligatorio quando aggiungi un promemoria. |
accessibile in scrittura |
foregroundColor |
string |
Il colore in primo piano del calendario nel formato esadecimale "#ffffff ". Questa proprietà sostituisce la proprietà colorId basata su indice. Per impostare o modificare questa proprietà, devi specificare colorRgbFormat=true nei parametri dei metodi insert, update e patch. (Facoltativo) |
accessibile in scrittura |
notificationSettings |
object |
Le notifiche che l'utente autenticato riceve per questo calendario. | accessibile in scrittura |
notificationSettings.notifications[].method |
string |
Il metodo utilizzato per inviare la notifica. Il valore possibile è:
Obbligatorio quando si aggiunge una notifica. |
accessibile in scrittura |
notificationSettings.notifications[].type |
string |
Il tipo di notifica. I valori possibili sono:
Obbligatorio quando si aggiunge una notifica. |
accessibile in scrittura |
selected |
boolean |
Se i contenuti del calendario vengono visualizzati nella UI del calendario. (Facoltativo) Il valore predefinito è False. | accessibile in scrittura |
summaryOverride |
string |
Il riepilogo impostato dall'utente autenticato per questo calendario. (Facoltativo) | accessibile in scrittura |
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
Usa Explorer API in basso per chiamare questo metodo sui dati in tempo reale e visualizzare la risposta.