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. LCA
  2. CalendarList
  3. Agendas
  4. Canaux
  5. Couleurs
  6. Événements
  7. Disponibilité
  8. Paramètres

Acl

Pour en savoir plus sur la ressource LCA, 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 d'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 figurant dans la liste de contrôle d'accès pour 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. Utilisez de préférence 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. S'ils sont spécifiés, les champs de tableau écrasent les tableaux existants. Tous les éléments précédents du tableau sont alors supprimés.
mise à jour PUT  /calendars/calendarId/acl/ruleId Met à jour une règle de contrôle des accès.
montre 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 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  /users/me/calendarList/calendarId Supprime un agenda de la liste d'agendas de l'utilisateur.
get GET  /users/me/calendarList/calendarId Renvoie un agenda à partir 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 figurant dans la liste d'agendas de l'utilisateur.
patch PATCH  /users/me/calendarList/calendarId Met à jour un agenda existant dans la liste d'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. Utilisez de préférence 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. S'ils sont spécifiés, les champs de tableau écrasent les tableaux existants. Tous les éléments précédents du tableau sont alors supprimés.
mise à jour PUT  /users/me/calendarList/calendarId Met à jour un agenda existant dans la liste d'agendas de l'utilisateur.
montre POST  /users/me/calendarList/watch Surveillez les modifications apportées aux ressources CalendarList.

Calendriers

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 calendar.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 ;
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. Utilisez de préférence 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. S'ils sont spécifiés, les champs de tableau écrasent les tableaux existants. Tous les éléments précédents du tableau sont alors supprimés.
mise à jour PUT  /calendars/calendarId Met à jour les métadonnées d'un agenda.

Canaux

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
arrêter POST  /channels/stop Arrêtez de regarder les ressources via 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 Affiche les définitions de couleurs des agendas et des événements.

Événements

Pour en savoir plus sur la ressource "Événements", 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éthodeevents.list à l'aide du 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 l'eventType correspond à 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 ses propriétés spécifiques au type d'événement seront ignoré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é.
déplacer POST  /calendars/calendarId/events/eventId/move Déplace un événement vers un autre agenda ou change l'organisateur de l'événement. Notez que seuls les événements default peuvent être déplacés ; les événements outOfOffice, focusTime, workingLocation et fromGmail ne peuvent pas être déplacés.

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. Utilisez de préférence 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. S'ils sont spécifiés, les champs de tableau écrasent les tableaux existants. Tous les éléments précédents du tableau sont alors supprimés.
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

mise à jour 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 get suivie d'une update à l'aide d'etags pour garantir l'atomicité.
montre POST  /calendars/calendarId/events/watch Surveillez les modifications apportées aux ressources Événements.

Disponibilité

Pour en savoir plus sur la ressource "Disponibilité", 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 Affiche les informations de disponibilité d'un ensemble d'agendas.

Paramètres

Pour en savoir plus 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 seul paramètre utilisateur.
liste GET  /users/me/settings Renvoie tous les paramètres utilisateur de l'utilisateur authentifié.
montre POST  /users/me/settings/watch Surveillez les modifications apportées aux ressources de paramètres.