CalendarList: insert

Inserisce un calendario esistente nell'elenco dei calendari dell'utente. Prova subito o guarda un esempio.

Richiesta

Richiesta HTTP

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

Parametri

Nome del parametro Valore Descrizione
Parametri di query facoltativi
colorRgbFormat boolean Indica se utilizzare i campi foregroundColor e backgroundColor per scrivere i colori del calendario (RGB). Se questa funzionalità viene utilizzata, il campo colorId basato su indice verrà impostato automaticamente sull'opzione di corrispondenza migliore. Campo facoltativo. Il valore predefinito è False.

Autorizzazione

Questa richiesta richiede un'autorizzazione con il seguente ambito:

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

Per ulteriori informazioni, consulta la pagina relativa all'autenticazione e autorizzazione.

Corpo della richiesta

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

Nome proprietà Valore Descrizione Note
Proprietà obbligatorie
id string Identificatore del calendario.
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. Campo 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 dei colori). Questa proprietà è sostituita dalle proprietà backgroundColor e foregroundColor e può essere ignorata quando le utilizzi. Campo facoltativo. scrivibile
defaultReminders[] list I promemoria predefiniti per l'utente autenticato per questo calendario. scrivibile
defaultReminders[].method string Il metodo utilizzato per il 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 dovrebbe 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 in primo piano del calendario nel formato esadecimale "#ffffff". Questa proprietà ha la precedenza sulla proprietà colorId basata su indice. Per impostare o modificare questa proprietà, devi specificare colorRgbFormat=true nei parametri dei metodi insert, update e patch. Campo facoltativo. scrivibile
hidden boolean Indica se il calendario è stato nascosto dall'elenco. Campo facoltativo. L'attributo viene restituito solo quando il calendario è nascosto, nel qual caso il valore è true. scrivibile
notificationSettings object Le notifiche ricevute per il calendario dall'utente autenticato. scrivibile
notificationSettings.notifications[].method string Il metodo utilizzato per recapitare la notifica. Il valore possibile è:
  • "email" - Le notifiche vengono inviate via email.

Obbligatorio quando si aggiunge 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 un evento viene modificato.
  • "eventCancellation" - Notifica inviata quando un evento viene annullato.
  • "eventResponse" - Notifica inviata quando un partecipante risponde all'invito all'evento.
  • "agenda" - Un'agenda con gli eventi del giorno (inviati di mattina).

Obbligatorio quando si aggiunge una notifica.

 scrivibile
selected boolean Indica se i contenuti del calendario vengono visualizzati nell'interfaccia utente del calendario. Campo facoltativo. Il valore predefinito è False. scrivibile
summaryOverride string Il riepilogo impostato dall'utente autenticato per questo calendario. Campo 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();

// Create a new calendar list entry
CalendarListEntry calendarListEntry = new CalendarListEntry();
calendarListEntry.setId("calendarId");

// Insert the new calendar list entry
CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute();

System.out.println(createdCalendarListEntry.getSummary());

Python

Utilizza la libreria client Python.

calendar_list_entry = {
    'id': 'calendarId'
}

created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute()

print created_calendar_list_entry['summary']

PHP

Utilizza la libreria client PHP.

$calendarListEntry = new Google_Service_Calendar_CalendarListEntry();
$calendarListEntry->setId("calendarId");

$createdCalendarListEntry = $service->calendarList->insert($calendarListEntry);

echo $createdCalendarListEntry->getSummary();

Ruby

Utilizza la libreria client di Ruby.

entry = Google::Apis::CalendarV3::CalendarListEntry.new(
 id: 'calendarId'
)

result = client.insert_calendar_list(entry)
print result.summary

Prova.

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