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