CalendarList

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

Per un elenco dei metodi per questa risorsa, consulta la 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 che l'utente autenticato ha sul 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 come autore, mentre i dettagli degli eventi saranno visibili.
  • "owner": fornisce la proprietà del calendario. Questo ruolo dispone di tutte le autorizzazioni del ruolo Autore e offre la possibilità aggiuntiva di visualizzare e manipolare 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. 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
conferenceProperties nested object Proprietà di conferenza per questo calendario, ad esempio quali tipi di conferenze sono consentiti.
conferenceProperties.allowedConferenceSolutionTypes[] list I tipi di soluzioni di conferenza supportati per questo calendario.

I valori possibili sono:

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

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
deleted boolean Indica se questa voce dell'elenco dei calendari è stata eliminata dall'elenco dei calendari. Sola lettura. Campo facoltativo. Il valore predefinito è False.
description string Descrizione del calendario. Campo facoltativo. Sola lettura.
etag etag ETag della risorsa.
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
id string Identificatore del calendario.
kind string Il tipo della risorsa ("calendar#calendarListEntry").
location string Posizione geografica del calendario come testo in formato libero. Campo facoltativo. Sola lettura.
notificationSettings object Le notifiche ricevute per il calendario dall'utente autenticato. scrivibile
notificationSettings.notifications[] list L'elenco delle notifiche impostate per questo calendario.
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
primary boolean Indica se il calendario è il calendario principale dell'utente autenticato. Sola lettura. Campo facoltativo. Il valore predefinito è False.
selected boolean Indica se i contenuti del calendario vengono visualizzati nell'interfaccia utente del calendario. Campo facoltativo. Il valore predefinito è False. scrivibile
summary string Titolo del calendario. Sola lettura.
summaryOverride string Il riepilogo impostato dall'utente autenticato per questo calendario. Campo facoltativo. scrivibile
timeZone string Il fuso orario del calendario. Campo facoltativo. Sola lettura.

Metodi

elimina
Rimuove un calendario dall'elenco dei calendari dell'utente.
ricevi
Restituisci un calendario dall'elenco di calendari dell'utente.
inserire
Inserisci un calendario esistente nell'elenco dei calendari dell'utente.
list
Restituisce i calendari presenti nell'elenco dei calendari dell'utente.
cerotto
Aggiorna un calendario esistente nell'elenco di calendari dell'utente. Questo metodo supporta la semantica delle patch. Tieni presente che ogni richiesta di patch consuma tre unità di quota; è preferibile utilizzare get seguito da update. I valori dei campi specificati sostituiscono quelli esistenti. I campi che non hai specificato nella richiesta rimarranno invariati. I campi degli array, se specificati, sovrascrivono gli array esistenti; in questo modo vengono ignorati eventuali elementi dell'array precedenti.
aggiornamento
Aggiorna un calendario esistente nell'elenco di calendari dell'utente.
orologio
Verifica se sono state apportate modifiche alle risorse di CalendarList.