Calendars

Una raccolta di tutti i calendari esistenti. Consulta anche Calendars e CalendarList.

Per un elenco dei metodi per questa risorsa, consulta la fine di questa pagina.

Rappresentazioni delle risorse

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
Nome proprietà Valore Descrizione Note
autoAcceptInvitations boolean Indica se questo calendario accetta automaticamente gli inviti. Valido solo per i calendari delle risorse.
conferenceProperties nested object Proprietà delle conferenze per questo calendario, ad esempio i tipi di conferenze consentiti.
conferenceProperties.allowedConferenceSolutionTypes[] list I tipi di soluzioni per conferenze supportati per questo calendario.

I valori possibili sono:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Facoltativo.

dataOwner string L'indirizzo email del proprietario del calendario. Impostato solo per i calendari secondari. Sola lettura.
description string Descrizione del calendario. Facoltativo. scrivibile
etag etag ETag della risorsa.
id string Identificatore del calendario. Per recuperare gli ID, chiama il metodo calendarList.list().
kind string Il tipo di risorsa ("calendar#calendar").
labelProperties nested object Proprietà delle etichette definite in questo calendario. Se specificato, sovrascrive le proprietà dell'etichetta esistenti. Se non specificato, le proprietà dell'etichetta rimangono invariate. scrivibile
labelProperties.eventLabels[] list Etichette degli eventi definite in questo calendario. Se questo campo è presente durante l'aggiornamento del calendario, sostituirà le etichette degli eventi esistenti.

Estendi l'elenco per aggiungere una nuova etichetta evento e rimuovi le entità dall'elenco per eliminare un'etichetta dal calendario.

Ogni calendario può avere un massimo di 200 etichette.

scrivibile
labelProperties.eventLabels[].backgroundColor string Colore di sfondo dell'etichetta in formato esadecimale, ad esempio "#039be5". Gli eventi con questa etichetta vengono visualizzati in questo colore. Obbligatorio. scrivibile
labelProperties.eventLabels[].id string L'ID dell'etichetta. Facoltativo quando si inserisce una nuova etichetta. Se non viene fornito, verrà generato un ID univoco. Obbligatorio quando si aggiorna un'etichetta.

Se fornito, l'ID deve essere univoco all'interno del calendario e seguire il formato UUID.

scrivibile
labelProperties.eventLabels[].name string Nome dell'etichetta. Facoltativo.

Se fornito, deve contenere al massimo 50 caratteri.

scrivibile
location string Posizione geografica del calendario come testo in formato libero. Facoltativo. scrivibile
summary string Titolo del calendario. scrivibile
timeZone string Il fuso orario del calendario. (Formattato come nome del database dei fusi orari IANA, ad esempio "Europe/Zurich".) Facoltativo. scrivibile
workingHours object Rappresenta le informazioni sull'orario di lavoro dell'utente. Disponibile solo per i calendari principali degli utenti di Google Workspace. Per aggiornare l'orario di lavoro, è necessario passare l'intero oggetto dell'orario di lavoro. Se non specificato (o se viene passato come null o un oggetto vuoto), l'orario di lavoro esistente rimane invariato. Per disattivare l'orario di lavoro o cancellare la programmazione, imposta workingHoursEnabled su false (e ometti availableTimes o passa un elenco vuoto). scrivibile
workingHours.availableTimes[] list Orario di lavoro. Ogni periodo di disponibilità rappresenta il blocco dell'orario di lavoro dell'utente durante un giorno. scrivibile
workingHours.availableTimes[].dayOfWeek string Giorno della settimana. Obbligatorio. I valori possibili sono:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
scrivibile
workingHours.availableTimes[].periodEnd integer Fine del periodo, in minuti dall'inizio della giornata, esclusa. Obbligatorio. scrivibile
workingHours.availableTimes[].periodStart integer Inizio del periodo, in minuti dall'inizio del giorno, inclusi. Obbligatorio. scrivibile
workingHours.workingHoursEnabled boolean Indica se l'orario di lavoro è abilitato per questo calendario. Non può essere impostato su true quando availableTimes è vuoto. scrivibile

Metodi

clear
Cancella un calendario principale. Questa operazione elimina tutti gli eventi associati al calendario principale di un account.
elimina
Elimina un calendario secondario. Utilizza calendars.clear per cancellare tutti gli eventi nei calendari principali.
get
Restituisce i metadati di un calendario.
insert
Crea un calendario secondario.

L'utente autenticato per la richiesta diventa il proprietario dei dati del nuovo calendario.

patch
Aggiorna i metadati di un calendario. Questo metodo supporta la semantica PATCH. Tieni presente che ogni richiesta PATCH consuma tre unità di quota; preferisci l'utilizzo di un get seguito da un update. I valori dei campi specificati sostituiscono i valori esistenti. I campi non specificati nella richiesta rimangono invariati. I campi array, se specificati, sovrascrivono gli array esistenti, eliminando gli elementi dell'array precedenti.
transferOwnership
Trasferisce un calendario secondario tra utenti all'interno di un'organizzazione Google Workspace. Richiede l'autenticazione dell'utente con il privilegio amministrativo Gestione dei calendari e uno dei seguenti ambiti di autorizzazione:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
Nella richiesta, imposta useAdminAccess su true. Il calendario secondario deve essere attivo per essere trasferito. Il trasferimento di calendari disattivati o eliminati non è supportato.
update
Aggiorna i metadati di un calendario.