Events: update

Aggiorna un evento. Questo metodo non supporta la semantica delle patch e aggiorna sempre l'intera risorsa evento. Per eseguire un aggiornamento parziale, esegui un'operazione get seguita da un'operazione update utilizzando gli ETag per garantire l'atomicità. Prova subito.

Richiesta

Richiesta HTTP

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

Parametri

Nome 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 attualmente connesso, utilizza la parola chiave "primary".
eventId string Identificatore dell'evento.
Parametri di query facoltativi
alwaysIncludeEmail boolean Deprecato e ignorato. Nel campo email verrà sempre restituito un valore per l'organizzatore, il creatore e i partecipanti, anche se non è disponibile un indirizzo email reale (ovvero verrà fornito un valore generato e non funzionante).
conferenceDataVersion integer Numero di versione dei dati della conferenza supportati dal client API. La versione 0 non prevede il supporto dei dati della conferenza e ignora i dati della conferenza nel corpo dell'evento. La versione 1 consente di copiare ConferenceData e di creare nuove conferenze utilizzando il campo createRequest di conferenceData. Il valore predefinito è 0. I valori accettabili sono compresi tra 0 e 1 inclusi.
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. Facoltativo.
sendNotifications boolean Deprecato. Utilizza invece sendUpdates.

Indica se inviare notifiche relative all'aggiornamento dell'evento (ad esempio, modifiche alla descrizione e così via). Tieni presente che alcune email potrebbero comunque essere inviate anche se imposti il valore su false. Il valore predefinito è false.
sendUpdates string Gli invitati che devono ricevere notifiche sull'aggiornamento dell'evento (ad esempio, modifiche al titolo e così via).

I valori accettati sono:
  • "all": le notifiche vengono inviate a tutti gli ospiti.
  • "externalOnly": le notifiche vengono inviate solo agli invitati non Google Calendar.
  • "none": non vengono inviate notifiche. Per le attività di migrazione del calendario, valuta la possibilità di utilizzare il metodo Events.import.
supportsAttachments boolean Indica se il client API che esegue l'operazione supporta gli allegati agli eventi. Facoltativo. Il valore predefinito è False.

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti:

Ambito
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

Per saperne di più, consulta la pagina Autenticazione e autorizzazione.

Corpo della richiesta

Nel corpo della richiesta, fornisci una risorsa Events con le seguenti proprietà:

Nome proprietà Valore Descrizione Note
Proprietà obbligatorie
end nested object L'ora di fine dell'evento (esclusa). Per un evento ricorrente, si tratta dell'ora di fine della prima istanza.
start nested object L'ora di inizio (inclusa) dell'evento. Per un evento ricorrente, si tratta dell'ora di inizio della prima istanza.
Proprietà facoltative
anyoneCanAddSelf boolean Indica se chiunque può invitarsi all'evento (funzionalità ritirata). Facoltativo. Il valore predefinito è False. scrivibile
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.

 scrivibile
attendees[] list I partecipanti all'evento. Per saperne di più sulla pianificazione di eventi con altri utenti del calendario, consulta la guida Eventi con invitati. Per compilare l'elenco dei partecipanti, i service account devono utilizzare la delega dell'autorità a livello di dominio. scrivibile
attendees[].additionalGuests integer Numero di ospiti aggiuntivi. Facoltativo. Il valore predefinito è 0. scrivibile
attendees[].comment string Il commento di risposta del partecipante. Facoltativo. scrivibile
attendees[].displayName string Il nome del partecipante, se disponibile. Facoltativo. scrivibile
attendees[].email string L'indirizzo email del partecipante, se disponibile. Questo campo deve essere presente quando viene aggiunto un partecipante. Deve essere un indirizzo email valido secondo lo standard RFC5322.

Obbligatorio quando viene aggiunto un partecipante.

 scrivibile
attendees[].optional boolean Indica se si tratta di un partecipante facoltativo. Facoltativo. Il valore predefinito è False. scrivibile
attendees[].resource boolean Indica 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. scrivibile
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.
 scrivibile
attendeesOmitted boolean Indica se i partecipanti potrebbero essere stati omessi dalla rappresentazione dell'evento. Quando recuperi un evento, questo potrebbe essere dovuto a una limitazione specificata dal parametro di query maxAttendee. Quando aggiorni un evento, puoi utilizzare questo campo per aggiornare solo la risposta del partecipante. Facoltativo. Il valore predefinito è False. scrivibile
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 colori). Facoltativo. scrivibile
conferenceData nested object Le informazioni relative alla conferenza, ad esempio i dettagli di una conferenza Google Meet. Per creare nuovi dettagli della conferenza, utilizza il campo createRequest. Per rendere permanenti le modifiche, ricorda di impostare il parametro di richiesta conferenceDataVersion su 1 per tutte le richieste di modifica degli eventi. scrivibile
description string Descrizione dell'evento. Può contenere HTML. Facoltativo. scrivibile
end.date date La data, nel formato "aaaa-mm-gg", se l'evento dura tutto il giorno. scrivibile
end.dateTime datetime L'ora, come valore combinato di data e ora (formattato in base allo standard RFC3339). È necessario un offset del fuso orario, a meno che non sia specificato esplicitamente in timeZone. scrivibile
end.timeZone string Il fuso orario in cui è specificato l'orario. (Formattato come nome del database dei fusi orari IANA, ad es. "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
extendedProperties.private object Proprietà private della copia dell'evento visualizzata in questo calendario. scrivibile
extendedProperties.shared object Proprietà condivise tra le copie dell'evento nei calendari degli altri invitati. scrivibile
focusTimeProperties nested object Dati degli eventi di momento di concentrazione. Utilizzato se eventType è focusTime. scrivibile
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 di Calendar.
  • "chip" - Il gadget viene visualizzato quando si fa clic sull'evento.
 scrivibile
gadget.height integer L'altezza del gadget in pixel. L'altezza deve essere un numero intero maggiore di 0. Facoltativo. Deprecato. scrivibile
gadget.preferences object Preferenze. scrivibile
gadget.title string Il titolo del gadget. Deprecato. scrivibile
gadget.type string Il tipo di gadget. Deprecato. scrivibile
gadget.width integer La larghezza del gadget in pixel. La larghezza deve essere un numero intero maggiore di 0. Facoltativo. Deprecato. scrivibile
guestsCanInviteOthers boolean Se i partecipanti diversi dall'organizzatore possono invitare altre persone all'evento. Facoltativo. Il valore predefinito è True. scrivibile
guestsCanModify boolean Se i partecipanti diversi dall'organizzatore possono modificare l'evento. Facoltativo. Il valore predefinito è False. scrivibile
guestsCanSeeOtherGuests boolean Indica se i partecipanti diversi dall'organizzatore possono vedere chi sono i partecipanti all'evento. Facoltativo. Il valore predefinito è True. scrivibile
location string La posizione geografica dell'evento come testo in formato libero. Facoltativo. scrivibile
originalStartTime.date date La data, nel formato "aaaa-mm-gg", se l'evento dura tutto il giorno. scrivibile
originalStartTime.dateTime datetime L'ora, come valore combinato di data e ora (formattato in base allo standard RFC3339). È necessario un offset del fuso orario, a meno che non sia specificato esplicitamente in timeZone. scrivibile
originalStartTime.timeZone string Il fuso orario in cui è specificato l'orario. (Formattato come nome del database dei fusi orari IANA, ad es. "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
outOfOfficeProperties nested object Dati degli eventi fuori sede. Utilizzato se eventType è outOfOffice. scrivibile
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; gli orari di inizio e fine dell'evento sono specificati nei campi start e end. Questo campo viene omesso per i singoli eventi o le istanze di eventi ricorrenti. scrivibile
reminders.overrides[] list Se l'evento non utilizza i promemoria predefiniti, vengono elencati i promemoria specifici per l'evento oppure, se non impostati, viene indicato che non sono impostati promemoria per questo evento. Il numero massimo di promemoria di override è 5. scrivibile
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 si aggiunge un promemoria.

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

Obbligatorio quando si aggiunge un promemoria.

 scrivibile
reminders.useDefault boolean Indica se i promemoria predefiniti del calendario si applicano all'evento. scrivibile
sequence integer Numero di sequenza come da iCalendar. scrivibile
source.title string Titolo della fonte, ad esempio il titolo di una pagina web o l'oggetto di un'email. scrivibile
source.url string URL dell'origine che rimanda a una risorsa. Lo schema dell'URL deve essere HTTP o HTTPS. scrivibile
start.date date La data, nel formato "aaaa-mm-gg", se l'evento dura tutto il giorno. scrivibile
start.dateTime datetime L'ora, come valore combinato di data e ora (formattato in base allo standard RFC3339). È necessario un offset del fuso orario, a meno che non sia specificato esplicitamente in timeZone. scrivibile
start.timeZone string Il fuso orario in cui è specificato l'orario. (Formattato come nome del database dei fusi orari IANA, ad es. "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 è confermato provvisoriamente.
  • "cancelled" - L'evento è annullato (eliminato). Il metodo list restituisce gli eventi annullati solo nella sincronizzazione incrementale (quando vengono specificati syncToken o updatedMin) o 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.

      È garantito che le eccezioni annullate abbiano valori solo per i campi id, recurringEventId e originalStartTime. Gli altri campi potrebbero essere vuoti.

    2. Tutti gli altri eventi annullati rappresentano eventi eliminati. I clienti devono rimuovere le copie sincronizzate localmente. Questi eventi annullati alla fine scompariranno, quindi non fare affidamento sulla loro disponibilità a tempo indeterminato.

      È garantito che gli eventi eliminati abbiano solo il campo id compilato.

    Nel calendario dell'organizzatore, gli eventi annullati continuano a mostrare i dettagli (riepilogo, sede e così via) in modo che possano essere ripristinati (recuperati). Allo stesso modo, 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 organizzatore (ad esempio tramite l'operazione Sposta) e l'organizzatore originale non è presente nell'elenco dei partecipanti, verrà lasciato un evento annullato in cui è garantito il popolamento solo del campo id.

scrivibile
summary string Titolo dell'evento. scrivibile
transparency string Indica se l'evento blocca del tempo nel calendario. Facoltativo. I valori possibili sono:
  • "opaque" - Valore predefinito. L'evento blocca l'ora nel calendario. Equivale a impostare Mostrami come su Occupato nella UI di Calendar.
  • "transparent": l'evento non occupa tempo nel calendario. Ciò equivale a impostare Mostrami come su Disponibile nell'interfaccia utente di Calendar.
 scrivibile
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 dell'evento sono visibili a tutti i lettori del calendario.
  • "private": l'evento è privato e solo i partecipanti possono visualizzare i dettagli.
  • "confidential": l'evento è privato. Questo valore viene fornito per motivi di compatibilità.
 scrivibile
workingLocationProperties nested object Dati sugli eventi relativi al luogo di lavoro. scrivibile
workingLocationProperties.customLocation object Se presente, specifica che l'utente lavora da una posizione personalizzata. scrivibile
workingLocationProperties.customLocation.label string Un'etichetta aggiuntiva facoltativa per informazioni aggiuntive. scrivibile
workingLocationProperties.homeOffice any value Se presente, specifica che l'utente sta lavorando da casa. scrivibile
workingLocationProperties.officeLocation object Se presente, specifica che l'utente lavora da un ufficio. scrivibile
workingLocationProperties.officeLocation.buildingId string Un identificatore dell'edificio facoltativo. Deve fare riferimento a un ID edificio nel database delle risorse dell'organizzazione. scrivibile
workingLocationProperties.officeLocation.deskId string Un identificatore della scrivania facoltativo. scrivibile
workingLocationProperties.officeLocation.floorId string Un identificatore del piano facoltativo. scrivibile
workingLocationProperties.officeLocation.floorSectionId string Un identificatore di sezione del piano facoltativo. scrivibile
workingLocationProperties.officeLocation.label string Il nome dell'ufficio visualizzato nei client web e mobile di Calendar. Ti consigliamo di fare riferimento a un nome di edificio nel database delle risorse dell'organizzazione. scrivibile
workingLocationProperties.type string Tipo di luogo di lavoro. I valori possibili sono:
  • "homeOffice": l'utente sta lavorando da casa.
  • "officeLocation": l'utente lavora da un ufficio.
  • "customLocation": l'utente lavora da una località personalizzata.
Eventuali dettagli sono specificati in un campo secondario del nome specificato, ma questo campo potrebbe non essere presente se è vuoto. Tutti gli altri campi vengono ignorati.

Obbligatorio quando vengono aggiunte proprietà del luogo di lavoro.

 scrivibile

Risposta

In caso di esito positivo, questo metodo restituisce una risorsa Events nel corpo della risposta.

Prova

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