Events

L'API Calendar offre diverse tipologie di risorse per gli eventi. Per saperne di più, consulta 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
    }
  ],
  "eventType": string
}
Nome proprietà Valore Descrizione Note
anyoneCanAddSelf boolean Se chiunque può invitare se stesso all'evento (deprecato). Campo facoltativo. Il valore predefinito è False. scrivibile
attachments[] list 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, si tratta dell'ID della voce della risorsa Files corrispondente nell'API Drive.

attachments[].fileUrl string Link URL all'allegato.

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

Obbligatorio quando aggiungi un allegato.

scrivibile
attachments[].mimeType string Tipo multimediale 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 si recupera un evento, ciò potrebbe essere dovuto a una restrizione specificata dal parametro di query maxAttendee. Durante l'aggiornamento di un evento, può essere utilizzato solo per aggiornare la risposta del partecipante. Campo facoltativo. Il valore predefinito è False. scrivibile
attendees[] list I partecipanti all'evento. Per ulteriori informazioni sulla programmazione di eventi con altri utenti del calendario, consulta la guida Eventi con partecipanti. Gli account di servizio devono utilizzare la delega dell'autorità a livello di dominio per compilare l'elenco dei partecipanti. scrivibile
attendees[].additionalGuests integer Numero di ospiti aggiuntivi. Campo facoltativo. Il valore predefinito è 0. scrivibile
attendees[].comment string Il commento di risposta del partecipante. Campo facoltativo. scrivibile
attendees[].displayName string Il nome del partecipante, se disponibile. Campo 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 secondo RFC5322.

Obbligatorio quando aggiungi un partecipante.

scrivibile
attendees[].id string L'ID profilo del partecipante, se disponibile.
attendees[].optional boolean Indica se si tratta di un partecipante facoltativo. Campo facoltativo. Il valore predefinito è False. scrivibile
attendees[].organizer boolean Se il partecipante è l'organizzatore dell'evento. Sola lettura. Il valore predefinito è False.
attendees[].resource boolean Se il partecipante è una risorsa. Può essere impostato solo quando il partecipante viene aggiunto all'evento per la prima volta. Le modifiche successive vengono ignorate. Campo 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 (consigliato 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 appare la copia dell'evento. Sola lettura. Il valore predefinito è False.
colorId string Il colore dell'evento. Si tratta di un ID che fa riferimento a una voce nella sezione event della definizione dei colori (vedi l' endpoint dei colori). Campo facoltativo. scrivibile
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 dell'ID ha un formato diverso a seconda del tipo di soluzione di conferenza:

  • eventHangout: l'ID non è impostato. Questo tipo di conferenza è stato ritirato.
  • eventNamedHangout: ID è il nome dell' Hangout. Questo tipo di conferenza è stato ritirato.
  • hangoutsMeet: ID è il codice riunione di 10 lettere, ad esempio aaa-bbbb-ccc.
  • addOn: l'ID è definito dal provider di terze parti.
Facoltativa.

conferenceData.conferenceSolution nested object La soluzione per le conferenze, ad esempio Google Meet.

Annulla impostazione 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 di conferenza.

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

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (ritirata; 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 (ritirata; gli eventi esistenti potrebbero mostrare questo tipo di soluzione di conferenza, 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 localizzata.
conferenceData.createRequest nested object Richiesta per generare una nuova conferenza e allegarla all'evento. I dati vengono generati in modo asincrono. Per verificare se sono presenti dati, controlla il campo status.

È obbligatorio specificare conferenceSolution e almeno un entryPoint o createRequest.

conferenceData.createRequest.conferenceSolutionKey nested object La soluzione per le conferenze, ad esempio Hangouts o Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Il tipo di soluzione di conferenza.

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

I valori possibili sono:

  • "eventHangout" per Hangouts per i consumatori (ritirata; 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 (ritirata; gli eventi esistenti potrebbero mostrare questo tipo di soluzione di conferenza, 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 dovrebbero 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 ingresso sono stati compilati.
  • "failure": la richiesta di creazione della conferenza non è andata a buon fine. Non sono presenti punti di ingresso.

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

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 relativi alle conferenze, compila solo il sottoinsieme di campi {meetingCode, accessCode, passcode, password, pin} che corrispondono alla terminologia utilizzata dal fornitore di conferenze. Devono essere visualizzati solo i campi compilati.

Campo facoltativo.

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

I valori possibili sono:

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

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

Esempi:

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

Campo facoltativo.

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

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

Campo facoltativo.

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

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

conferenceData.entryPoints[].password string La password per accedere alla conferenza. La lunghezza massima è di 128 caratteri.

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

Campo facoltativo.

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

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

Campo 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, lo schema tel: è obbligatorio. L'URI deve includere l'intera sequenza di composizione (ad es. tel:+12345678900,,,123456789;1234).
  • Per sip, lo schema sip: è obbligatorio, ad esempio sip:12345678@mioprovider.com.
  • per lo schema more, http: o https: è obbligatorio.

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

Generati lato server.

Annulla impostazione per una conferenza con una richiesta di creazione non riuscita.

Facoltativo per una conferenza con una richiesta di creazione in attesa.

created datetime Ora di creazione dell'evento (sotto forma di timestamp RFC3339). Sola lettura.
creator object L'autore dell'evento. Sola lettura.
creator.displayName string Il nome del creator, se disponibile.
creator.email string L'indirizzo email del creator, se disponibile.
creator.id string L'ID del profilo del creator, se disponibile.
creator.self boolean Se l'autore corrisponde al calendario in cui appare questa copia dell'evento. Sola lettura. Il valore predefinito è False.
description string Descrizione dell'evento. Possono contenere HTML. Campo facoltativo. scrivibile
end nested object L'ora di fine (esclusiva) dell'evento. Per un evento ricorrente, questa è l'ora di fine della prima istanza.
end.date date La data, nel formato "aaaa-mm-gg", se questo è un evento che dura tutto il giorno. scrivibile
end.dateTime datetime L'ora, espressa come valore combinato di data e ora (formattato secondo RFC3339). La differenza è obbligatoria, a meno che non venga specificato esplicitamente un fuso orario in timeZone. scrivibile
end.timeZone string Il fuso orario in cui è specificata l'ora. (formattato come nome di database dei fusi orari IANA, ad esempio "Europa/Zurich"). Per gli eventi ricorrenti, questo campo è obbligatorio e consente di specificare 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. L'ora di fine viene comunque fornita 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:
  • "default" - Un evento regolare o non ulteriormente specificato.
  • "outOfOffice" - Un evento fuori sede.
  • "focusTime" - Un evento di momento di concentrazione.
  • "workingLocation": un evento relativo a un luogo di lavoro.
scrivibile
extendedProperties object Proprietà estese dell'evento.
extendedProperties.private object Proprietà private per la copia dell'evento visualizzato in questo calendario. scrivibile
extendedProperties.private.(key) string Il nome della proprietà privata e il valore corrispondente.
extendedProperties.shared object Proprietà condivise tra copie dell'evento sui calendari di altri partecipanti. scrivibile
extendedProperties.shared.(key) string Il nome della proprietà condivisa e il valore corrispondente.
focusTimeProperties nested object Dati sugli eventi relativi al momento di concentrazione. In uso se eventType è focusTime. scrivibile
focusTimeProperties.autoDeclineMode string Se rifiutare gli inviti alle riunioni che si sovrappongono a eventi di momento di concentrazione. I valori validi sono declineNone, che indica che nessun invito alle riunioni viene rifiutato, declineAllConflictingInvitations, che indica che tutti gli inviti alle riunioni in conflitto che sono in conflitto con l'evento vengono rifiutati, e declineOnlyNewConflictingInvitations, che indica che devono essere rifiutati solo i nuovi inviti alle riunioni in conflitto che arrivano quando è 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 mostrato accanto al titolo dell'evento nella visualizzazione calendario.
  • "chip": il gadget viene visualizzato quando viene fatto clic sull'evento.
scrivibile
gadget.height integer L'altezza del gadget in pixel. L'altezza deve essere un numero intero maggiore di 0. Campo 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. Campo facoltativo. Deprecato. scrivibile
guestsCanInviteOthers boolean Se altri partecipanti diversi dall'organizzatore possono invitare altre persone all'evento. Campo facoltativo. Il valore predefinito è True. scrivibile
guestsCanModify boolean Indica se altri invitati diversi dall'organizzatore possono modificare l'evento. Campo facoltativo. Il valore predefinito è False. scrivibile
guestsCanSeeOtherGuests boolean Se i partecipanti diversi dall'organizzatore possono vedere chi sono i partecipanti all'evento. Campo facoltativo. Il valore predefinito è True. scrivibile
iCalUID string Identificatore univoco dell'evento come definito in RFC5545. Viene utilizzato per identificare in modo univoco gli eventi nei sistemi di calendario e deve essere fornito durante l'importazione degli eventi tramite il metodo import.

Tieni presente che iCalUID e id non sono identici e solo uno di questi deve essere specificato 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 tutti condividono gli stessi iCalUID. Per recuperare un evento utilizzando il relativo iCalUID, chiama il metodo events.list utilizzando il parametro iCalUID. Per recuperare un evento utilizzando il relativo id, chiama il metodo events.get.

id string Identificatore opaco dell'evento. Quando crei nuovi eventi singoli o ricorrenti, puoi specificare i relativi ID. Gli ID forniti devono seguire queste regole:
  • I caratteri consentiti nell'ID sono quelli utilizzati nella codifica base32hex, ad esempio le lettere minuscole a-v e le cifre 0-9. Vedi 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 i conflitti di ID verranno rilevati al momento della creazione degli eventi. 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 di questi deve essere specificato 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 tutti condividono gli stessi icalUID.

scrivibile
kind string Tipo della risorsa ("calendar#event").
location string Posizione geografica dell'evento come testo in formato libero. Campo facoltativo. scrivibile
locked boolean Indica se si tratta di una copia dell'evento bloccata in cui non è possibile apportare modifiche ai campi principali dell'evento "summary", "description", "location", "start", "end" o " ricorrenza". Il valore predefinito è False. Sola lettura.
organizer object L'organizzatore dell'evento. Se l'organizzatore è anche un partecipante, verrà indicato con una voce separata in attendees con il campo organizer impostato su True. Per cambiare l'organizzatore, utilizza l'operazione sposta. Sola lettura, tranne durante l'importazione di un evento. scrivibile
organizer.displayName string Il nome dell'organizzatore, se disponibile. scrivibile
organizer.email string Indirizzo email dell'organizzatore, se disponibile. Deve essere un indirizzo email valido secondo RFC5322. scrivibile
organizer.id string L'ID profilo dell'organizzatore, se disponibile.
organizer.self boolean Indica se l'organizzatore corrisponde al calendario in cui appare questa copia dell'evento. Sola lettura. Il valore predefinito è False.
originalStartTime nested object Per un'istanza di un evento ricorrente, questa è l'ora in cui l'evento inizia in base ai dati di ricorrenza nell'evento ricorrente identificato dal ricorrenteEventId. Identifica in modo univoco l'istanza all'interno della serie di eventi ricorrenti, anche se l'istanza è stata spostata in un orario diverso. Immutabile.
originalStartTime.date date La data, nel formato "aaaa-mm-gg", se questo è un evento che dura tutto il giorno. scrivibile
originalStartTime.dateTime datetime L'ora, espressa come valore combinato di data e ora (formattato secondo RFC3339). La differenza è obbligatoria, a meno che non venga specificato esplicitamente un fuso orario in timeZone. scrivibile
originalStartTime.timeZone string Il fuso orario in cui è specificata l'ora. (formattato come nome di database dei fusi orari IANA, ad esempio "Europa/Zurich"). Per gli eventi ricorrenti, questo campo è obbligatorio e consente di specificare 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. In uso se eventType è outOfOffice. scrivibile
outOfOfficeProperties.autoDeclineMode string Indica se rifiutare gli inviti alle riunioni che si sovrappongono a eventi fuori sede. I valori validi sono declineNone, che indica che nessun invito alle riunioni viene rifiutato, declineAllConflictingInvitations, che indica che tutti gli inviti alle riunioni in conflitto che sono in conflitto con l'evento vengono rifiutati, e declineOnlyNewConflictingInvitations, che indica che devono essere rifiutati solo i nuovi inviti alle riunioni in conflitto che arrivano quando è 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 è disabilitata. Tieni presente che non è uguale a Proprietà evento privato. Campo facoltativo. Immutabile. Il valore predefinito è False.
recurrence[] list Elenco di righe RRULE, EXRULE, RDATE ed EXDATE per un evento ricorrente, come specificato in RFC5545. Tieni presente che le righe DTSTART e DTEND non sono consentite in questo campo; le ore di inizio e di fine degli eventi vengono specificate nei campi start e end. Questo campo viene omesso per eventi singoli o istanze di eventi ricorrenti. scrivibile
recurringEventId string Per un'istanza di un evento ricorrente, corrisponde al valore id dell'evento ricorrente a cui appartiene l'istanza. Immutabile.
reminders object Informazioni sui promemoria dell'evento per l'utente autenticato.
reminders.overrides[] list Se l'evento non utilizza i promemoria predefiniti, vengono elencati i promemoria specifici dell'evento o, se non è impostato, indica che non è impostato alcun promemoria per questo evento. Il numero massimo di promemoria per l'override è 5. scrivibile
reminders.overrides[].method string Il metodo utilizzato per il promemoria. I valori possibili sono:
  • "email" - I promemoria vengono inviati via email.
  • "popup": i promemoria vengono inviati in un popup UI.

Obbligatorio quando aggiungi un promemoria.

scrivibile
reminders.overrides[].minutes integer Numero di minuti prima dell'inizio dell'evento in cui dovrebbe 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 tramite un URL con schema HTTP o HTTPS. Possono essere visualizzati o modificati solo dall'autore dell'evento.
source.title string Titolo della fonte, ad esempio il titolo di una pagina web o l'oggetto di un'email. 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, questa è l'ora di inizio della prima istanza.
start.date date La data, nel formato "aaaa-mm-gg", se questo è un evento che dura tutto il giorno. scrivibile
start.dateTime datetime L'ora, espressa come valore combinato di data e ora (formattato secondo RFC3339). La differenza è obbligatoria, a meno che non venga specificato esplicitamente un fuso orario in timeZone. scrivibile
start.timeZone string Il fuso orario in cui è specificata l'ora. (formattato come nome di database dei fusi orari IANA, ad esempio "Europa/Zurich"). Per gli eventi ricorrenti, questo campo è obbligatorio e consente di specificare 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. Campo facoltativo. I valori possibili sono:
  • "confirmed" - L'evento è confermato. Questo è lo stato predefinito.
  • "tentative" - L'evento è stato confermato provvisoriamente.
  • "cancelled" - L'evento è stato annullato (eliminato). Il metodo list restituisce gli eventi annullati solo durante la sincronizzazione incrementale (quando sono specificati syncToken o updatedMin) o se il flag showDeleted è impostato su true. Il metodo get li restituisce sempre.

    Lo stato annullato indica due stati diversi a seconda del tipo di evento:

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

      Per le eccezioni annullate è garantito che vengano compilati solo i valori per i campi id, recurringEventId e originalStartTime. Gli altri campi potrebbero essere vuoti.

    2. Tutti gli altri eventi annullati rappresentano eventi eliminati. I clienti dovrebbero rimuovere le copie sincronizzate localmente. Questi eventi annullati scompariranno, quindi non aspettarti che siano disponibili a tempo indeterminato.

      Per gli eventi eliminati viene garantita solo la compilazione del campo id.

    Nel calendario dell'organizzatore, gli eventi annullati continuano a mostrare i dettagli (riepilogo, luogo e così via) affinché possano essere ripristinati (annullati l'eliminazione). Analogamente, gli eventi a cui l'utente è stato invitato e che è stato rimosso manualmente continuano a fornire dettagli. Tuttavia, le richieste di sincronizzazione incrementali con showDeleted impostato su false non restituiranno questi dettagli.

    Se un evento cambia l'organizzatore (ad esempio tramite l'operazione move) e l'organizzatore originale non è nell'elenco dei partecipanti, rimarrà 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 orario sul calendario. Campo facoltativo. I valori possibili sono:
  • "opaque" - Il valore predefinito. L'evento blocca l'orario sul calendario. Equivale a impostare Mostra il mio stato come su Occupato nell'interfaccia utente di Calendar.
  • "transparent": l'evento non blocca l'orario sul calendario. Equivale a impostare Mostra il mio stato come su Disponibile nell'interfaccia utente di Calendar.
scrivibile
updated datetime Ora dell'ultima modifica dell'evento (sotto forma di timestamp RFC3339). Sola lettura.
visibility string Visibilità dell'evento. Campo facoltativo. I valori possibili sono:
  • "default": utilizza la visibilità predefinita per gli eventi del 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 visualizzarne 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 sta lavorando da una posizione personalizzata. scrivibile
workingLocationProperties.customLocation.label string Un'etichetta aggiuntiva facoltativa per le 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 sta lavorando 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 di scrivania facoltativo. scrivibile
workingLocationProperties.officeLocation.floorId string Un identificatore del prezzo minimo facoltativo. scrivibile
workingLocationProperties.officeLocation.floorSectionId string Un identificatore facoltativo della sezione del piano. scrivibile
workingLocationProperties.officeLocation.label string Il nome dell'ufficio visualizzato nei client Calendar per il web e per dispositivi mobili. Ti consigliamo di fare riferimento al nome di un 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 sta lavorando da un ufficio.
  • "customLocation": l'utente sta lavorando da una posizione personalizzata.
Tutti i dettagli sono specificati in un campo secondario del nome specificato, ma il campo potrebbe non essere presente se vuoto. Tutti gli altri campi vengono ignorati.

Obbligatorio quando aggiungi proprietà del luogo di lavoro.

scrivibile

Metodi

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

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

inserire
Crea un evento.
istanze
Restituisci le istanze dell'evento ricorrente specificato.
list
Restituisci gli eventi nel calendario specificato.
spostamento
Sposta un evento in un altro calendario, ad esempio cambia l'organizzatore di un evento. Tieni presente che puoi spostare solo gli eventi default; non puoi spostare gli eventi outOfOffice, focusTime e workingLocation.
cerotto
Aggiorna un evento. Questo metodo supporta la semantica della patch. Tieni presente che ogni richiesta di patch consuma tre unità di quota; è preferibile utilizzare get seguito da update. I valori dei campi specificati sostituiscono quelli esistenti. I campi non specificati nella richiesta rimangono invariati. I campi degli array, se specificati, sovrascrivono gli array esistenti. Vengono eliminati eventuali elementi dell'array precedenti.
quickAdd
Crea un evento in base a 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 get seguito da update usando gli etag per garantire l'atomicità.
orologio
Controlla se sono state apportate modifiche alle risorse Eventi.