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
LCA
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 d'accès. |
| obtenir |
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 d'accès. |
| list |
GET /calendars/calendarId/acl
|
Renvoie les règles de la liste de contrôle d'accès de l'agenda. |
| correctif |
PATCH /calendars/calendarId/acl/ruleId
|
Met à jour une règle de contrôle d'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 une get suivie d'une 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 seront alors supprimés.
|
| mettre à jour |
PUT /calendars/calendarId/acl/ruleId
|
Met à jour une règle de contrôle d'accès. |
| montre |
POST /calendars/calendarId/acl/watch
|
Surveillez les modifications apportées aux ressources des LCA. |
Liste des agendas
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. |
| obtenir |
GET /users/me/calendarList/calendarId
|
Renvoie un agenda dans la liste d'agendas de l'utilisateur. |
| insérer |
POST /users/me/calendarList
|
Insère un agenda existant dans la liste d'agendas de l'utilisateur. |
| list |
GET /users/me/calendarList
|
Renvoie les agendas dans la liste des agendas de l'utilisateur. |
| correctif |
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. Utilisez de préférence une get suivie d'une 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 seront alors supprimés.
|
| mettre à jour |
PUT /users/me/calendarList/calendarId
|
Met à jour un agenda existant dans la liste des 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. |
| obtenir |
GET /calendars/calendarId
|
Renvoie les métadonnées d'un agenda. |
| insérer |
POST /calendars
|
Crée un agenda secondaire. |
| correctif |
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 une get suivie d'une 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 seront alors supprimés.
|
| mettre à jour |
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 | ||
| arrêter |
POST /channels/stop
|
Arrêtez de regarder des ressources via ce canal. |
Coloris
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 | ||
| obtenir |
GET /colors
|
Renvoie les définitions de couleur 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. |
| obtenir |
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 à l'aide du paramètre iCalUID.
|
| importer |
POST /calendars/calendarId/events/import
|
Importe un événement. Cette opération permet d'ajouter à un agenda une copie privée d'un événement existant. |
| 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é. |
| list |
GET /calendars/calendarId/events
|
Renvoie les événements de l'agenda spécifié. |
| déplacer |
POST /calendars/calendarId/events/eventId/move
|
Permet de déplacer un événement vers un autre agenda (c'est-à-dire de modifier l'organisateur d'un événement).
Paramètres de requête requis:
|
| correctif |
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 une get suivie d'une 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 seront alors supprimés.
|
| quickAdd |
POST /calendars/calendarId/events/quickAdd
|
Crée un événement à partir d'une chaîne de texte simple.
Paramètres de requête requis:
|
| mettre à 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 opération get suivie d'une opération update à l'aide d'etags afin de 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 "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
|
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 | ||
| obtenir |
GET /users/me/settings/setting
|
Renvoie un seul paramètre utilisateur. |
| list |
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 des paramètres. |