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 di risultati. Per impostazione predefinita, il valore è 100 voci. Le dimensioni della pagina non possono mai essere superiori a 250 voci. Facoltativo.
minAccessRole string Il ruolo di accesso minimo per l'utente nelle voci restituite. Facoltativo. Il valore predefinito è nessuna restrizione.

I valori accettabili sono:
  • "freeBusyReader": l'utente può leggere le informazioni sulla disponibilità.
  • "owner": l'utente può leggere e modificare gli eventi e gli elenchi di controllo dell'accesso.
  • "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 non privati. L'utente può leggere le informazioni sulla disponibilità degli eventi privati. L'utente non può modificare gli eventi privati.
pageToken string Token che specifica la pagina dei risultati da restituire. Facoltativo.
showDeleted boolean Indica se includere 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.
showOwnOrganizationOnly boolean Indica se mostrare solo le voci dei calendari dell'organizzazione. Questo parametro è applicabile solo agli utenti di Google Workspace. Facoltativo. Il valore predefinito è False.
syncToken string Token ottenuto dal campo nextSyncToken restituito nell'ultima pagina dei risultati della richiesta di elenco precedente. Fa sì che il risultato di questa richiesta di elenco contenga solo le voci modificate da allora. Se sono stati modificati solo i campi di sola lettura, come le proprietà del calendario o gli ACL, la voce non verrà restituita. Tutte le voci eliminate e nascoste dalla richiesta di elenco precedente saranno sempre nel set di risultati e non è consentito impostare showDeleted né showHidden su False.
Per garantire la coerenza dello stato del client, i parametri di query minAccessRole e showOwnOrganizationOnly non possono essere specificati insieme a nextSyncToken.
Se il 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 alcun syncToken.
Scopri di più sulla sincronizzazione incrementale.
Facoltativo. Il valore predefinito è restituire 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 relativa all'autenticazione e all'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 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 l'Esplora API di seguito per chiamare questo metodo sui dati live e visualizzare la risposta.