リマインダーと通知

Calendar API は、リマインダーと通知をサポートしています。

  • リマインダーは、予定の開始時刻の指定された時間にトリガーされるアラームです。
  • 通知を使用すると、カレンダーの予定の変更についてユーザーに通知できます。

後者は、ユーザーに配信されるのではなく、カレンダーの変更を別のサーバーに通知するプッシュ通知と混同しないでください。

Google カレンダーの通知について詳しくは、Google カレンダーの通知設定を変更するをご覧ください。

リマインダー

リマインダーは次の要素で構成されます。

  • 通知を表示するタイミング(イベントの開始時刻の何分前か)
  • 使用する配信方法(配信メカニズムを参照)

リマインダーは、カレンダー全体と個々の予定に対して指定できます。ユーザーは、各カレンダーにデフォルトのリマインダーを設定できます。このデフォルトは、そのカレンダー内のすべての予定に適用されます。ただし、ユーザーは個々の予定でこれらのデフォルトをオーバーライドして、別のリマインダー セットに置き換えることもできます。

デフォルトのリマインダー

リマインダーは認証済みユーザーに固有の個人情報であり、複数のユーザー間で共有されることはありません。結果として次のようになります。

  • デフォルトのリマインダーは、ユーザー固有のカレンダー メタデータを含む CalendarList コレクションを介して操作されます。
  • すべてのユーザー間で共有されるグローバル メタデータを含む Calendars コレクションからはアクセスできません。

イベント リストのクエリを実行すると、デフォルトのリマインダーも返されます。

デフォルトのリマインダーをオーバーライドする

イベントの挿入または変更時にデフォルトのリマインダーをオーバーライドするには、reminders.useDefaultfalse に設定し、reminders.overrides に新しいリマインダー セットを入力します。

"reminders": {
  "useDefault": false,
  # Overrides can be set if and only if useDefault is false.
  "overrides": [
      {
        "method": "reminderMethod",
        "minutes": "reminderMinutes"
      },
      # ...
  ]
}

デフォルトのリマインダー セットに戻すには、reminders.useDefault の設定を true に更新します。

通知

カレンダーでは、次の通知タイプがサポートされています。

  • 予定の作成: ユーザーのカレンダーのいずれかに新しい予定が追加されます。
  • 予定の変更: ユーザーが招待された予定が主催者によって変更されました。
  • 予定のキャンセル: ユーザーが招待された予定がキャンセルされました。
  • 出席者の返信: ユーザーが作成した予定の出席者が返信ステータスを変更しました。
  • 予定: ユーザーのカレンダーにあるすべての予定のリスト。一日の始まりに送信されます。

ユーザーは、カレンダーごとに有効にする通知と、通知タイプごとの配信方法を指定できます。これらの設定は他のユーザーと共有されません。デフォルトのリマインダーと同様に、CalendarList コレクションからアクセスできます。

API で挿入または更新されたイベントの参加者にメール通知を送信するには、insert メソッドまたは update メソッドを呼び出し、sendUpdates パラメータを "all" または "externalOnly" に設定します。

配信メカニズム

Google カレンダーで提供される配信方法は次のとおりです。

  • ポップアップ。これらは、モバイル プラットフォームとウェブ クライアントでサポートされています。
  • サーバーから送信されたメール

次の表に、リマインダーまたは通知の種類ごとにサポートされている方法を示します。

ポップアップ メール
リマインダー デフォルトのリマインダー
リマインダーをオーバーライドする
通知 イベントの作成
イベントの変更
予定のキャンセル
参加者の返答
アジェンダ