L'API Agenda est compatible avec les rappels et les notifications.
- Les rappels sont des alarmes déclenchées à une heure spécifiée avant le début d'un événement.
- Les notifications permettent aux utilisateurs de savoir si des modifications ont été apportées aux événements de leur agenda.
Ce dernier élément ne doit pas être confondu avec les notifications push qui, au lieu d'être envoyées à un utilisateur, informent un autre serveur des modifications apportées à un calendrier.
Pour en savoir plus sur les notifications dans Google Agenda, consultez Modifier les notifications Google Agenda.
Rappels
Un rappel se compose des éléments suivants:
- Heure à laquelle le rappel doit s'afficher, exprimée en minutes avant l'heure de début de l'événement
- Mode de diffusion à utiliser (voir Méthodes de diffusion)
Vous pouvez spécifier des rappels pour des agendas entiers et pour des événements individuels. Les utilisateurs peuvent définir des rappels par défaut pour chacun de leurs agendas. Ces valeurs par défaut s'appliquent à tous les événements de cet agenda. Toutefois, les utilisateurs peuvent également remplacer ces valeurs par défaut pour des événements individuels, en les remplaçant par un autre ensemble de rappels.
Rappels par défaut
Les rappels sont des informations privées, spécifiques à un utilisateur authentifié. Ils ne sont pas partagés entre plusieurs utilisateurs. Par conséquent :
- Les rappels par défaut sont manipulés via la collection CalendarList, qui contient des métadonnées d'agenda spécifiques à l'utilisateur.
- Elles ne sont pas accessibles via la collection "Agendas", qui contient des métadonnées globales partagées par tous les utilisateurs.
Les rappels par défaut sont également renvoyés lorsque vous effectuez une requête de liste d'événements.
Remplacer les rappels par défaut
Pour remplacer les rappels par défaut lorsque vous insérez ou modifiez un événement, définissez reminders.useDefault sur false
et renseignez reminders.overrides avec le nouveau rappel défini.
"reminders": {
"useDefault": false,
# Overrides can be set if and only if useDefault is false.
"overrides": [
{
"method": "reminderMethod",
"minutes": "reminderMinutes"
},
# ...
]
}
Pour revenir à l'ensemble de rappels par défaut, définissez le paramètre reminders.useDefault sur true
.
Notifications
Agenda est compatible avec les types de notifications suivants:
- Création d'un événement: un nouvel événement est ajouté à l'un des agendas de l'utilisateur.
- Modification d'un événement: l'organisateur a modifié un événement auquel l'utilisateur a été invité.
- Annulation d'un événement: un événement auquel l'utilisateur a été invité est annulé.
- Réponse d'un participant: un participant à un événement créé par l'utilisateur a modifié son état de réponse.
- Agenda: liste de tous les événements de l'agenda de l'utilisateur, envoyée au début de la journée.
L'utilisateur peut choisir les notifications à activer par agenda et la méthode de diffusion pour chaque type de notification. Ces paramètres ne sont pas partagés avec d'autres utilisateurs. Comme les rappels par défaut, ils sont accessibles via la collection CalendarList.
Pour envoyer des notifications par e-mail aux participants pour les événements insérés ou mis à jour via l'API, définissez le paramètre sendNotifications
dans la requête d'insertion/mise à jour sur "true".
Mécanismes de diffusion
Google Agenda propose les modes de diffusion suivants:
- Pop-up Ils sont compatibles avec les plates-formes mobiles et les clients Web.
- E-mail envoyé par le serveur.
Le tableau suivant présente les méthodes compatibles pour chaque type de rappel ou de notification:
Pop-up | |||
---|---|---|---|
Rappels | Rappels par défaut | ✓ | ✓ |
Ignorer les rappels | ✓ | ✓ | |
Notifications | Création d'événements | ❌ | ✓ |
Modification d'événement | ❌ | ✓ | |
Annulation des événements | ❌ | ✓ | |
Réponse des participants | ❌ | ✓ | |
Sommaire | ❌ | ✓ |