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
    ]
  },
  "autoAcceptInvitations": boolean
}
Nome proprietà Valore Descrizione Note
accessRole string Il ruolo di accesso effettivo che l'utente autenticato ha nel 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.
  • "writerWithoutPrivateAccess" - Fornisce l'accesso in lettura e scrittura al calendario. Gli eventi privati verranno visualizzati dagli utenti con accesso writerWithoutPrivateAccess, 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 in scrittura e i dettagli degli eventi saranno visibili.
  • "owner" - Fornisce l'accesso di amministratore al calendario. Questo ruolo ha tutte le autorizzazioni del ruolo di scrittura con la possibilità aggiuntiva di visualizzare e modificare i livelli di accesso di altri utenti.

autoAcceptInvitations boolean Indica se questo calendario accetta automaticamente gli inviti. Valido solo per i calendari delle risorse. Sola lettura.
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 dei colori). Questa proprietà è sostituita dalle proprietà backgroundColor e foregroundColor e può essere ignorata quando le utilizzi. Facoltativo. Scrivibile
conferenceProperties nested object Proprietà di videoconferenza per questo calendario, ad esempio i tipi di conferenze consentiti.
conferenceProperties.allowedConferenceSolutionTypes[] list I tipi di soluzioni per videoconferenze supportati per questo calendario.

I valori possibili sono:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Facoltativo.
dataOwner string L'indirizzo 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 Il 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 dei calendari è stata eliminata dall'elenco dei calendari. 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 nell'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 Il 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 viene annullato un evento.
  • "eventResponse" - Notifica inviata quando un partecipante risponde all'invito all'evento.
  • "agenda" - Un'agenda con gli eventi della giornata (inviata 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 Indica se i contenuti del calendario vengono visualizzati nell'interfaccia utente di Calendar. 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

delete
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 patch. Tieni presente che ogni richiesta di patch consuma tre unità di quota; è preferibile utilizzare un get seguito da un update. I valori dei campi specificati sostituiscono i valori esistenti. I campi non specificati nella richiesta rimangono invariati. I campi array, se specificati, sovrascrivono gli array esistenti; in questo modo vengono eliminati tutti gli elementi array precedenti.
update
Aggiorna un calendario esistente nell'elenco dei calendari dell'utente.
watch
Monitora le modifiche alle risorse CalendarList.