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
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean
}
Nom de propriété Valeur Description Remarques
autoAcceptInvitations boolean Indique si cet agenda accepte automatiquement les invitations. Valable uniquement pour les agendas de ressources.
conferenceProperties nested object Propriétés de visioconférence pour cet agenda, par exemple les types de visioconférences autorisés.
conferenceProperties.allowedConferenceSolutionTypes[] list Types de solutions de visioconfé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éfini 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").
labelProperties nested object Propriétés des libellés définies dans cet agenda. Si elle est spécifiée, elle écrase les propriétés de libellé existantes. Si aucune valeur n'est spécifiée, les propriétés du libellé restent inchangées. accessible en écriture
labelProperties.eventLabels[] list Libellés d'événements définis dans cet agenda. Si cette valeur est présente lors de la mise à jour de l'agenda, elle remplacera les libellés d'événement existants.

Élargissez la liste pour ajouter un libellé d'événement et supprimez des entités de la liste pour supprimer un libellé de l'agenda.

Chaque agenda peut comporter jusqu'à 200 libellés.

 accessible en écriture
labelProperties.eventLabels[].backgroundColor string Couleur d'arrière-plan du libellé au format hexadécimal, par exemple "#039be5". Les événements portant ce libellé s'affichent dans cette couleur. Obligatoire. accessible en écriture
labelProperties.eventLabels[].id string ID du libellé. Facultatif lors de l'insertion d'un nouveau libellé. Si aucun ID n'est fourni, un ID unique sera généré. Obligatoire lors de la mise à jour d'un libellé.

Si un ID est fourni, il doit être unique dans l'agenda et respecter le format UUID.

 accessible en écriture
labelProperties.eventLabels[].name string Nom du libellé Facultatif.

Si vous le fournissez, il ne doit pas dépasser 50 caractères.

 accessible en écriture
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 devient le 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 PATCH consomme trois unités de quota. Il est préférable d'utiliser un get suivi d'un update. Les valeurs de champ que vous spécifiez remplacent les valeurs existantes. Les champs que vous ne spécifiez pas dans la demande restent inchangés. Si des champs de tableau sont spécifiés, ils é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 droit 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é. Il n'est pas possible de transférer des agendas désactivés ou supprimés.
update
Met à jour les métadonnées d'un agenda.