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 カレンダーの配信方法には次のものがあります。
- ポップアップ。これらは、モバイル プラットフォームとウェブ クライアントでサポートされています。
- サーバーによって送信されるメール。
次の表に、リマインダーまたは通知の種類ごとにサポートされている方法を示します。
ポップアップ | メール | ||
---|---|---|---|
リマインダー | デフォルトのリマインダー | ✓ | ✓ |
リマインダーをオーバーライドする | ✓ | ✓ | |
通知 | イベントの作成 | ❌ | ✓ |
イベントの変更 | ❌ | ✓ | |
イベントのキャンセル | ❌ | ✓ | |
参加者の回答 | ❌ | ✓ | |
アジェンダ | ❌ | ✓ |