Events: list

Restituisce gli eventi nel calendario specificato. Prova subito o guarda un esempio.

Richiesta

Richiesta HTTP

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events

Parametri

Nome del parametro Valore Descrizione
Parametri percorso
calendarId string Identificatore di calendario. Per recuperare gli ID calendario, chiama il metodo calendarList.list. Se vuoi accedere al calendario principale dell'utente che ha eseguito l'accesso, usa "primary" parola chiave.
Parametri di query facoltativi
alwaysIncludeEmail boolean Deprecato e ignorato.
eventTypes string Tipi di eventi da restituire. (Facoltativo) Questo parametro può essere ripetuto più volte per restituire eventi di tipo diverso. Se il criterio non viene configurato, restituisce tutti i tipi di eventi.

I valori accettati sono:
  • "default": eventi regolari.
  • "focusTime": eventi di momento di concentrazione.
  • "fromGmail": eventi da Gmail.
  • "outOfOffice": eventi fuori sede.
  • "workingLocation": eventi relativi al luogo di lavoro.
iCalUID string Specifica un ID evento nel formato iCalendar da fornire nella risposta. (Facoltativo) Utilizza questa opzione se vuoi cercare un evento in base al suo ID iCalendar.
maxAttendees integer Il numero massimo di partecipanti da includere nella risposta. Se il numero di partecipanti supera quello specificato, viene restituito solo il partecipante. (Facoltativo)
maxResults integer Numero massimo di eventi restituiti in una pagina dei risultati. Il numero di eventi nella pagina risultante può essere inferiore a questo valore o non essere affatto, anche se ci sono più eventi corrispondenti alla query. Le pagine incomplete possono essere rilevate da un campo nextPageToken non vuoto nella risposta. Per impostazione predefinita, il valore è 250 eventi. La dimensione della pagina non può mai essere superiore a 2500 eventi. (Facoltativo)
orderBy string L'ordine degli eventi restituiti nel risultato. (Facoltativo) L'impostazione predefinita è un ordine stabile non specificato.

I valori accettati sono:
  • "startTime": ordina in base alla data/ora di inizio (ordine crescente). Questa opzione è disponibile solo quando si eseguono query su singoli eventi (ad es.il parametro singleEvents è True).
  • "updated": ordina in base all'ora dell'ultima modifica (ordine crescente).
pageToken string Token che specifica la pagina dei risultati da restituire. (Facoltativo)
privateExtendedProperty string Vincolo di proprietà estese specificato come proprietàName=value. Corrisponde solo a proprietà private. Questo parametro può essere ripetuto più volte per restituire eventi che corrispondono a tutti i vincoli specificati.
q string Termini di ricerca a testo libero per trovare eventi che corrispondono a questi termini nei seguenti campi:
  • summary
  • description
  • location
  • displayName del partecipante
  • email del partecipante
  • displayName dell'organizzatore
  • email dell'organizzatore
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

Questi termini di ricerca corrispondono anche a parole chiave predefinite con tutte le traduzioni dei titoli visualizzati di eventi di luoghi di lavoro, fuori sede e momenti di concentrazione. Ad esempio, se cerchi "Ufficio" o "Bureau" restituisce gli eventi relativi ai luoghi di lavoro di tipo officeLocation, mentre cerca "Fuori sede" o "Abwesend" e restituisce gli eventi fuori sede. (Facoltativo)
sharedExtendedProperty string Vincolo di proprietà estese specificato come proprietàName=value. Corrisponde solo alle proprietà condivise. Questo parametro può essere ripetuto più volte per restituire eventi che corrispondono a tutti i vincoli specificati.
showDeleted boolean Indica se includere eventi eliminati (con status è uguale a "cancelled") nel risultato. Le istanze annullate di eventi ricorrenti (ma non l'evento ricorrente sottostante) verranno comunque incluse se showDeleted e singleEvents sono entrambi False. Se showDeleted e singleEvents sono entrambi True, vengono restituite solo singole istanze degli eventi eliminati (ma non gli eventi ricorrenti sottostanti). (Facoltativo) Il valore predefinito è False.
showHiddenInvitations boolean Indica se includere inviti nascosti nel risultato. (Facoltativo) Il valore predefinito è False.
singleEvents boolean Indica se espandere gli eventi ricorrenti in istanze e restituire solo singoli eventi una tantum e istanze di eventi ricorrenti, ma non gli eventi ricorrenti sottostanti. (Facoltativo) Il valore predefinito è False.
syncToken string Token ottenuto dal campo nextSyncToken restituito nell'ultima pagina dei risultati della precedente richiesta di elenco. Il risultato di questa richiesta di elenco contiene solo le voci che sono cambiate da allora. Tutti gli eventi eliminati dalla precedente richiesta di elenco saranno sempre nel set di risultati e non è consentito impostare showDeleted su False.
Esistono diversi parametri di query che non possono essere specificati insieme a nextSyncToken per garantire la coerenza dello stato del client.

Si tratta di:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
Per evitare comportamenti indefiniti, tutti gli altri parametri di query devono essere gli stessi della sincronizzazione iniziale. Se syncToken scade, il server risponderà con un codice di risposta 410 GONE e il client dovrebbe cancellare lo spazio di archiviazione ed eseguire una sincronizzazione completa senza syncToken.
Scopri di più sulla sincronizzazione incrementale.
Facoltativa. L'impostazione predefinita è la restituzione di tutte le voci.
timeMax datetime Limite superiore (esclusivo) relativo all'ora di inizio di un evento in base al quale applicare il filtro. (Facoltativo) L'impostazione predefinita non è filtrare in base all'ora di inizio. Deve essere un timestamp RFC3339 con una differenza di fuso orario obbligatoria, ad esempio 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. I millisecondi possono essere specificati, ma questi vengono ignorati. Se timeMin è impostato, timeMax deve essere maggiore di timeMin.
timeMin datetime Limite inferiore (esclusivo) per l'ora di fine di un evento in base al quale applicare il filtro. (Facoltativo) L'impostazione predefinita non è filtrare in base all'ora di fine. Deve essere un timestamp RFC3339 con una differenza di fuso orario obbligatoria, ad esempio 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. I millisecondi possono essere specificati, ma questi vengono ignorati. Se timeMax è impostato, il valore di timeMin deve essere inferiore a timeMax.
timeZone string Fuso orario utilizzato nella risposta. (Facoltativo) Il valore predefinito è il fuso orario del calendario.
updatedMin datetime Limite inferiore relativo all'ora dell'ultima modifica di un evento (come timestamp RFC3339) in base al quale applicare il filtro. Se specificato, le voci eliminate da questo momento saranno sempre incluse, indipendentemente da showDeleted. (Facoltativo) Per impostazione predefinita, non è possibile filtrare in base all'ora dell'ultima modifica.

Autorizzazione

Questa richiesta consente 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.events.readonly
https://www.googleapis.com/auth/calendar.events

Per ulteriori informazioni, 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#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
Nome proprietà Valore Descrizione Note
kind string Tipo di raccolta ("calendar#events").
etag etag ETag della raccolta.
summary string Titolo del calendario. Sola lettura.
description string Descrizione del calendario. Sola lettura.
updated datetime Ora dell'ultima modifica del calendario (come timestamp RFC3339). Sola lettura.
timeZone string Il fuso orario del calendario. Sola lettura.
accessRole string Il ruolo di accesso dell'utente per questo calendario. Sola lettura. I valori possibili sono:
  • "none" - L'utente non ha accesso.
  • "freeBusyReader" - L'utente ha accesso in lettura alle informazioni sulla disponibilità.
  • "reader" - L'utente ha accesso in lettura al calendario. Gli eventi privati saranno visibili agli utenti con accesso in lettura, ma i relativi dettagli saranno nascosti.
  • "writer" - L'utente dispone dell'accesso in lettura e scrittura al calendario. Gli eventi privati verranno mostrati agli utenti con accesso in scrittura e i dettagli degli eventi saranno visibili.
  • "owner" - L'utente ha la proprietà del calendario. Questo ruolo possiede tutte le autorizzazioni del ruolo Writer con un'ulteriore possibilità di visualizzare e gestire gli ACL.
defaultReminders[] list I promemoria predefiniti nel calendario per l'utente autenticato. Questi promemoria si applicano a tutti gli eventi di questo calendario che non li sostituiscono esplicitamente (ad esempio, il criterio reminders.useDefault non è impostato su True).
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 aggiungi un promemoria.

 accessibile in scrittura
defaultReminders[].minutes integer Numero di minuti prima dell'inizio dell'evento quando deve essere attivato il promemoria. I valori validi sono compresi tra 0 e 40320 (4 settimane in minuti).

Obbligatorio quando aggiungi un promemoria.

 accessibile in scrittura
nextPageToken string Token utilizzato per accedere alla pagina successiva di questo risultato. Omesso se non sono disponibili ulteriori risultati, in questo caso viene fornito il valore nextSyncToken.
items[] list Elenco degli eventi nel calendario.
nextSyncToken string Token utilizzato in un secondo momento per recuperare solo le voci che sono state modificate dopo che è stato restituito questo risultato. Omesso se sono disponibili ulteriori risultati, in questo caso viene fornito il valore nextPageToken.

Esempi

Nota: gli esempi di codice disponibili per questo metodo non rappresentano tutti i linguaggi di programmazione supportati (consulta la pagina relativa alle librerie client per un elenco dei linguaggi supportati).

Java

Utilizza la libreria client Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;
import com.google.api.services.calendar.model.Events;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over the events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').setPageToken(pageToken).execute();
  List<Event> items = events.getItems();
  for (Event event : items) {
    System.out.println(event.getSummary());
  }
  pageToken = events.getNextPageToken();
} while (pageToken != null);

Python

Utilizza la libreria client Python.

page_token = None
while True:
  events = service.events().list(calendarId='primary', pageToken=page_token).execute()
  for event in events['items']:
    print event['summary']
  page_token = events.get('nextPageToken')
  if not page_token:
    break

PHP

Utilizza la libreria client PHP.

$events = $service->events->listEvents('primary');

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->listEvents('primary', $optParams);
  } else {
    break;
  }
}

Ruby

Utilizza la libreria client Ruby.

page_token = nil
begin
  result = client.list_events('primary', page_token: page_token)
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

Prova

Usa Explorer API in basso per chiamare questo metodo sui dati in tempo reale e visualizzare la risposta.