Events: list

Nota: autorizzazione facoltativa.

Restituisce eventi nel calendario specificato. Prova subito o visualizza un esempio.

Richiesta

Richiesta HTTP

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

Parametri

Nome del parametro	Valore	Descrizione
Parametri del percorso
calendarId	string	Identificatore del calendario. Per recuperare gli ID calendario, chiama il metodo calendarList.list. Se vuoi accedere al calendario principale dell'utente che ha effettuato l'accesso, utilizza la parola chiave "primary".
Parametri di query facoltativi
alwaysIncludeEmail	boolean	Obsoleto e ignorato.
eventTypes	string	Tipi di evento da restituire. Campo 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. "outOfOffice": eventi fuori sede. "workingLocation": eventi relativi al luogo di lavoro.
iCalUID	string	Specifica un ID evento nel formato iCalendar da fornire nella risposta. Campo facoltativo. Utilizza questa opzione se vuoi cercare un evento in base al relativo ID iCalendar.
maxAttendees	integer	Il numero massimo di partecipanti da includere nella risposta. Se il numero di partecipanti è superiore a quello specificato, viene restituito solo il partecipante. Campo facoltativo.
maxResults	integer	Numero massimo di eventi restituiti su una pagina di risultati. Il numero di eventi nella pagina risultante potrebbe essere inferiore a questo valore o essere nessuno, 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. Le dimensioni della pagina non possono mai superare i 2500 eventi. Campo facoltativo.
orderBy	string	L'ordine degli eventi restituiti nel risultato. Campo 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 (ovvero il parametro singleEvents è True) "updated": ordina in base all'ora dell'ultima modifica (ordine crescente).
pageToken	string	Token che specifica quale pagina di risultati restituire. Campo facoltativo.
privateExtendedProperty	string	Vincolo di proprietà estese specificato come PropertyName=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 inoltre a parole chiave predefinite con tutte le traduzioni dei titoli visualizzati di eventi relativi a luogo di lavoro, fuori sede e momento di concentrazione. Ad esempio, la ricerca di "Ufficio" o "Bureau" restituisce eventi relativi ai luoghi di lavoro di tipo officeLocation, mentre la ricerca di "Fuori sede" o "Abwesend" restituisce gli eventi fuori sede. Campo facoltativo.
sharedExtendedProperty	string	Vincolo di proprietà estese specificato come PropertyName=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) saranno comunque incluse se showDeleted e singleEvents sono entrambi False. Se showDeleted e singleEvents sono entrambi True, vengono restituite solo le singole istanze degli eventi eliminati (ma non gli eventi ricorrenti sottostanti). Campo facoltativo. Il valore predefinito è False.
showHiddenInvitations	boolean	Se includere inviti nascosti nel risultato. Campo facoltativo. Il valore predefinito è False.
singleEvents	boolean	Consente di indicare 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. Campo facoltativo. Il valore predefinito è False.
syncToken	string	Token ottenuto dal campo nextSyncToken restituito nell'ultima pagina di risultati della precedente richiesta di elenco. In questo modo, il risultato di questa richiesta di elenco contiene solo le voci che sono cambiate da allora. Tutti gli eventi eliminati poiché la 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. Queste sono: iCalUID orderBy privateExtendedProperty q sharedExtendedProperty timeMin timeMax updatedMin Per evitare un comportamento non definito, tutti gli altri parametri di query devono essere gli stessi della sincronizzazione iniziale. Se il valore syncToken scade, il server risponderà con un codice di risposta 410 GONE e il client dovrebbe cancellare i dati dello spazio di archiviazione ed eseguire una sincronizzazione completa senza syncToken. Scopri di più sulla sincronizzazione incrementale. Facoltativa. L'impostazione predefinita è restituire tutte le voci.
timeMax	datetime	Limite superiore (esclusivo) per l'ora di inizio di un evento in base al quale applicare il filtro. Campo facoltativo. L'impostazione predefinita non è il filtro in base all'ora di inizio. Deve essere un timestamp RFC3339 con offset di fuso orario obbligatorio, ad esempio 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. È possibile specificare i millisecondi, ma vengono ignorati. Se timeMin è impostato, il valore del campo timeMax deve essere maggiore di timeMin.
timeMin	datetime	Limite inferiore (esclusivo) relativo all'ora di fine di un evento in base al quale applicare il filtro. Campo facoltativo. L'impostazione predefinita non è il filtro in base all'ora di fine. Deve essere un timestamp RFC3339 con offset di fuso orario obbligatorio, ad esempio 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. È possibile specificare i millisecondi, ma vengono ignorati. Se timeMax è impostato, il valore del campo timeMin deve essere inferiore a timeMax.
timeZone	string	Fuso orario utilizzato nella risposta. Campo 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 a partire da questa data/ora verranno sempre incluse indipendentemente da showDeleted. Campo facoltativo. L'impostazione predefinita non è il filtro 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 relativa a autenticazione e autorizzazione.

Corpo della richiesta

Non fornire il corpo di una richiesta con questo metodo.

Risposta

Se l'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 (sotto forma di 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 sullo stato disponibile/occupato. "reader": l'utente ha accesso in lettura al calendario. Gli eventi privati verranno mostrati agli utenti con accesso in lettura, ma i relativi dettagli saranno nascosti. "writer": l'utente ha accesso in lettura e scrittura al calendario. Gli eventi privati verranno mostrati agli utenti con accesso come autore e i dettagli degli eventi saranno visibili. "owner": l'utente è proprietario del calendario. Questo ruolo dispone di tutte le autorizzazioni del ruolo writer con l'ulteriore possibilità di visualizzare e modificare 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 ignorano esplicitamente (ovvero non hanno reminders.useDefault impostato su True).
defaultReminders[].method	string	Il metodo utilizzato per il promemoria. I valori possibili sono: "email" - I promemoria vengono inviati via email. "popup": i promemoria vengono inviati in un popup UI. Obbligatorio quando aggiungi un promemoria.	scrivibile
defaultReminders[].minutes	integer	Numero di minuti prima dell'inizio dell'evento in cui dovrebbe essere attivato il promemoria. I valori validi sono compresi tra 0 e 40320 (4 settimane in minuti). Obbligatorio quando aggiungi un promemoria.	scrivibile
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 di eventi nel calendario.
nextSyncToken	string	Token utilizzato in un secondo momento per recuperare solo le voci che sono cambiate da quando è stato restituito questo risultato. Omesso se sono disponibili ulteriori risultati, nel qual caso viene fornito 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 di 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.

Utilizza Explorer API di seguito per chiamare questo metodo sui dati in tempo reale e visualizzare la risposta.