Calendars

Collection de tous les agendas existants. Consultez également Agendas et CalendarList.

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "autoAcceptInvitations": boolean
}
Nom de propriété Valeur Description Remarques
autoAcceptInvitations boolean Indique si cet agenda accepte automatiquement les invitations. Valide uniquement pour les agendas de ressources.
conferenceProperties nested object Propriétés de conférence pour cet agenda, par exemple les types de conférences autorisés.
conferenceProperties.allowedConferenceSolutionTypes[] list Types de solutions de conférence compatibles avec cet agenda.

Les valeurs possibles sont :

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Facultatif.
dataOwner string Adresse e-mail du propriétaire de l'agenda. Définie uniquement pour les agendas secondaires. Lecture seule.
description string Description de l'agenda. Facultatif. accessible en écriture
etag etag ETag de la ressource.
id string Identifiant de l'agenda. Pour récupérer les ID, appelez la méthode calendarList.list().
kind string Type de la ressource ("calendar#calendar").
location string Emplacement géographique de l'agenda sous forme de texte libre. Facultatif. accessible en écriture
summary string Titre de l'agenda. accessible en écriture
timeZone string Fuseau horaire de l'agenda. (Formaté comme un nom de la base de données des fuseaux horaires IANA, par exemple "Europe/Zurich".) Facultatif. accessible en écriture

Méthodes

clair
Efface un agenda principal. Cette opération supprime tous les événements associés à l'agenda principal d'un compte.
supprimer
Supprime un agenda secondaire. Utilisez calendars.clear pour effacer tous les événements des agendas principaux.
get
Affiche les métadonnées d'un agenda.
insérer
Crée un agenda secondaire.

L'utilisateur authentifié pour la requête est défini comme propriétaire des données du nouvel agenda.

patch
Met à jour les métadonnées d'un agenda. Cette méthode est compatible avec la sémantique "patch". Notez que chaque requête de patch consomme trois unités de quota. Il est préférable d'utiliser une requête get suivie d'une requête update. Les valeurs de champ que vous spécifiez remplacent les valeurs existantes. Les champs que vous ne spécifiez pas dans la requête restent inchangés. Les champs de tableau, s'ils sont spécifiés, écrasent les tableaux existants, ce qui supprime tous les éléments de tableau précédents.
transferOwnership
Transfère un agenda secondaire entre des utilisateurs d'une organisation Google Workspace. Nécessite l'authentification de l'utilisateur avec le privilège d'administrateur "Gérer les agendas" et l'un des champs d'application d'autorisation suivants :
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
Dans la requête, définissez useAdminAccess sur true. L'agenda secondaire doit être actif pour pouvoir être transféré. Le transfert d'agendas désactivés ou supprimés n'est pas accepté.
info
Met à jour les métadonnées d'un agenda.