Calendars

Collection de tous les agendas existants. Consultez également Calendars vs 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,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
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éfini uniquement pour les agendas secondaires. Lecture seule.
description string Description de l'agenda. Facultatif. accessible en écriture
etag etag Tag d'entité 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 de libellé définies dans cet agenda. Si cette option est spécifiée, elle écrase les propriétés d'étiquette 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énement définis dans cet agenda. Si ce champ est présent lors de la mise à jour de l'agenda, il remplace les libellés d'événement existants.

Développez 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 associés à 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é.

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

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

Si vous en fournissez un, 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. (au format d'un nom de la base de données des fuseaux horaires de l'IANA, par exemple "Europe/Zurich"). Facultatif. accessible en écriture
workingHours object Représente les informations sur les heures de travail de l'utilisateur. Disponible uniquement pour les agendas principaux des utilisateurs Google Workspace. Pour mettre à jour les heures de travail, l'intégralité de l'objet "working hours" doit être transmise. Si aucune valeur n'est spécifiée (ou si la valeur est nulle ou un objet vide), les horaires de travail existants restent inchangés. Pour désactiver les horaires de travail ou effacer le planning, définissez workingHoursEnabled sur "false" (et omettez availableTimes ou transmettez une liste vide). accessible en écriture
workingHours.availableTimes[] list Heures de travail. Chaque période de disponibilité représente le bloc d'heures de travail de l'utilisateur au cours d'une journée. accessible en écriture
workingHours.availableTimes[].dayOfWeek string Jour de la semaine. Obligatoire. Valeurs possibles :
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
accessible en écriture
workingHours.availableTimes[].periodEnd integer Fin de la période, en minutes à partir du début de la journée, non inclus. Obligatoire. accessible en écriture
workingHours.availableTimes[].periodStart integer Début de la période, en minutes à partir du début de la journée (inclus). Obligatoire. accessible en écriture
workingHours.workingHoursEnabled boolean Indique si les heures de travail sont activées pour cet agenda. Ne peut pas être défini sur "true" lorsque availableTimes est vide. 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
Renvoie 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 de correctif consomme trois unités de quota. Privilégiez l'utilisation d'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 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 d'un utilisateur à un autre dans 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 être transféré. Le transfert d'agendas désactivés ou supprimés n'est pas possible.
update
Met à jour les métadonnées d'un agenda.