Events

L'API Calendar fornisce diverse versioni delle risorse evento. Puoi trovare ulteriori informazioni nella 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ò autoinvitarsi all'evento (opzione non più supportata). (Facoltativo) Il valore predefinito è False. scrivibile
attachments[] list Allegati per l'evento.

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

Possono essere presenti 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 della risorsa Files corrispondente nell'API Drive.
attachments[].fileUrl string Link all'URL dell'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 Il tipo di media (tipo MIME) dell'allegato su internet.
attachments[].title string Titolo dell'allegato.
attendeesOmitted boolean Indica se i partecipanti potrebbero essere stati omessi dalla rappresentazione dell'evento. Quando viene recuperato un evento, questo potrebbe essere dovuto a una limitazione specificata dal parametro di query maxAttendee. Quando aggiorni un evento, puoi utilizzare questo parametro 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. Gli account di servizio devono utilizzare la delegazione dell'autorità a livello di dominio per compilare 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 Il commento alla 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 aggiungi un partecipante. Deve essere un indirizzo email valido come da RFC5322.

Obbligatorio quando si aggiunge un partecipante.

 accessibile in scrittura
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 Indica 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. accessibile in scrittura
birthdayProperties.contact string Nome 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 specificato per questo evento. 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": data di nascita del proprietario del calendario. Non può avere un contact.
L'API Calendar supporta solo la creazione di eventi di tipo "birthday". Non è possibile modificare il tipo 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 colors). (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. scrivibile
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 ID è formato in modo diverso per ogni tipo di soluzione per conferenze:

  • eventHangout: l'ID non è impostato. (Questo tipo di conferenza è deprecato).
  • eventNamedHangout: l'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 per conferenze, come Google Meet.

Non impostato per una conferenza con una richiesta di creazione non riuscita.

È obbligatorio specificare conferenceSolution e almeno un entryPoint o 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 contatto. Tuttavia, dovrebbe impedire le modifiche.

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (non più supportato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per le conferenze, ma non è possibile creare nuove conferenze)
  • "eventNamedHangout" per la versione classica di Hangouts per gli utenti di Google Workspace (opzione ritirata; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per le 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 di generazione di una nuova conferenza e di allegazione 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 per conferenze, 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 contatto. Tuttavia, dovrebbe impedire le modifiche.

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (non più supportato; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per le conferenze, ma non è possibile creare nuove conferenze)
  • "eventNamedHangout" per la versione classica di Hangouts per gli utenti di Google Workspace (opzione ritirata; gli eventi esistenti potrebbero mostrare questo tipo di soluzione per le 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 l'ID fornito è lo stesso 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 contatto 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 alla conferenza, ad esempio URL o numeri di telefono.

Tutti devono appartenere alla stessa conferenza.

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

Quando crei nuovi dati della conferenza, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrisponde alla terminologia utilizzata dal fornitore della conferenza. 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": per partecipare a una conferenza digitando 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 accesso sip.
  • "more": ulteriori istruzioni per partecipare alla conferenza, ad esempio numeri di telefono aggiuntivi. Una conferenza può avere zero o un punto di accesso 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-ccc
  • per phone: +1 123 268 2601
  • Per sip: [email protected]
  • 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 di campi {meetingCode, accessCode, passcode, password, pin} che corrisponde alla terminologia utilizzata dal fornitore della conferenza. 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 della conferenza, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrisponde alla terminologia utilizzata dal fornitore della conferenza. 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 della conferenza, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrisponde alla terminologia utilizzata dal fornitore della conferenza. 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 della conferenza, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrisponde alla terminologia utilizzata dal fornitore della conferenza. 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: è obbligatorio.
  • Per phone, è obbligatorio lo schema tel:. L'URI deve includere l'intera sequenza di tasti (ad es. tel:+12345678900,,,123456789;1234).
  • Per sip, è obbligatorio lo schema sip:, ad esempio sip:[email protected].
  • per lo schema more, http: o https:.

conferenceData.notes string Note aggiuntive (ad esempio istruzioni dell'amministratore del dominio, notifiche 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.

Non impostato per una conferenza con una richiesta di creazione non riuscita.

Facoltativo per una conferenza con una richiesta di creazione in attesa.
created datetime Data e 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 dell'autore, se disponibile.
creator.self boolean Indica se il creator corrisponde al calendario in cui viene visualizzata questa copia dell'evento. Sola lettura. Il valore predefinito è False.
description string Descrizione dell'evento. Può contenere codice HTML. (Facoltativo) scrivibile
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. scrivibile
end.dateTime datetime L'ora, come valore data/ora combinato (formattato in base allo standard RFC3339). È richiesto uno scarto del fuso orario, a meno che non venga specificato esplicitamente in timeZone un fuso orario. scrivibile
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. scrivibile
endTimeUnspecified boolean Indica se l'ora di fine non è effettivamente 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 e si ripete ogni anno.
  • "default": un evento regolare o non specificato ulteriormente.
  • "focusTime" - Un evento di momento di concentrazione.
  • "fromGmail": un evento di Gmail. Non è possibile creare questo tipo di evento.
  • "outOfOffice": un evento fuori sede.
  • "workingLocation": un evento relativo alla sede 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 di altri partecipanti. scrivibile
extendedProperties.shared.(key) string Il nome della proprietà condivisa e il valore corrispondente.
focusTimeProperties nested object Dati dell'evento Momento di concentrazione. Da utilizzare 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, che indica che nessun invito alla riunione viene rifiutato; declineAllConflictingInvitations, che indica che tutti gli inviti alla riunione in conflitto con l'evento vengono rifiutati; e declineOnlyNewConflictingInvitations, che indica che devono essere rifiutati solo i nuovi inviti alla riunione in conflitto che arrivano quando è presente l'evento Momento di concentrazione.
focusTimeProperties.chatStatus string Lo stato da contrassegnare per 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 del calendario.
  • "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 Indica se i partecipanti diversi dall'organizzatore possono invitare altre persone all'evento. (Facoltativo) Il valore predefinito è True. scrivibile
guestsCanModify boolean Indica se i partecipanti diversi dall'organizzatore possono modificare l'evento. (Facoltativo) Il valore predefinito è False. accessibile in scrittura
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 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 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 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, ovvero lettere minuscole a-v e cifre 0-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
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, 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 tutti gli stessi icalUID.

 scrivibile
kind string Tipo di risorsa ("calendar#event").
location string Posizione geografica dell'evento sotto forma di testo libero. (Facoltativo) scrivibile
locked boolean Indica se si tratta di una copia di un evento bloccato in cui non è possibile apportare modifiche ai campi dell'evento principali "summary", "description", "location", "start", "end" o "repeat". Il valore predefinito è False. Di 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. In 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 come da RFC5322. accessibile in scrittura
organizer.id string L'ID profilo dell'organizzatore, se disponibile.
organizer.self boolean 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, 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 momento 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. scrivibile
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. scrivibile
outOfOfficeProperties nested object Dati sugli eventi fuori sede. Utilizzato se eventType è outOfOffice. scrivibile
outOfOfficeProperties.autoDeclineMode string Indica se rifiutare gli inviti a riunioni che si sovrappongono a eventi fuori sede. I valori validi sono declineNone, che indica che nessun invito a riunioni viene rifiutato; declineAllConflictingInvitations, che indica che vengono rifiutati tutti gli inviti a riunioni in conflitto con l'evento; declineOnlyNewConflictingInvitations, che indica che vengono 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 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; le ore di inizio e di fine dell'evento sono specificate 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, è 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 modifica anche la 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 sono 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 aggiungi un promemoria.

 accessibile in scrittura
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 aggiungi 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 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 sorgente, 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. accessibile in scrittura
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 si tratta di un evento che dura tutto il giorno. scrivibile
start.dateTime datetime L'ora come valore data/ora combinato (formattato in base allo standard RFC3339). È necessario un offset del fuso orario, a meno che non sia specificato esplicitamente un fuso orario in timeZone. scrivibile
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 è annullato (eliminato). Il metodo list restituisce gli eventi annullati solo in caso di sincronizzazione incrementale (quando vengono 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 memorizzare 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 devono rimuovere le copie sincronizzate localmente. Questi eventi annullati alla fine scompariranno, quindi non fare affidamento sulla loro disponibilità a tempo indeterminato.

      Per gli eventi eliminati è garantito solo il completamento del campo id.

    Nel calendario dell'organizzatore, gli eventi annullati continuano a mostrare i dettagli (riepilogo, luogo e così via) in modo che possano essere ripristinati (annullati). 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.

scrivibile
summary string Titolo dell'evento. scrivibile
transparency string Indica se l'evento blocca un periodo di tempo nel calendario. (Facoltativo) I valori possibili sono:
  • "opaque" - Valore predefinito. ma l'evento blocca il tempo sul calendario. Ciò equivale a impostare Mostrami come su Occupato nell'interfaccia utente di Calendar.
  • "transparent": l'evento non blocca l'orario nel calendario. Equivale a impostare Mostrami come su Disponibile nell'interfaccia utente di Calendar.
 accessibile in scrittura
updated datetime Ora dell'ultima modifica dei dati dell'evento principale (come timestamp RFC3339). L'aggiornamento dei promemoria degli eventi non comporterà alcuna 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 relativi dettagli sono visibili a tutti i lettori del calendario.
  • "private" - L'evento è privato e solo i partecipanti possono vedere i dettagli dell'evento.
  • "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 sta lavorando da una posizione personalizzata. accessibile in scrittura
workingLocationProperties.customLocation.label string Un'etichetta aggiuntiva facoltativa per ulteriori informazioni. scrivibile
workingLocationProperties.homeOffice any value Se presente, specifica che l'utente lavora da casa. scrivibile
workingLocationProperties.officeLocation object Se presente, specifica che l'utente lavora da un ufficio. scrivibile
workingLocationProperties.officeLocation.buildingId string Un identificatore facoltativo dell'edificio. Deve fare riferimento a un ID edificio nel database Risorse dell'organizzazione. scrivibile
workingLocationProperties.officeLocation.deskId string Un identificatore facoltativo della scrivania. scrivibile
workingLocationProperties.officeLocation.floorId string Un identificatore facoltativo del piano. scrivibile
workingLocationProperties.officeLocation.floorSectionId string Un identificatore facoltativo della sezione del piano. scrivibile
workingLocationProperties.officeLocation.label string Il nome dell'ufficio visualizzato nei client web e mobile di Calendar. Ti consigliamo di fare riferimento al nome di un edificio nel database Risorse dell'organizzazione. scrivibile
workingLocationProperties.type string Tipo di luogo di lavoro. I valori possibili sono:
  • "homeOffice": l'utente lavora a 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 non essere presente se è vuoto. Eventuali altri campi vengono ignorati.

Obbligatorio quando aggiungi le proprietà dei luoghi di lavoro.

 scrivibile

Metodi

elimina
Elimina un evento.
get
Restituisce un evento in base al relativo ID di 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 un valore eventType pari a default.

Comportamento non più supportato:se viene importato un evento diverso da default, il relativo tipo verrà modificato in default e tutte le proprietà specifiche del tipo di evento verranno eliminate.

insert
Crea un evento.
instances
Restituisci 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 di campo 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 in base a una semplice stringa di testo.
update
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à.
watch
Attendi eventuali modifiche alle risorse Eventi.