Calendar API は、リマインダーと通知をサポートしています。
- リマインダーは、予定の開始前に指定した時刻にトリガーされるアラームです。
- 通知を使用すると、カレンダーの予定の変更をユーザーに知らせることができます。
後者は、ユーザーに配信されるのではなく、カレンダーの変更を別のサーバーに通知するプッシュ通知と混同しないでください。
Google カレンダーの通知の詳細については、Google カレンダーの通知設定を変更するをご覧ください。
リマインダー
リマインダーは次の要素で構成されます。
- リマインダーを表示するタイミング（イベントの開始時間の分単位）
- 使用する配信方法（配信メカニズムを参照）
リマインダーは、カレンダー全体または個々の予定に対して指定できます。ユーザーは各カレンダーにデフォルトのリマインダーを設定できます。これらのデフォルトは、そのカレンダー内のすべての予定に適用されます。ただし、ユーザーは個々の予定でこれらのデフォルトをオーバーライドし、別のリマインダー セットに置き換えることもできます。
デフォルトのリマインダー
リマインダーは、認証済みユーザーに固有の機密情報であり、複数のユーザー間で共有されることはありません。結果として次のようになります。
- デフォルトのリマインダーは、ユーザー固有のカレンダー メタデータを含む CalendarList コレクションを介して操作されます。
- カレンダー コレクション（すべてのユーザー間で共有されるグローバル メタデータを含む）からはアクセスできません。
デフォルトのリマインダーは、イベントリストのクエリを実行したときにも返されます。
デフォルトのリマインダーのオーバーライド
イベントの挿入または変更時にデフォルトのリマインダーをオーバーライドするには、reminders.useDefault を false に設定し、新しいリマインダー セットを reminders.overrides に入力します。
"reminders": {
"useDefault": false,
# Overrides can be set if and only if useDefault is false.
"overrides": [
{
"method": "reminderMethod",
"minutes": "reminderMinutes"
},
# ...
]
}
デフォルトのリマインダー セットに戻すには、reminders.useDefault の設定を true に戻します。
通知
カレンダーでは、次の種類の通知がサポートされています。
- 予定の作成: ユーザーのいずれかのカレンダーに新しい予定が追加されます。
- 予定の変更: ユーザーが招待されている予定が主催者によって変更されました。
- イベントのキャンセル: ユーザーが招待されたイベントがキャンセルされました。
- 参加者の返信: ユーザーが作成した予定の参加者が返信ステータスを変更しました。
- アジェンダ: ユーザーのカレンダー内のすべての予定のリスト。1 日の開始時に送信されます。
ユーザーは、カレンダーごとに有効にする通知と、通知タイプごとの配信方法を決定できます。これらの設定は他のユーザーと共有されません。デフォルトのリマインダーと同様に、CalendarList コレクションからアクセスできます。
API を介して挿入または更新されたイベントの参加者にメール通知を送信するには、挿入/更新リクエストの sendNotifications パラメータを true に設定します。
配信メカニズム
Google カレンダーで利用できる配信方法は次のとおりです。
- ポップアップ。これらは、モバイル プラットフォームとウェブ クライアントでサポートされています。
- サーバーから送信されたメール。
次の表に、各リマインダーまたは通知タイプでサポートされているメソッドを示します。
| ポップアップ | メール | ||
|---|---|---|---|
| リマインダー | デフォルトのリマインダー | ✓ | ✓ |
| リマインダーをオーバーライドする | ✓ | ✓ | |
| 通知 | イベントの作成 | ❌ | ✓ |
| イベントの変更 | ❌ | ✓ | |
| 予定のキャンセル | ❌ | ✓ | |
| 参加者の返信 | ❌ | ✓ | |
| アジェンダ | ❌ | ✓ |