CalendarList

La raccolta di calendari nell'elenco dei 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,
  "dataOwner": 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 verranno visualizzati dagli utenti con accesso in lettura, ma i dettagli degli eventi verranno nascosti.
  • "writer": fornisce l'accesso in lettura e scrittura al calendario. Gli eventi privati verranno visualizzati dagli utenti con accesso di scrittura e i dettagli dell'evento saranno visibili.
  • "owner": fornisce l'accesso al calendario al gestore. Questo ruolo dispone di tutte le autorizzazioni del ruolo Autore, con la possibilità aggiuntiva di visualizzare e modificare i livelli di accesso di altri utenti.

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 colori). Questa proprietà è sostituita dalle proprietà backgroundColor e foregroundColor e può essere ignorata quando vengono utilizzate queste proprietà. Facoltativo. scrivibile
conferenceProperties nested object Proprietà delle conferenze per questo calendario, ad esempio i tipi di conferenze consentiti.
conferenceProperties.allowedConferenceSolutionTypes[] list I tipi di soluzioni per conferenze supportati per questo calendario.

I valori possibili sono:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
(Facoltativo)
dataOwner string L'email del proprietario del calendario. Impostato solo per i calendari secondari. Sola lettura.
defaultReminders[] list I promemoria predefiniti che l'utente autenticato ha 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 si aggiunge 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 si aggiunge un promemoria.

 scrivibile
deleted boolean Indica se questa 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 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
id string Identificatore del calendario.
kind string Tipo di risorsa ("calendar#calendarListEntry").
location string La posizione geografica del calendario come testo in formato libero. Facoltativo. Sola lettura.
notificationSettings object Le notifiche che l'utente autenticato riceve per questo calendario. scrivibile
notificationSettings.notifications[] list L'elenco delle 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.

 scrivibile
notificationSettings.notifications[].type string Il tipo di notifica. I valori possibili sono:
  • "eventCreation": notifica inviata quando viene inserito un nuovo evento 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 si aggiunge una notifica.

 scrivibile
primary boolean Indica 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 nell'interfaccia utente del calendario. Facoltativo. Il valore predefinito è False. scrivibile
summary string Il titolo del calendario. Sola lettura.
summaryOverride string Il riepilogo che l'utente autenticato ha impostato per questo calendario. Facoltativo. scrivibile
timeZone string Il fuso orario del calendario. Facoltativo. Sola lettura.

Metodi

elimina
Rimuove un calendario dall'elenco dei calendari dell'utente.
get
Restituisce un calendario dall'elenco dei calendari dell'utente.
insert
Inserisce un calendario esistente nell'elenco dei calendari dell'utente.
list
Restituisce i calendari nell'elenco dei calendari dell'utente.
patch
Aggiorna un calendario esistente nell'elenco dei calendari dell'utente. Questo metodo supporta la semantica delle patch. Tieni presente che ogni richiesta di patch consuma tre unità di quota. Ti consigliamo di utilizzare un get seguito da un update. I valori dei campi che specifichi sostituiscono i valori esistenti. I campi non specificati nella richiesta rimangono invariati. I campi array, se specificati, sovrascrivono gli array esistenti, eliminando tutti gli elementi dell'array precedenti.
aggiornamento
Aggiorna un calendario esistente nell'elenco dei calendari dell'utente.
watch
Controlla le modifiche alle risorse CalendarList.