CalendarList

La raccolta dei calendari nell'elenco di calendari dell'utente. Vedi anche Calendari e CalendarList.

Per un elenco di metodi per questa risorsa, vai alla fine di questa pagina.

Rappresentazioni delle risorse

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
Nome proprietà Valore Descrizione Note
accessRole string Il ruolo di accesso effettivo dell'utente autenticato al calendario. Sola lettura. I valori possibili sono:
  • "freeBusyReader" - Fornisce l'accesso in lettura alle informazioni sulla disponibilità.
  • "reader" - Fornisce l'accesso in lettura al calendario. Gli eventi privati saranno visibili agli utenti con accesso in lettura, ma i relativi dettagli saranno nascosti.
  • "writer" - Fornisce l'accesso in lettura e scrittura al calendario. Gli eventi privati verranno mostrati agli utenti con accesso in scrittura e i dettagli degli eventi saranno visibili.
  • "owner" - Fornisce la proprietà del calendario. Questo ruolo possiede tutte le autorizzazioni del ruolo Writer con un'ulteriore possibilità di visualizzare e gestire gli ACL.
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
conferenceProperties nested object Proprietà delle conferenze per questo calendario, ad esempio quali tipi di conferenze sono consentiti.
conferenceProperties.allowedConferenceSolutionTypes[] list I tipi di soluzioni per conferenze supportate per questo calendario.

I valori possibili sono:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Facoltativa.

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:
  • "email" - I promemoria vengono inviati via email.
  • "popup" - I promemoria vengono inviati tramite un popup dell'interfaccia utente.

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
deleted boolean Indica se la voce dell'elenco di calendari è stata eliminata dall'elenco. Sola lettura. (Facoltativo) Il valore predefinito è False.
description string Descrizione del calendario. (Facoltativo) Sola lettura.
etag etag ETag della risorsa.
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
hidden boolean Se il calendario è stato nascosto dall'elenco. (Facoltativo) L'attributo viene restituito solo quando il calendario è nascosto, nel qual caso il valore è true. accessibile in scrittura
id string Identificatore del calendario.
kind string Tipo di risorsa ("calendar#calendarListEntry").
location string Posizione geografica del calendario come testo in formato libero. (Facoltativo) Sola lettura.
notificationSettings object Le notifiche che l'utente autenticato riceve per questo calendario. accessibile in scrittura
notificationSettings.notifications[] list L'elenco di notifiche impostate per questo calendario.
notificationSettings.notifications[].method string Il metodo utilizzato per inviare la notifica. Il valore possibile è:
  • "email" - Le notifiche vengono inviate via email.

Obbligatorio quando si aggiunge una notifica.

accessibile in scrittura
notificationSettings.notifications[].type string Il tipo di notifica. I valori possibili sono:
  • "eventCreation" - Invia una notifica quando viene inserito un nuovo evento nel calendario.
  • "eventChange" - Notifica inviata quando un evento viene modificato.
  • "eventCancellation" - Notifica inviata quando un evento viene annullato.
  • "eventResponse" - Notifiche inviate quando un partecipante risponde all'invito all'evento.
  • "agenda" - Un'agenda con gli eventi del giorno (inviati la mattina).

Obbligatorio quando si aggiunge una notifica.

accessibile in scrittura
primary boolean Se il calendario è il calendario principale dell'utente autenticato. Sola lettura. (Facoltativo) Il valore predefinito è False.
selected boolean Se i contenuti del calendario vengono visualizzati nella UI del calendario. (Facoltativo) Il valore predefinito è False. accessibile in scrittura
summary string Titolo del calendario. Sola lettura.
summaryOverride string Il riepilogo impostato dall'utente autenticato per questo calendario. (Facoltativo) accessibile in scrittura
timeZone string Il fuso orario del calendario. (Facoltativo) Sola lettura.

Metodi

elimina
Rimuove un calendario dall'elenco di calendari dell'utente.
trova
Restituisci un calendario dall'elenco di calendari dell'utente.
inserisci
Inserisce un calendario esistente nell'elenco di calendari dell'utente.
list
Restituisci i calendari presenti nell'elenco di calendari dell'utente.
patch
Aggiorna un calendario esistente nell'elenco di calendari dell'utente. Questo metodo supporta la semantica delle patch. Tieni presente che ogni richiesta di patch utilizza tre unità di quota; preferisci usare get seguito da update. I valori dei campi specificati sostituiscono quelli esistenti. I campi non specificati nella richiesta rimangono invariati. I campi array, se specificati, sovrascrivono gli array esistenti. Vengono ignorati tutti gli elementi array precedenti.
aggiorna
Aggiorna un calendario esistente nell'elenco di calendari dell'utente.
orologio
Attendi le modifiche apportate alle risorse CalendarList.