Calendar API は、リマインダーと通知をサポートしています。
- リマインダー は、予定の開始時刻の指定された時間にトリガーされるアラームです。
- 通知 を使用すると、ユーザーはカレンダーの予定の変更を確認できます。
後者はプッシュ 通知と混同しないでください。プッシュ通知はユーザーに配信されるのではなく、カレンダーの変更を別のサーバーに通知します。
Google カレンダーの通知について詳しくは、 Google カレンダーの通知を変更するをご覧ください。
リマインダー
リマインダーは次の要素で構成されます。
- リマインダーを表示するタイミング(予定の開始時刻の何分前か)
- 使用する配信方法(配信メカニズムを参照)
リマインダーは、カレンダー全体と個々の予定に対して指定できます。ユーザーは、各カレンダーにデフォルトのリマインダー を設定できます。このデフォルトは、そのカレンダー内のすべての予定に適用されます。ただし、ユーザーは個々の予定に対してこれらのデフォルトをオーバーライドし、別のリマインダー セットに置き換えることもできます。
デフォルトのリマインダー
リマインダーは、認証されたユーザーに固有の非公開情報であり、複数のユーザー間で 共有されることはありません。その結果:
- デフォルトのリマインダーは、ユーザー固有のカレンダー メタデータを含む CalendarList コレクションを介して操作されます。
- すべてのユーザー間で共有されるグローバル メタデータを含む Calendars コレクションからはアクセスできません 。
デフォルトのリマインダーは、予定リストのクエリを実行したときにも返されます。
デフォルトのリマインダーのオーバーライド
予定を挿入または変更するときにデフォルトのリマインダーをオーバーライドするには、
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 で挿入または
更新された予定のメール通知を参加者に送信するには、
insert または
update メソッドを呼び出し、
sendUpdates パラメータを "all" または "externalOnly" に設定します。
配信メカニズム
Google カレンダーで提供される配信方法は次のとおりです。
- ポップアップ 。モバイル プラットフォームとウェブ クライアントでサポートされています。
- サーバーから送信されるメール 。
次の表に、リマインダーまたは通知タイプごとにサポートされている方法を示します。
| ポップアップ | メール | ||
|---|---|---|---|
| リマインダー | デフォルトのリマインダー | ✓ | ✓ |
| リマインダーのオーバーライド | ✓ | ✓ | |
| 通知 | 予定の作成 | ❌ | ✓ |
| 予定の変更 | ❌ | ✓ | |
| 予定のキャンセル | ❌ | ✓ | |
| 参加者の返答 | ❌ | ✓ | |
| アジェンダ | ❌ | ✓ |