API Reference

Cette documentation de référence de l'API est organisée par type de ressource. Chaque type de ressource comporte une ou plusieurs représentations de données, ainsi qu'une ou plusieurs méthodes.

Types de ressources

  1. Acl
  2. CalendarList
  3. Agendas
  4. Chaînes
  5. Couleurs
  6. Événements
  7. Freebusy
  8. Paramètres

Acl

Pour en savoir plus sur la ressource "Acl", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
supprimer DELETE  /calendars/calendarId/acl/ruleId Supprime une règle de contrôle des accès.
get GET  /calendars/calendarId/acl/ruleId Renvoie une règle de contrôle d'accès.
insérer POST  /calendars/calendarId/acl Crée une règle de contrôle des accès.
liste GET  /calendars/calendarId/acl Renvoie les règles de la liste de contrôle d'accès de l'agenda.
patch PATCH  /calendars/calendarId/acl/ruleId Met à jour une règle de contrôle des accès. 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 requête 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.
update PUT  /calendars/calendarId/acl/ruleId Met à jour une règle de contrôle des accès.
regarder POST  /calendars/calendarId/acl/watch Surveillez les modifications apportées aux ressources LCA.

CalendarList

Pour en savoir plus sur la ressource CalendarList, consultez la page Représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
supprimer DELETE  /users/me/calendarList/calendarId Supprime un agenda de la liste des agendas de l'utilisateur.
get GET  /users/me/calendarList/calendarId Renvoie un agenda de la liste d'agendas de l'utilisateur.
insérer POST  /users/me/calendarList Insère un agenda existant dans la liste des agendas de l'utilisateur.
liste GET  /users/me/calendarList Renvoie les agendas de la liste d'agendas de l'utilisateur.
patch PATCH  /users/me/calendarList/calendarId Met à jour un agenda existant dans la liste des agendas de l'utilisateur. 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 requête 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.
update PUT  /users/me/calendarList/calendarId Met à jour un agenda existant dans la liste des agendas de l'utilisateur.
regarder POST  /users/me/calendarList/watch Surveillez les modifications apportées aux ressources CalendarList.

Agendas

Pour en savoir plus sur la ressource "Calendars", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
clair POST  /calendars/calendarId/clear Efface un agenda principal. Cette opération supprime tous les événements associés à l'agenda principal d'un compte.
supprimer DELETE  /calendars/calendarId Supprime un agenda secondaire. Utilisez calendars.clear pour effacer tous les événements des agendas principaux.
get GET  /calendars/calendarId Affiche les métadonnées d'un agenda.
insérer POST  /calendars Crée un agenda secondaire.

L'utilisateur authentifié pour la requête devient le propriétaire des données du nouvel agenda.
patch PATCH  /calendars/calendarId 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 requête 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.
update PUT  /calendars/calendarId Met à jour les métadonnées d'un agenda.

Chaînes

Pour en savoir plus sur la ressource "Channels", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
stop POST  /channels/stop Arrêtez de regarder des ressources sur cette chaîne.

Couleurs

Pour en savoir plus sur la ressource "Colors", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
get GET  /colors Renvoie les définitions de couleur pour les agendas et les événements.

Événements

Pour en savoir plus sur la ressource "Events", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
supprimer DELETE  /calendars/calendarId/events/eventId Supprime un événement.
get GET  /calendars/calendarId/events/eventId Renvoie un événement en fonction de son ID Google Agenda. Pour récupérer un événement à l'aide de son ID iCalendar, appelez la méthode events.list en utilisant le paramètre iCalUID.
import POST  /calendars/calendarId/events/import Importe un événement. Cette opération permet d'ajouter une copie privée d'un événement existant à un agenda. Seuls les événements dont le eventType est défini sur default peuvent être importés.

Comportement obsolète : si un événement autre que default est importé, son type sera remplacé par default et toutes les propriétés spécifiques au type d'événement qu'il peut comporter seront supprimées.
insérer POST  /calendars/calendarId/events Crée un événement.
instances GET  /calendars/calendarId/events/eventId/instances Renvoie les instances de l'événement périodique spécifié.
liste GET  /calendars/calendarId/events Renvoie les événements de l'agenda spécifié.
move POST  /calendars/calendarId/events/eventId/move Déplace un événement vers un autre agenda, c'est-à-dire modifie l'organisateur d'un événement. Notez que seuls les événements default peuvent être déplacés. Les événements birthday, focusTime, fromGmail, outOfOffice et workingLocation ne peuvent pas l'être.

Paramètres de requête requis : destination

patch PATCH  /calendars/calendarId/events/eventId Met à jour un événement. 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 requête 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.
quickAdd POST  /calendars/calendarId/events/quickAdd Crée un événement à partir d'une simple chaîne de texte.

Paramètres de requête requis : text

update PUT  /calendars/calendarId/events/eventId Met à jour un événement. Cette méthode n'est pas compatible avec la sémantique "patch" et met toujours à jour l'intégralité de la ressource d'événement. Pour effectuer une mise à jour partielle, effectuez une requête get suivie d'une requête update à l'aide d'etags pour garantir l'atomicité.
regarder POST  /calendars/calendarId/events/watch Surveillez les modifications apportées aux ressources "Events".

Disponibilité

Pour en savoir plus sur la ressource "Freebusy", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
query POST  /freeBusy Renvoie des informations de disponibilité pour un ensemble d'agendas.

Paramètres

Pour plus de détails sur la ressource "Settings", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/calendar/v3, sauf indication contraire
get GET  /users/me/settings/setting Renvoie un paramètre utilisateur unique.
liste GET  /users/me/settings Renvoie tous les paramètres utilisateur pour l'utilisateur authentifié.
regarder POST  /users/me/settings/watch Surveillez les modifications apportées aux ressources de paramètres.