Questa guida descrive i calendari, gli eventi e le loro relazioni.
Calendari
Un calendario è una raccolta di eventi correlati, insieme a metadati aggiuntivi come riepilogo, fuso orario predefinito, località e così via. Ogni calendario è identificato da un ID che è un indirizzo email. I calendari possono avere più proprietari.
Eventi
Un evento è un oggetto associato a un intervallo di date o ore specifico. Gli eventi sono identificati da un ID univoco. Oltre a data e ora di inizio e di fine, gli eventi contengono altri dati, ad esempio riepilogo, descrizione, posizione, stato, promemoria, allegati e così via.
Tipi di eventi
Google Calendar supporta eventi singoli e ricorrenti:
- Un evento singolo rappresenta un'occorrenza unica.
- Un evento ricorrente definisce più occorrenze.
Gli eventi possono anche essere a tempo o tutto il giorno:
- Un evento a tempo si verifica tra due momenti specifici. Gli eventi a tempo
utilizzano i campi
start.dateTime
eend.dateTime
per specificare quando si verificano. - Un evento che dura tutto il giorno dura un'intera giornata o serie consecutive di giorni. Gli eventi
che durano tutto il giorno utilizzano i campi
start.date
eend.date
per specificare quando si verificano. Tieni presente che il campo del fuso orario non ha alcun significato per gli eventi che durano tutto il giorno.
Organizzatori
Gli eventi hanno un singolo organizzatore, ovvero il calendario contenente la copia principale dell'evento. Gli eventi possono anche avere più partecipanti. Il partecipante corrisponde in genere al calendario principale di un utente invitato.
Il seguente diagramma mostra la relazione concettuale tra calendari, eventi e altri elementi correlati:
Calendari principali e altri calendari
Un calendario principale è un tipo speciale di calendario associato a un singolo account utente. Questo calendario viene creato automaticamente per ogni nuovo account utente e il suo ID di solito corrisponde all'indirizzo email principale dell'utente. Finché l'account esiste, il suo calendario principale non può mai essere eliminato dall'utente. Tuttavia, potrà essere condiviso con altri utenti.
Oltre al calendario principale, puoi creare esplicitamente altri calendari che puoi modificare, eliminare e condividere tra più utenti.
Calendario ed elenco di calendari
La raccolta Calendari rappresenta tutti i calendari esistenti. Può essere usato per creare ed eliminare calendari. Puoi anche recuperare o impostare proprietà globali condivise tra tutti gli utenti con accesso a un calendario. Ad esempio, il titolo e il fuso orario predefinito di un calendario sono proprietà globali.
CalendarList è una raccolta di tutte le voci di calendario che un utente ha aggiunto al proprio elenco (visualizzate nel riquadro a sinistra della UI web). Puoi usarlo per aggiungere e rimuovere calendari esistenti da/verso l'elenco degli utenti. Puoi utilizzarlo anche per recuperare e impostare i valori delle proprietà del calendario specifiche dell'utente, come i promemoria predefiniti. Un altro esempio è il colore in primo piano, perché utenti diversi possono avere colori diversi nello stesso calendario.
Nella tabella seguente viene confrontato il significato delle operazioni per le due raccolte:
Operazione | Calendari | CalendarList |
---|---|---|
insert |
Crea un nuovo calendario secondario. Per impostazione predefinita, questo calendario viene aggiunto anche all'elenco dei calendari dell'autore. | Inserisce un calendario esistente nell'elenco degli utenti. |
delete |
Elimina un calendario secondario. | Rimuove un calendario dall'elenco dell'utente. |
get |
Recupera i metadati del calendario, ad esempio titolo, fuso orario. | Recupera i metadati, oltre la personalizzazione specifica dell'utente, come promemoria di colore o di override. |
patch /update |
Modifica i metadati del calendario. | Modifica le proprietà dei calendari specifiche dell'utente. |
Eventi ricorrenti
Alcuni eventi si verificano più volte secondo una pianificazione regolare, ad esempio riunioni settimanali, compleanni e festività. A parte avere ore di inizio e di fine diverse, questi eventi ripetuti sono spesso identici.
Gli eventi sono chiamati ricorrenti se si ripetono in base a una pianificazione definita. Gli eventi singoli non sono ricorrenti e si verificano una sola volta.
Regola di ricorrenza
La pianificazione di un evento ricorrente è definita in due parti:
I relativi campi di inizio e fine (che definiscono la prima occorrenza, come se si trattasse di un singolo evento autonomo)
Il relativo campo di ricorrenza (che definisce il modo in cui l'evento deve essere ripetuto nel tempo).
Il campo della ricorrenza contiene un array di stringhe che rappresentano una o più proprietà RRULE
, RDATE
o EXDATE
come definito nel documento RFC 5545.
La proprietà RRULE
è la più importante in quanto definisce una regola regolare
per la ripetizione dell'evento. È composta da diversi componenti. Alcuni di questi sono:
FREQ
: la frequenza con cui l'evento deve essere ripetuto (ad esempioDAILY
oWEEKLY
). Obbligatorio.INTERVAL
: collabora conFREQ
per specificare la frequenza con cui l'evento deve essere ripetuto. Ad esempio,FREQ=DAILY;INTERVAL=2
indica una volta ogni due giorni.COUNT
: numero di volte in cui questo evento deve essere ripetuto.UNTIL
: la data o la data e l'ora fino alla quale l'evento deve essere ripetuto (inclusa).BYDAY
: giorni della settimana in cui l'evento deve essere ripetuto (SU
,MO
,TU
e così via). Altri componenti simili sonoBYMONTH
,BYYEARDAY
eBYHOUR
.
La proprietà RDATE
specifica date o ore aggiuntive in cui si devono verificare l'evento. Ad esempio, RDATE;VALUE=DATE:19970101,19970120
.
Utilizzalo per aggiungere altre occorrenze non coperte dall'RRULE
.
La proprietà EXDATE
è simile a RDATE, ma specifica le date o le date e le ore in cui l'evento non deve verificarsi. In altre parole, queste occorrenze devono
essere escluse. Deve puntare a un'istanza valida generata dalla regola di ricorrenza.
EXDATE
e RDATE
possono avere un fuso orario e devono essere date (non date e ore)
per gli eventi che durano tutto il giorno.
Ciascuna proprietà può trovarsi più volte all'interno del campo della ricorrenza.
La ricorrenza è definita come l'unione di tutte le regole RRULE
e RDATE
, meno quelle escluse da tutte le regole EXDATE
.
Ecco alcuni esempi di eventi ricorrenti:
Un evento che si svolge dalle 6:00 alle 7:00 ogni martedì e venerdì a partire dal 15 settembre 2015 e si interrompe dopo la quinta occorrenza, il 29 settembre:
... "start": { "dateTime": "2015-09-15T06:00:00+02:00", "timeZone": "Europe/Zurich" }, "end": { "dateTime": "2015-09-15T07:00:00+02:00", "timeZone": "Europe/Zurich" }, "recurrence": [ "RRULE:FREQ=WEEKLY;COUNT=5;BYDAY=TU,FR" ], …
Un evento che dura tutto il giorno dal 1° giugno 2015 e si ripete ogni 3 giorni nel corso del mese, escluso il 10 giugno e incluso il 9 e l'11 giugno:
... "start": { "date": "2015-06-01" }, "end": { "date": "2015-06-02" }, "recurrence": [ "EXDATE;VALUE=DATE:20150610", "RDATE;VALUE=DATE:20150609,20150611", "RRULE:FREQ=DAILY;UNTIL=20150628;INTERVAL=3" ], …
Istanze ed eccezioni
Un evento ricorrente è costituito da diverse istanze: le sue occorrenze particolari in momenti diversi. Queste istanze agiscono come eventi stessi.
Le modifiche di eventi ricorrenti possono interessare l'intero evento ricorrente (e tutte le sue istanze) o solo singole istanze. Le istanze che differiscono dall'evento ricorrente principale sono chiamate eccezioni.
Ad esempio, un'eccezione potrebbe avere un riepilogo diverso, un'ora di inizio diversa o partecipanti aggiuntivi invitati solo a quell'istanza. Puoi anche annullare
del tutto un'istanza senza rimuovere l'evento ricorrente
(le cancellazioni delle istanze sono visibili nell'evento
status
).
Qui puoi trovare esempi di come lavorare con eventi e istanze ricorrenti tramite l'API Google Calendar.
Fusi orari
Un fuso orario specifica una regione che osserva un orario standard uniforme. Nell'API Google Calendar, puoi specificare i fusi orari utilizzando gli identificatori del fuso orario IANA.
Puoi impostare il fuso orario sia per i calendari che per gli eventi. Le seguenti sezioni descrivono gli effetti di queste impostazioni.
Fuso orario del calendario
Il fuso orario del calendario è anche noto come fuso orario predefinito a causa delle sue implicazioni per i risultati delle query. Il fuso orario del calendario influisce sul modo in cui i valori temporali vengono interpretati o presentati dai metodi events.get()
, events.list()
e events.instances()
.
- Conversione del fuso orario del risultato della query
- I risultati dei metodi
get()
,list()
einstances()
vengono restituiti nel fuso orario specificato nel parametrotimeZone
. Se ometti questo parametro, tutti questi metodi utilizzano il fuso orario del calendario per impostazione predefinita. - Associare gli eventi che durano tutto il giorno alle query con intervallo temporale
- I metodi
list()
einstances()
consentono di specificare filtri di inizio e fine, in cui il metodo restituisce le istanze che rientrano nell'intervallo specificato. Il fuso orario del calendario viene utilizzato per calcolare l'ora di inizio e di fine degli eventi che durano tutto il giorno e determinare se rientrano nella specifica del filtro.
Fuso orario evento
Le istanze di evento hanno un'ora di inizio e di fine; la specifica di questi orari potrebbe includere il fuso orario. Puoi specificare il fuso orario in diversi modi; tutti i seguenti prevedono lo stesso orario:
- Includi uno scarto di fuso orario nel campo
dateTime
, ad esempio2017-01-25T09:00:00-0500
. - Specifica l'ora senza scarto, ad esempio
2017-01-25T09:00:00
, lasciando vuoto il campotimeZone
(utilizza implicitamente il fuso orario predefinito). - Specifica l'ora senza scarto, ad esempio
2017-01-25T09:00:00
, ma utilizza il campotimeZone
per specificare il fuso orario.
Se preferisci, puoi anche specificare gli orari degli eventi nel fuso orario UTC:
- Specifica l'ora nel formato UTC:
2017-01-25T14:00:00Z
oppure utilizza uno scarto pari a zero2017-01-25T14:00:00+0000
.
La rappresentazione interna dell'ora dell'evento è la stessa in tutti questi casi,
ma impostando il campo timeZone
viene associato un fuso orario all'evento, proprio come
quando imposti il fuso orario dell'evento utilizzando
l'interfaccia utente di Calendar:
Fuso orario evento ricorrente
Per gli eventi ricorrenti, è necessario specificare sempre un unico fuso orario. È necessario per espandere le ricorrenze dell'evento.