CalendarList: list

Restituisce i calendari nell'elenco dei calendari dell'utente. Prova subito.

Richiesta

Richiesta HTTP

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

Parametri

Nome parametro Valore Descrizione
Parametri di query facoltativi
maxResults integer Numero massimo di voci restituite in una pagina dei risultati. Per impostazione predefinita, il valore è 100 voci. Le dimensioni della pagina non possono mai superare le 250 voci. Facoltativo.
minAccessRole string Il ruolo di accesso minimo per l'utente nelle voci restituite. Facoltativo. Il valore predefinito è nessuna limitazione.

I valori accettati sono:
  • "freeBusyReader": l'utente può leggere le informazioni sul servizio libero/occupato.
  • "owner": l'utente può leggere e modificare gli eventi e gli elenchi di controllo degli accessi.
  • "reader": l'utente può leggere gli eventi non privati.
  • "writer": l'utente può leggere e modificare gli eventi.
  • "writerWithoutPrivateAccess": l'utente può leggere e modificare gli eventi, ma non può accedere agli eventi privati.
pageToken string Token che specifica quale pagina dei risultati restituire. Facoltativo.
showDeleted boolean Se includere o meno le voci dell'elenco dei calendari eliminate nel risultato. Facoltativo. Il valore predefinito è False.
showHidden boolean Indica se mostrare le voci nascoste. Facoltativo. Il valore predefinito è False.
syncToken string Token ottenuto dal campo nextSyncToken restituito nell'ultima pagina dei risultati della precedente richiesta di elenco. In questo modo, il risultato di questa richiesta di elenco contiene solo le voci modificate da allora. Se sono stati modificati solo campi di sola lettura, come le proprietà del calendario o gli elenchi di controllo degli accessi, la voce non verrà restituita. Tutte le voci eliminate e nascoste dall'ultima richiesta di elenco saranno sempre nel set di risultati e non è consentito impostare showDeleted né showHidden su False.
Per garantire la coerenza dello stato del client, il parametro di query minAccessRole non può essere specificato insieme a nextSyncToken.
Se syncToken scade, il server risponderà con un codice di risposta 410 GONE e il client dovrà cancellare lo spazio di archiviazione ed eseguire una sincronizzazione completa senza syncToken.
Scopri di più sulla sincronizzazione incrementale.
Facoltativo. L'impostazione predefinita prevede la restituzione di tutte le voci.

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti:

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

Per saperne di più, consulta la pagina Autenticazione e autorizzazione.

Corpo della richiesta

Non fornire un corpo della richiesta con questo metodo.

Risposta

In caso di esito positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Nome proprietà Valore Descrizione Note
kind string Tipo di raccolta ("calendar#calendarList").
etag etag ETag della raccolta.
nextPageToken string Token utilizzato per accedere alla pagina successiva di questo risultato. Omesso se non sono disponibili altri risultati, nel qual caso viene fornito nextSyncToken.
items[] list I calendari presenti nell'elenco dei calendari dell'utente.
nextSyncToken string Token utilizzato in un secondo momento per recuperare solo le voci modificate da quando è stato restituito questo risultato. Omesso se sono disponibili altri risultati, nel qual caso viene fornito nextPageToken.

Prova

Utilizza Explorer API riportato di seguito per chiamare questo metodo sui dati live e visualizzare la risposta.