Events

L'API Calendar fornisce diverse varianti di risorse per gli eventi. Per saperne di più, consulta la sezione Informazioni sugli eventi.

Per un elenco dei metodi per questa risorsa, consulta la 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
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
Nome proprietà Valore Descrizione Note
anyoneCanAddSelf boolean Indica se chiunque può invitarsi all'evento (funzionalità ritirata). Facoltativo. Il valore predefinito è False. scrivibile
attachments[] list File allegati all'evento.

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

Possono esserci al massimo 25 allegati per evento,

attachments[].fileId string ID del file allegato. Sola lettura.

Per i file di Google Drive, questo è l'ID della voce di 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.

scrivibile
attachments[].mimeType string Tipo di media internet (tipo MIME) dell'allegato.
attachments[].title string Titolo dell'allegato.
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
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[].id string L'ID profilo del partecipante, se disponibile.
attendees[].optional boolean Indica 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 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
attendees[].self boolean Indica se questa voce rappresenta il calendario in cui viene visualizzata questa copia dell'evento. Sola lettura. Il valore predefinito è False.
birthdayProperties nested object Dati relativi a compleanni o eventi speciali. Utilizzato se eventType è "birthday". Immutabile. scrivibile
birthdayProperties.contact string Il nome della risorsa del contatto a cui è collegato questo evento di compleanno. Può essere utilizzato per recuperare i dettagli di contatto dall'API People. Formato: "people/c12345". Sola lettura.
birthdayProperties.customTypeName string Etichetta del tipo personalizzato specificata per questo evento. Questo campo viene compilato se birthdayProperties.type è impostato su "custom". Sola lettura.
birthdayProperties.type string Tipo di compleanno o evento speciale. I valori possibili sono:
  • "anniversary": un anniversario diverso dal compleanno. Ha sempre un contact.
  • "birthday": un evento di compleanno. Questo è il valore predefinito.
  • "custom": una data speciale la cui etichetta è ulteriormente specificata nel campo customTypeName. Ha sempre un contact.
  • "other": una data speciale che non rientra nelle altre categorie e non ha un'etichetta personalizzata. Ha sempre un contact.
  • "self": il compleanno del proprietario del calendario. Non può avere un contact.
L'API Calendar supporta solo la creazione di eventi di tipo "birthday". Il tipo non può essere modificato dopo la creazione dell'evento.
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
conferenceData.conferenceId string L'ID della conferenza.

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

Il valore dell'ID viene formato in modo diverso per ogni tipo di soluzione per conferenze:

  • eventHangout: L'ID non è impostato. (Questo tipo di conferenza è deprecato.)
  • eventNamedHangout: ID è il nome dell'Hangout. (Questo tipo di conferenza è deprecato.)
  • hangoutsMeet: l'ID è il codice riunione di 10 lettere, ad esempio aaa-bbbb-ccc.
  • addOn: l'ID è definito dal fornitore di terze parti.
(Facoltativo)

conferenceData.conferenceSolution nested object La soluzione di conferenza, ad esempio Google Meet.

Annullato per una conferenza con una richiesta di creazione non riuscita.

È obbligatorio specificare conferenceSolution e almeno un entryPoint oppure createRequest.

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 di conferenza 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 accesso. Tuttavia, non dovrebbe consentire modifiche.

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (ritirato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione di conferenza, ma non è possibile creare nuove conferenze)
  • "eventNamedHangout" per la versione classica di Hangouts per gli utenti di Google Workspace (ritirato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per conferenze, ma non è possibile creare nuove conferenze)
  • "hangoutsMeet" per Google Meet (http://meet.google.com)
  • "addOn" per i 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.

È obbligatorio specificare conferenceSolution e almeno un entryPoint oppure createRequest.

conferenceData.createRequest.conferenceSolutionKey nested object La soluzione di conferenza, ad esempio 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 accesso. Tuttavia, non dovrebbe consentire modifiche.

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (ritirato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione di conferenza, ma non è possibile creare nuove conferenze)
  • "eventNamedHangout" per la versione classica di Hangouts per gli utenti di Google Workspace (ritirato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per conferenze, ma non è possibile creare nuove conferenze)
  • "hangoutsMeet" per Google Meet (http://meet.google.com)
  • "addOn" per i 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, la richiesta viene ignorata.

conferenceData.createRequest.status nested object Lo stato della richiesta di creazione della conferenza.
conferenceData.createRequest.status.statusCode string Lo 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": la richiesta di creazione della conferenza è andata a buon fine, i punti di accesso sono compilati.
  • "failure": la richiesta di creazione della conferenza non è riuscita, non sono presenti entry point.

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

Tutti devono appartenere alla stessa conferenza.

È obbligatorio specificare conferenceSolution e almeno un entryPoint oppure createRequest.

conferenceData.entryPoints[].accessCode string Il codice di accesso alla conferenza. La lunghezza massima è di 128 caratteri.

Quando crei nuovi dati della conferenza, compila solo il sottoinsieme dei campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore della conferenza. Vengono visualizzati solo i campi compilati.

Facoltativo.

conferenceData.entryPoints[].entryPointType string Il tipo di punto di ingresso della conferenza.

I valori possibili sono:

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

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

Esempi:

  • per video: meet.google.com/aaa-bbbb-ccc
  • 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 della conferenza, compila solo il sottoinsieme dei campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore della conferenza. Vengono 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 della conferenza, compila solo il sottoinsieme dei campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore della conferenza. Vengono 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 della conferenza, compila solo il sottoinsieme dei campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore della conferenza. Vengono 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 della conferenza, compila solo il sottoinsieme dei campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore della conferenza. Vengono visualizzati solo i campi compilati.

Facoltativo.

conferenceData.entryPoints[].uri string L'URI del punto di accesso. La lunghezza massima è di 1300 caratteri.

Formato:

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

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

Generato lato server.

Annullato 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 Il creatore dell'evento. Sola lettura.
creator.displayName string Il nome del creator, se disponibile.
creator.email string L'indirizzo email del creator, se disponibile.
creator.id string L'ID profilo del creator, se disponibile.
creator.self boolean Indica se il creatore corrisponde al calendario in cui viene visualizzata questa copia dell'evento. Sola lettura. Il valore predefinito è False.
description string Descrizione dell'evento. Può contenere HTML. Facoltativo. scrivibile
end nested object L'ora di fine dell'evento (esclusa). Per un evento ricorrente, si tratta dell'ora di fine della prima istanza.
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
endTimeUnspecified boolean Indica se l'ora di fine non è specificata. Viene comunque fornito un orario di fine per motivi di compatibilità, 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 e si ripete ogni anno.
  • "default": un evento regolare o non specificato ulteriormente.
  • "focusTime": un evento di momento di concentrazione.
  • "fromGmail" - Un evento da Gmail. Non è possibile creare questo tipo di evento.
  • "outOfOffice": un evento fuori sede.
  • "workingLocation": un evento del luogo di lavoro.
scrivibile
extendedProperties object Proprietà estese dell'evento.
extendedProperties.private object Proprietà private della copia dell'evento visualizzata in questo calendario. scrivibile
extendedProperties.private.(key) string Il nome della proprietà privata e il valore corrispondente.
extendedProperties.shared object Proprietà condivise tra le copie dell'evento nei calendari degli altri invitati. scrivibile
extendedProperties.shared.(key) string Il nome della proprietà condivisa e il valore corrispondente.
focusTimeProperties nested object Dati degli eventi di momento di concentrazione. Utilizzato se eventType è focusTime. scrivibile
focusTimeProperties.autoDeclineMode string Se rifiutare gli inviti alle riunioni che si sovrappongono agli eventi di momento di concentrazione. I valori validi sono declineNone, il che significa che nessun invito a una riunione viene rifiutato; declineAllConflictingInvitations, il che significa che tutti gli inviti a una riunione in conflitto con l'evento vengono rifiutati; e declineOnlyNewConflictingInvitations, il che significa che vengono rifiutati solo i nuovi inviti a una riunione 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 viene rifiutato automaticamente da Calendar.
gadget object Un gadget che estende questo evento. I gadget sono deprecati. Questa struttura viene invece 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 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.preferences.(key) string Il nome della preferenza e il valore corrispondente.
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
iCalUID string Identificatore univoco evento come definito nel documento 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 solo uno dei due 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 tutti 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 eventi singoli o ricorrenti, puoi specificarne gli ID. Gli ID forniti devono rispettare le seguenti regole:
  • I caratteri consentiti nell'ID sono quelli utilizzati nella codifica base32hex, ovvero le lettere minuscole a-v e le cifre 0-9.Vedi la sezione 3. 1.2 di RFC2938.
  • La lunghezza dell'ID deve essere compresa tra 5 e 1024 caratteri
  • l'ID deve essere univoco per ogni calendario
A causa della natura distribuita a livello globale del sistema, non possiamo garantire che le collisioni di ID vengano rilevate al momento della creazione dell'evento. Per ridurre al minimo il rischio di collisioni, ti consigliamo di utilizzare un algoritmo UUID consolidato, ad esempio 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 dei due 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 tutti gli stessi icalUID.

scrivibile
kind string Il tipo di risorsa ("calendar#event").
location string La posizione geografica dell'evento come testo in formato libero. Facoltativo. scrivibile
locked boolean Indica se si tratta di una copia bloccata dell'evento in cui non è possibile apportare modifiche ai campi principali dell'evento "Riepilogo", "Descrizione", "Luogo", "Inizio", "Fine" 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 quando importi un evento. scrivibile
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 secondo lo standard RFC5322. scrivibile
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. Sola lettura. Il valore predefinito è False.
originalStartTime nested object Per un'istanza di un evento ricorrente, questo è l'orario in cui l'evento dovrebbe iniziare in base ai dati di 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 a un altro orario. Immutabile.
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
outOfOfficeProperties.autoDeclineMode string Se rifiutare gli inviti alle riunioni che si sovrappongono agli eventi fuori sede. I valori validi sono declineNone, il che significa che nessun invito a una riunione viene rifiutato; declineAllConflictingInvitations, il che significa che tutti gli inviti a una riunione in conflitto con l'evento vengono rifiutati; e declineOnlyNewConflictingInvitations, il che significa che vengono rifiutati solo i nuovi inviti a una riunione 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 viene rifiutato automaticamente da Calendar.
privateCopy boolean Se impostato su True, la propagazione degli eventi è disattivata. Tieni presente che non si tratta della stessa cosa delle proprietà evento privato. 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; 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
recurringEventId string Per un'istanza di un evento ricorrente, questo è l'id dell'evento ricorrente a cui appartiene questa istanza. Immutabile.
reminders object Informazioni sui promemoria dell'evento per l'utente autenticato. Tieni presente che la modifica dei promemoria non comporta anche la modifica della proprietà updated dell'evento contenitore.
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 object L'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 dal creator dell'evento.
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 nested object L'ora di inizio (inclusa) dell'evento. Per un evento ricorrente, si tratta dell'ora di inizio della prima istanza.
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 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
updated datetime Ora dell'ultima modifica dei dati dell'evento principale (come timestamp RFC3339). L'aggiornamento dei promemoria degli eventi non comporterà questa modifica. 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 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

Metodi

elimina
Elimina un evento.
get
Restituisce un evento in base al suo 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. Possono essere importati solo gli eventi con un eventType di default.

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

insert
Crea un evento.
istanze
Restituisce le istanze dell'evento ricorrente specificato.
list
Restituisce gli eventi nel calendario specificato.
move
Sposta un evento in un altro calendario, ovvero cambia l'organizzatore di un evento. Tieni presente che è possibile spostare solo gli eventi default; gli eventi birthday, focusTime, fromGmail, outOfOffice e workingLocation non possono essere spostati.
patch
Aggiorna un evento. Questo metodo supporta la semantica delle patch. Tieni presente che ogni richiesta di patch consuma tre unità di quota. Ti consigliamo di utilizzare un get seguito da un update. I valori dei campi che specifichi sostituiscono i valori esistenti. I campi non specificati nella richiesta rimangono invariati. I campi array, se specificati, sovrascrivono gli array esistenti, eliminando tutti gli elementi dell'array precedenti.
quickAdd
Crea un evento basato su una semplice stringa di testo.
aggiornamento
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à.
watch
Controlla le modifiche alle risorse Eventi.