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