Events

L'API Calendar offre diverse tipologie di risorse per gli eventi. Per saperne di più, consulta Informazioni sugli eventi.

Per un elenco di metodi per questa risorsa, vai alla fine di questa pagina.

Rappresentazioni delle risorse

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Nome proprietà Valore Descrizione Note
anyoneCanAddSelf boolean Indica se chiunque può invitarsi all'evento (deprecato). (Facoltativo) Il valore predefinito è False. accessibile in scrittura
attachments[] list Allegati per l'evento.

Per modificare gli allegati, il parametro di richiesta supportsAttachments deve essere impostato su true.

Ogni evento può contenere al massimo 25 allegati,
attachments[].fileId string ID del file allegato. Sola lettura.

Per i file di Google Drive, questo è l'ID della voce della risorsa Files corrispondente nell'API Drive.
attachments[].fileUrl string Link URL all'allegato.

Per aggiungere allegati di file di Google Drive, utilizza lo stesso formato della proprietà alternateLink della risorsa Files nell'API Drive.

Obbligatorio quando si aggiunge un allegato.

 accessibile in scrittura
attachments[].mimeType string Il tipo di media (tipo MIME) dell'allegato su internet.
attachments[].title string Titolo allegato.
attendeesOmitted boolean L'eventualità che i partecipanti siano stati omessi dalla rappresentazione dell'evento. Durante il recupero di un evento, ciò potrebbe essere dovuto a una limitazione specificata dal parametro di query maxAttendee. Quando aggiorni un evento, questa opzione può essere utilizzata solo per aggiornare la risposta del partecipante. (Facoltativo) Il valore predefinito è False. accessibile in scrittura
attendees[] list I partecipanti all'evento. Per ulteriori informazioni sulla programmazione di eventi con altri utenti del calendario, consulta la guida Eventi con partecipanti. Gli account di servizio devono utilizzare la delega dell'autorità a livello di dominio per completare l'elenco dei partecipanti. accessibile in scrittura
attendees[].additionalGuests integer Numero di ospiti aggiuntivi. (Facoltativo) Il valore predefinito è 0. accessibile in scrittura
attendees[].comment string Commento della risposta del partecipante. (Facoltativo) accessibile in scrittura
attendees[].displayName string Il nome del partecipante, se disponibile. (Facoltativo) accessibile in scrittura
attendees[].email string L'indirizzo email del partecipante, se disponibile. Questo campo deve essere presente quando aggiungi un partecipante. Deve essere un indirizzo email valido conforme a RFC5322.

Obbligatorio quando si aggiunge un partecipante.

 accessibile in scrittura
attendees[].id string L'ID profilo del partecipante, se disponibile.
attendees[].optional boolean Se si tratta di un partecipante facoltativo. (Facoltativo) Il valore predefinito è False. scrivibile
attendees[].organizer boolean Se il partecipante è l'organizzatore dell'evento. Sola lettura. Il valore predefinito è False.
attendees[].resource boolean Se il partecipante è una risorsa. Può essere impostato solo quando il partecipante viene aggiunto all'evento per la prima volta. Le modifiche successive vengono ignorate. (Facoltativo) Il valore predefinito è False. accessibile in scrittura
attendees[].responseStatus string Lo stato della risposta del partecipante. I valori possibili sono:
  • "needsAction": il partecipante non ha risposto all'invito (opzione consigliata per i nuovi eventi).
  • "declined" - Il partecipante ha rifiutato l'invito.
  • "tentative" - Il partecipante ha accettato provvisoriamente l'invito.
  • "accepted" - Il partecipante ha accettato l'invito.
 accessibile in scrittura
attendees[].self boolean Se questa voce rappresenta il calendario in cui viene visualizzata la copia dell'evento. Sola lettura. Il valore predefinito è False.
colorId string Il colore dell'evento. Si tratta di un ID che fa riferimento a una voce nella sezione event della definizione dei colori (vedi l' endpoint dei colori). (Facoltativo) accessibile in scrittura
conferenceData nested object Le informazioni relative alla conferenza, ad esempio i dettagli di una conferenza di Google Meet. Per creare nuovi dettagli della conferenza, utilizza il campo createRequest. Per mantenere le modifiche, ricordati di impostare il parametro di richiesta conferenceDataVersion su 1 per tutte le richieste di modifica degli eventi. accessibile in scrittura
conferenceData.conferenceId string L'ID della conferenza.

Può essere utilizzato dagli sviluppatori per tenere traccia delle conferenze, non deve essere mostrato agli utenti.

Il valore dell'ID ha un formato diverso per ogni tipo di soluzione per conferenze:

  • eventHangout: l'ID non è impostato. Questo tipo di conferenza è stato ritirato.
  • eventNamedHangout: ID è il nome dell' Hangout. Questo tipo di conferenza è stato ritirato.
  • hangoutsMeet: l'ID è il codice riunione di 10 lettere, ad esempio aaa-bbbb-ccc.
  • addOn: l'ID viene definito dal fornitore di terze parti.
Facoltativa.
conferenceData.conferenceSolution nested object La soluzione per le conferenze, ad esempio Google Meet.

Annullamento dell'impostazione per una conferenza con una richiesta di creazione non riuscita.

conferenceSolution e almeno un entryPoint o createRequest sono obbligatori.
conferenceData.conferenceSolution.iconUri string L'icona visibile all'utente per questa soluzione.
conferenceData.conferenceSolution.key nested object La chiave che può identificare in modo univoco la soluzione per conferenze per questo evento.
conferenceData.conferenceSolution.key.type string Il tipo di soluzione per conferenze.

Se un client rileva un tipo sconosciuto o vuoto, dovrebbe comunque essere in grado di visualizzare i punti di ingresso. Tuttavia, dovrebbe impedire le modifiche.

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (deprecato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per conferenze, ma non è possibile crearne di nuove)
  • "eventNamedHangout" per gli utenti della versione classica di Hangouts per Google Workspace (ritirata; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per conferenze, ma non è possibile crearne di nuove)
  • "hangoutsMeet" per Google Meet (http://meet.google.com)
  • "addOn" per fornitori di conferenze di terze parti

conferenceData.conferenceSolution.name string Il nome visibile all'utente di questa soluzione. Non localizzato.
conferenceData.createRequest nested object Una richiesta per generare una nuova conferenza e allegarla all'evento. I dati vengono generati in modo asincrono. Per verificare se i dati sono presenti, controlla il campo status.

conferenceSolution e almeno un entryPoint o createRequest sono obbligatori.
conferenceData.createRequest.conferenceSolutionKey nested object La soluzione per conferenze, come Hangouts o Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Il tipo di soluzione per conferenze.

Se un client rileva un tipo sconosciuto o vuoto, dovrebbe comunque essere in grado di visualizzare i punti di ingresso. Tuttavia, dovrebbe impedire le modifiche.

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (deprecato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per conferenze, ma non è possibile crearne di nuove)
  • "eventNamedHangout" per gli utenti della versione classica di Hangouts per Google Workspace (ritirata; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per conferenze, ma non è possibile crearne di nuove)
  • "hangoutsMeet" per Google Meet (http://meet.google.com)
  • "addOn" per fornitori di conferenze di terze parti

conferenceData.createRequest.requestId string L'ID univoco generato dal client per questa richiesta.

I client devono rigenerare questo ID per ogni nuova richiesta. Se un ID fornito è uguale a quello della richiesta precedente, quest'ultima viene ignorata.
conferenceData.createRequest.status nested object Lo stato della richiesta di creazione della conferenza.
conferenceData.createRequest.status.statusCode string Stato attuale della richiesta di creazione della conferenza. Sola lettura.

I valori possibili sono:

  • "pending": la richiesta di creazione della conferenza è ancora in fase di elaborazione.
  • "success": richiesta di creazione della conferenza riuscita; i punti di ingresso sono stati compilati.
  • "failure": richiesta di creazione della conferenza non riuscita. Non sono presenti punti di ingresso.

conferenceData.entryPoints[] list Informazioni sui singoli punti di accesso alle conferenze, come URL o numeri di telefono.

Tutti devono appartenere alla stessa conferenza.

conferenceSolution e almeno un entryPoint o createRequest sono obbligatori.
conferenceData.entryPoints[].accessCode string Il codice di accesso per accedere alla conferenza. La lunghezza massima è di 128 caratteri.

Quando crei nuovi dati di conferenze, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore di conferenze. Devono essere visualizzati solo i campi compilati.

(Facoltativo)
conferenceData.entryPoints[].entryPointType string Il tipo di punto di contatto della conferenza.

I valori possibili sono:

  • "video": partecipazione a una conferenza tramite HTTP. Una conferenza può avere zero o un punto di ingresso video.
  • "phone": partecipa a una conferenza componendo un numero di telefono. Una conferenza può avere zero o più punti di accesso phone.
  • "sip" - partecipazione a una conferenza tramite SIP. Una conferenza può avere zero o un punto di ingresso sip.
  • "more": ulteriori istruzioni per partecipare alla conferenza, ad esempio numeri di telefono aggiuntivi. Una conferenza può avere zero o un punto di ingresso more. Una conferenza con un solo punto di contatto more non è valida.

conferenceData.entryPoints[].label string L'etichetta dell'URI. Visibili agli utenti finali. Non localizzato. La lunghezza massima è di 512 caratteri.

Esempi:

  • per video: meet.google.com/aaa-bbbb-bb
  • per phone: +1 123 268 2601
  • per sip: 12345678@altostrat.com
  • per more: non deve essere compilato

(Facoltativo)
conferenceData.entryPoints[].meetingCode string Il codice riunione per accedere alla conferenza. La lunghezza massima è di 128 caratteri.

Quando crei nuovi dati di conferenze, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore di conferenze. Devono essere visualizzati solo i campi compilati.

(Facoltativo)
conferenceData.entryPoints[].passcode string Il passcode per accedere alla conferenza. La lunghezza massima è di 128 caratteri.

Quando crei nuovi dati di conferenze, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore di conferenze. Devono essere visualizzati solo i campi compilati.
conferenceData.entryPoints[].password string La password per accedere alla conferenza. La lunghezza massima è di 128 caratteri.

Quando crei nuovi dati di conferenze, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore di conferenze. Devono essere visualizzati solo i campi compilati.

(Facoltativo)
conferenceData.entryPoints[].pin string Il PIN per accedere alla conferenza. La lunghezza massima è di 128 caratteri.

Quando crei nuovi dati di conferenze, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore di conferenze. Devono essere visualizzati solo i campi compilati.

(Facoltativo)
conferenceData.entryPoints[].uri string L'URI del punto di ingresso. La lunghezza massima è di 1300 caratteri.

Formato:

  • per lo schema video, http: o https:.
  • per phone, lo schema tel: è obbligatorio. L'URI deve includere l'intera sequenza di chiamata (ad es. tel:+12345678900,,,123456789;1234).
  • per sip è obbligatorio lo schema sip:, ad esempio sip:12345678@myprovider.com.
  • per lo schema more, http: o https: è obbligatorio.

conferenceData.notes string Note aggiuntive (ad esempio istruzioni dell'amministratore di dominio e note legali) da mostrare all'utente. Può contenere codice HTML. La lunghezza massima è di 2048 caratteri. (Facoltativo)
conferenceData.signature string La firma dei dati della conferenza.

Generati sul lato server.

Annullamento dell'impostazione per una conferenza con una richiesta di creazione non riuscita.

Facoltativo per una conferenza con una richiesta di creazione in attesa.
created datetime Ora di creazione dell'evento (come timestamp RFC3339). Sola lettura.
creator object L'autore dell'evento. Sola lettura.
creator.displayName string Il nome del creator, se disponibile.
creator.email string L'indirizzo email dell'autore, se disponibile.
creator.id string L'ID profilo dell'autore, se disponibile.
creator.self boolean Se l'autore corrisponde al calendario in cui viene visualizzata questa copia dell'evento. Di sola lettura. Il valore predefinito è False.
description string Descrizione dell'evento. Può contenere HTML. (Facoltativo) accessibile in scrittura
end nested object L'ora di fine (esclusiva) dell'evento. Per un evento ricorrente, si tratta dell'ora di fine della prima istanza.
end.date date La data nel formato "aaaa-mm-gg", se si tratta di un evento che dura tutto il giorno. accessibile in scrittura
end.dateTime datetime L'ora, come valore combinato di data e ora (formattato in base a RFC3339). La differenza del fuso orario è obbligatoria, a meno che non venga specificato esplicitamente in timeZone un fuso orario. accessibile in scrittura
end.timeZone string Il fuso orario in cui è specificata l'ora. (Formattato come nome del database IANA Time Zone, ad esempio "Europe/Zurich"). Per gli eventi ricorrenti, questo campo è obbligatorio e specifica il fuso orario in cui viene espansa la ricorrenza. Per i singoli eventi, questo campo è facoltativo e indica un fuso orario personalizzato per l'inizio e la fine dell'evento. accessibile in scrittura
endTimeUnspecified boolean Indica se l'ora di fine è effettivamente non specificata. Per motivi di compatibilità, viene comunque fornita una data e un'ora di fine, anche se questo attributo è impostato su True. Il valore predefinito è False.
etag etag ETag della risorsa.
eventType string Tipo specifico di evento. Questo valore non può essere modificato dopo la creazione dell'evento. I valori possibili sono:
  • "birthday" - Un evento speciale che dura tutto il giorno con una ricorrenza annuale.
  • "default" - Un evento regolare o non ulteriormente specificato.
  • "focusTime": un evento di momento di concentrazione.
  • "fromGmail" - Un evento da Gmail. Impossibile creare questo tipo di evento.
  • "outOfOffice" - Un evento fuori sede.
  • "workingLocation": un evento relativo alla sede di lavoro.
 accessibile in scrittura
extendedProperties object Proprietà estese dell'evento.
extendedProperties.private object Proprietà private per la copia dell'evento visualizzato in questo calendario. accessibile in scrittura
extendedProperties.private.(key) string Il nome della proprietà privata e il valore corrispondente.
extendedProperties.shared object Proprietà condivise tra le copie dell'evento negli altri partecipanti calendari. accessibile in scrittura
extendedProperties.shared.(key) string Il nome della proprietà condivisa e il valore corrispondente.
focusTimeProperties nested object Dati dell'evento Momento di concentrazione. Utilizzato se eventType è focusTime. accessibile in scrittura
focusTimeProperties.autoDeclineMode string Indica se rifiutare gli inviti a riunioni che si sovrappongono a eventi di momento di concentrazione. I valori validi sono declineNone, il che significa che nessun invito a riunioni viene rifiutato. declineAllConflictingInvitations, che indica che tutti gli inviti a riunioni in conflitto con l'evento vengono rifiutati; e declineOnlyNewConflictingInvitations, il che significa che verranno rifiutati solo i nuovi inviti a riunioni in conflitto che arrivano mentre è presente l'evento di momento di concentrazione.
focusTimeProperties.chatStatus string Lo stato per contrassegnare l'utente in Chat e nei prodotti correlati. Può essere available o doNotDisturb.
focusTimeProperties.declineMessage string Messaggio di risposta da impostare se un evento esistente o un nuovo invito vengono rifiutati automaticamente da Calendar.
gadget object Un gadget che estende questo evento. I gadget sono deprecati; questa struttura viene utilizzata solo per restituire i metadati del calendario dei compleanni.
gadget.display string La modalità di visualizzazione del gadget. Deprecato. I valori possibili sono:
  • "icon" - Il gadget viene visualizzato accanto al titolo dell'evento nella visualizzazione del calendario.
  • "chip" - Il gadget viene visualizzato quando l'utente fa clic sull'evento.
 accessibile in scrittura
gadget.height integer L'altezza del gadget in pixel. L'altezza deve essere un numero intero maggiore di 0. (Facoltativo) Deprecato. accessibile in scrittura
gadget.preferences object Preferenze. scrivibile
gadget.preferences.(key) string Il nome della preferenza e il valore corrispondente.
gadget.title string Il titolo del gadget. Deprecato. accessibile in scrittura
gadget.type string Il tipo di gadget. Deprecato. accessibile in scrittura
gadget.width integer La larghezza del gadget in pixel. La larghezza deve essere un numero intero maggiore di 0. (Facoltativo) Deprecato. accessibile in scrittura
guestsCanInviteOthers boolean Indica se i partecipanti diversi dall'organizzatore possono invitare altre persone all'evento. (Facoltativo) Il valore predefinito è True. accessibile in scrittura
guestsCanModify boolean Se partecipanti diversi dall'organizzatore possono modificare l'evento. (Facoltativo) Il valore predefinito è False. accessibile in scrittura
guestsCanSeeOtherGuests boolean Se partecipanti diversi dall'organizzatore possono vedere chi sono i partecipanti all'evento. (Facoltativo) Il valore predefinito è True. accessibile in scrittura
iCalUID string Identificatore univoco dell'evento come definito in RFC5545. Viene utilizzato per identificare in modo univoco gli eventi nei sistemi di calendario e deve essere fornito durante l'importazione degli eventi tramite il metodo import.

Tieni presente che iCalUID e id non sono identici e che deve essere fornito solo uno dei due al momento della creazione dell'evento. Una differenza nella loro semantica è che negli eventi ricorrenti, tutte le occorrenze di un evento hanno id diversi mentre condividono gli stessi iCalUID. Per recuperare un evento utilizzando il relativo iCalUID, chiama il metodo events.list utilizzando il parametro iCalUID. Per recuperare un evento utilizzando il relativo id, chiama il metodo events.get.
id string Identificatore opaco dell'evento. Quando crei nuovi eventi singoli o ricorrenti, puoi specificarne gli ID. Gli ID forniti devono rispettare queste regole:
  • I caratteri consentiti nell'ID sono quelli utilizzati nella codifica base32hex, ad esempio lettere minuscole a-v e cifre da 0 a 9; consulta la sezione 3.1.2 in RFC2938
  • la lunghezza dell'ID deve essere compresa tra 5 e 1024 caratteri
  • l'ID deve essere univoco per ogni calendario
Data la natura del sistema distribuita a livello globale, non possiamo garantire che i conflitti di ID vengano rilevati al momento della creazione dell'evento. Per ridurre al minimo il rischio di collisioni, consigliamo di utilizzare un algoritmo UUID consolidato, come quello descritto in RFC4122.

Se non specifichi un ID, questo verrà generato automaticamente dal server.

Tieni presente che icalUID e id non sono identici e solo uno deve essere fornito al momento della creazione dell'evento. Una differenza nella loro semantica è che negli eventi ricorrenti, tutte le occorrenze di un evento hanno id diversi mentre condividono gli stessi icalUID.

 scrivibile
kind string Tipo di risorsa ("calendar#event").
location string La posizione geografica dell'evento come testo in formato libero. (Facoltativo) accessibile in scrittura
locked boolean Indica se si tratta di una copia di un evento bloccato in cui non è possibile apportare modifiche ai campi dell'evento principale "summary", "description", "location", "start", "end" o "ricorrenza". Il valore predefinito è False. Sola lettura.
organizer object L'organizzatore dell'evento. Se l'organizzatore è anche un partecipante, questo viene indicato con una voce separata in attendees con il campo organizer impostato su True. Per cambiare l'organizzatore, utilizza l'operazione sposta. Sola lettura, tranne durante l'importazione di un evento. accessibile in scrittura
organizer.displayName string Il nome dell'organizzatore, se disponibile. scrivibile
organizer.email string L'indirizzo email dell'organizzatore, se disponibile. Deve essere un indirizzo email valido conforme a RFC5322. accessibile in scrittura
organizer.id string L'ID profilo dell'organizzatore, se disponibile.
organizer.self boolean Indica se l'organizzatore corrisponde al calendario in cui viene visualizzata questa copia dell'evento. Di sola lettura. Il valore predefinito è False.
originalStartTime nested object Per un'istanza di un evento ricorrente, si tratta dell'ora in cui l'evento inizierebbe in base ai dati sulla ricorrenza nell'evento ricorrente identificato da recurringEventId. Identifica in modo univoco l'istanza all'interno della serie di eventi ricorrenti anche se l'istanza è stata spostata in un orario diverso. Immutabile.
originalStartTime.date date La data nel formato "aaaa-mm-gg", se si tratta di un evento che dura tutto il giorno. accessibile in scrittura
originalStartTime.dateTime datetime L'ora, come valore combinato di data e ora (formattato in base a RFC3339). La differenza del fuso orario è obbligatoria, a meno che non venga specificato esplicitamente in timeZone un fuso orario. accessibile in scrittura
originalStartTime.timeZone string Il fuso orario in cui è specificata l'ora. (Formattato come nome del database IANA Time Zone, ad esempio "Europe/Zurich"). Per gli eventi ricorrenti, questo campo è obbligatorio e specifica il fuso orario in cui viene espansa la ricorrenza. Per i singoli eventi, questo campo è facoltativo e indica un fuso orario personalizzato per l'inizio e la fine dell'evento. accessibile in scrittura
outOfOfficeProperties nested object Dati sugli eventi fuori sede. Utilizzato se eventType è outOfOffice. accessibile in scrittura
outOfOfficeProperties.autoDeclineMode string Indica se rifiutare gli inviti a riunioni che si sovrappongono a eventi fuori sede. I valori validi sono declineNone, il che significa che nessun invito a riunioni viene rifiutato. declineAllConflictingInvitations, che indica che tutti gli inviti a riunioni in conflitto con l'evento vengono rifiutati; e declineOnlyNewConflictingInvitations, il che significa che verranno rifiutati solo i nuovi inviti a riunioni in conflitto che arrivano mentre è presente l'evento Fuori sede.
outOfOfficeProperties.declineMessage string Messaggio di risposta da impostare se un evento esistente o un nuovo invito vengono rifiutati automaticamente da Calendar.
privateCopy boolean Se impostato su True, la propagazione degli eventi è disattivata. Tieni presente che non è uguale alle proprietà di eventi privati. (Facoltativo) Immutabile. Il valore predefinito è False.
recurrence[] list Elenco di righe RRULE, EXRULE, RDATE ed EXDATE per un evento ricorrente, come specificato in RFC5545. Tieni presente che le righe DTSTART e DTEND non sono consentite in questo campo. le ore di inizio e di fine degli eventi sono specificate nei campi start e end. Questo campo è omesso per singoli eventi o istanze di eventi ricorrenti. scrivibile
recurringEventId string Per un'istanza di un evento ricorrente, è il valore id dell'evento ricorrente a cui appartiene l'istanza. Immutabile.
reminders object Informazioni sui promemoria dell'evento per l'utente autenticato. Tieni presente che la modifica dei promemoria non cambia anche la proprietà updated dell'evento che lo contiene.
reminders.overrides[] list Se l'evento non utilizza i promemoria predefiniti, vengono elencati i promemoria specifici per l'evento oppure, se non è impostato, non è impostato alcun promemoria per l'evento. Il numero massimo di promemoria di override è 5. accessibile in scrittura
reminders.overrides[].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
reminders.overrides[].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
reminders.useDefault boolean Indica se i promemoria predefiniti del calendario si applicano all'evento. accessibile in scrittura
sequence integer Numero di sequenza come per iCalendar. accessibile in scrittura
source object Origine da cui è stato creato l'evento. ad esempio una pagina web, un messaggio email o qualsiasi documento identificabile da un URL con schema HTTP o HTTPS. Può essere visualizzato o modificato solo dall'autore dell'evento.
source.title string Titolo della fonte; ad esempio il titolo di una pagina web o l'oggetto di un'email. accessibile in scrittura
source.url string URL dell'origine che rimanda a una risorsa. Lo schema dell'URL deve essere HTTP o HTTPS. accessibile in scrittura
start nested object L'ora (inclusa) di inizio dell'evento. Per un evento ricorrente, questa è l'ora di inizio della prima istanza.
start.date date La data nel formato "aaaa-mm-gg", se si tratta di un evento che dura tutto il giorno. scrivibile
start.dateTime datetime L'ora, come valore combinato di data e ora (formattato in base a RFC3339). La differenza del fuso orario è obbligatoria, a meno che non venga specificato esplicitamente in timeZone un fuso orario. accessibile in scrittura
start.timeZone string Il fuso orario in cui è specificata l'ora. (Formattato come nome del database IANA Time Zone, ad esempio "Europe/Zurich"). Per gli eventi ricorrenti, questo campo è obbligatorio e specifica il fuso orario in cui viene espansa la ricorrenza. Per i singoli eventi, questo campo è facoltativo e indica un fuso orario personalizzato per l'inizio e la fine dell'evento. scrivibile
status string Stato dell'evento. (Facoltativo) I valori possibili sono:
  • "confirmed" - L'evento è confermato. Questo è lo stato predefinito.
  • "tentative" - L'evento è provvisoriamente confermato.
  • "cancelled" - L'evento è stato annullato (eliminato). Il metodo list restituisce gli eventi annullati solo in caso di sincronizzazione incrementale (quando sono specificati syncToken o updatedMin) oppure se il flag showDeleted è impostato su true. Il metodo get li restituisce sempre.

    Lo stato "Annullato" rappresenta due stati diversi a seconda del tipo di evento:

    1. Le eccezioni annullate di un evento ricorrente non annullato indicano che questa istanza non deve più essere presentata all'utente. I client devono archiviare questi eventi per tutta la durata dell'evento ricorrente principale.

      Per le eccezioni annullate è garantito che i valori dei campi id, recurringEventId e originalStartTime siano compilati solo con la loro compilazione. Gli altri campi potrebbero essere vuoti.

    2. Tutti gli altri eventi annullati rappresentano eventi eliminati. I clienti dovrebbero rimuovere le copie sincronizzate localmente. Questi eventi annullati alla fine scompariranno, quindi non dare per scontato che saranno disponibili a tempo indeterminato.

      Per gli eventi eliminati è garantito che il campo id sia compilato solo.

    Nel calendario dell'organizzatore, gli eventi annullati continuano a mostrare i relativi dettagli (riepilogo, luogo e così via) in modo da poterli ripristinare (ripristinare l'eliminazione). Analogamente, gli eventi a cui l'utente è stato invitato e che ha rimosso manualmente continuano a fornire dettagli. Tuttavia, le richieste di sincronizzazione incrementale con showDeleted impostato su false non restituiranno questi dettagli.

    Se un evento cambia il suo organizzatore (ad esempio tramite l'operazione spostamento) e l'organizzatore originale non è nell'elenco dei partecipanti, lascerà un evento annullato in cui è garantito che venga compilato solo il campo id.

accessibile in scrittura
summary string Titolo dell'evento. accessibile in scrittura
transparency string Se l'evento blocca il tempo sul calendario. (Facoltativo) I valori possibili sono:
  • "opaque" - Valore predefinito. ma l'evento blocca il tempo sul calendario. Equivale a impostare Mostra come su Occupato nell'interfaccia utente di Calendar.
  • "transparent" - L'evento non blocca il tempo sul calendario. Equivale a impostare Mostrami come su Disponibile nell'interfaccia utente di Calendar.
 accessibile in scrittura
updated datetime Ora dell'ultima modifica dei dati degli eventi principali (come timestamp RFC3339). L'aggiornamento dei promemoria degli eventi non ne causerà la modifica. Di sola lettura.
visibility string Visibilità dell'evento. (Facoltativo) I valori possibili sono:
  • "default" - Utilizza la visibilità predefinita per gli eventi nel calendario. Questo è il valore predefinito.
  • "public": l'evento è pubblico e i dettagli sono visibili a tutti i lettori del calendario.
  • "private" - L'evento è privato e solo i partecipanti possono visualizzarne i dettagli.
  • "confidential": l'evento è privato. Questo valore viene fornito per motivi di compatibilità.
 accessibile in scrittura
workingLocationProperties nested object Dati sugli eventi relativi al luogo di lavoro. accessibile in scrittura
workingLocationProperties.customLocation object Se presente, specifica che l'utente sta lavorando da un luogo personalizzato. accessibile in scrittura
workingLocationProperties.customLocation.label string Un'etichetta aggiuntiva facoltativa per ulteriori informazioni. accessibile in scrittura
workingLocationProperties.homeOffice any value Se presente, specifica che l'utente lavora in casa. accessibile in scrittura
workingLocationProperties.officeLocation object Se presente, specifica che l'utente lavora da un ufficio. scrivibile
workingLocationProperties.officeLocation.buildingId string Un identificatore edificio facoltativo. Deve fare riferimento a un ID edificio nel database delle risorse dell'organizzazione. accessibile in scrittura
workingLocationProperties.officeLocation.deskId string Un identificatore scrivania facoltativo. accessibile in scrittura
workingLocationProperties.officeLocation.floorId string Un identificatore del piano facoltativo. accessibile in scrittura
workingLocationProperties.officeLocation.floorSectionId string Un identificatore facoltativo della sezione del piano. accessibile in scrittura
workingLocationProperties.officeLocation.label string Il nome dell'ufficio visualizzato nei client di Calendar per il web e per i dispositivi mobili. Ti consigliamo di fare riferimento al nome di un edificio nel database delle risorse dell'organizzazione. accessibile in scrittura
workingLocationProperties.type string Tipo di luogo di lavoro. I valori possibili sono:
  • "homeOffice" - L'utente lavora da casa.
  • "officeLocation" - L'utente lavora da un ufficio.
  • "customLocation" - L'utente lavora da una località personalizzata.
Tutti i dettagli vengono specificati in un campo secondario del nome specificato, ma questo campo potrebbe mancare se è vuoto. Eventuali altri campi vengono ignorati.

Obbligatorio quando aggiungi le proprietà dei luoghi di lavoro.

 accessibile in scrittura

Metodi

elimina
Elimina un evento.
trova
Restituisci un evento in base al relativo ID Google Calendar. Per recuperare un evento utilizzando il relativo ID iCalendar, chiama il metodo events.list utilizzando il parametro iCalUID.
import
Importa un evento. Questa operazione viene utilizzata per aggiungere una copia privata di un evento esistente a un calendario. È possibile importare solo gli eventi con eventType pari a default.

Comportamento deprecato: se viene importato un evento non default, il suo tipo verrà modificato in default e tutte le eventuali proprietà specifiche del tipo di evento verranno eliminate.

inserisci
Crea un evento.
instances
Restituisci le istanze dell'evento ricorrente specificato.
list
Restituisci gli eventi nel calendario specificato.
move
Sposta un evento in un altro calendario, ad esempio modifica l'organizzatore di un evento. Tieni presente che è possibile spostare solo default eventi. Impossibile spostare gli eventi birthday, focusTime, fromGmail, outOfOffice e workingLocation.
patch
Aggiorna un evento. Questo metodo supporta la semantica delle patch. Tieni presente che ogni richiesta di patch utilizza tre unità di quota; preferisci usare get seguito da update. I valori dei campi specificati sostituiscono quelli esistenti. I campi non specificati nella richiesta rimangono invariati. I campi array, se specificati, sovrascrivono gli array esistenti. Vengono ignorati tutti gli elementi array precedenti.
quickAdd
Crea un evento basato su una semplice stringa di testo.
aggiorna
Aggiorna un evento. Questo metodo non supporta la semantica delle patch e aggiorna sempre l'intera risorsa dell'evento. Per eseguire un aggiornamento parziale, esegui un get seguito da un update utilizzando gli etag per garantire l'atomicità.
orologio
Controlla le modifiche alle risorse Eventi.