Events: watch

Events リソースの変更を監視します。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

パラメータ

パラメータ名 値 説明
パスパラメータ
calendarId string カレンダー ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary」キーワードを使用します。
省略可能なクエリ パラメータ
eventTypes string 監視するリソースのイベントタイプ。省略可。このパラメータを複数回繰り返して、さまざまなタイプのリソースを監視できます。未設定の場合、すべてのイベントタイプが返されます。

有効な値は次のとおりです。
  • 「birthday」: 年間に 1 回繰り返される特別な終日の予定。
  • 「default」: 定期イベント。
  • 「focusTime」: サイレント モードの予定。
  • 「fromGmail」: Gmail からの予定。
  • 「outOfOffice」: 不在の予定。
  • 「workingLocation」: 勤務場所のイベント。

承認

このリクエストでは、少なくとも次のうち 1 つのスコープによる承認が可能です。

範囲
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

詳しくは、認証と認可のページをご覧ください。

リクエストの本文

リクエストの本文には、以下の構造を使用してデータを指定してください。

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
プロパティ名 値 説明 メモ
id string このチャンネルを識別する UUID または一意の文字列。
token string このチャンネル経由で通知と一緒に対象のアドレスに配布される任意の文字列。省略可。
type string このチャンネルで使用される配信方法の種類。有効な値は「web_hook」（または「webhook」）です。どちらの値も、Http リクエストを使用してメッセージが配信されるチャネルを指します。
address string このチャンネルの通知が配信されるアドレス。
params object 配信チャンネルの操作を制御する追加のパラメータ。省略可。
params.ttl string 通知チャネルの有効期間（秒単位）。デフォルトは 604,800 秒です。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
プロパティ名 値 説明 メモ
kind string リソースの変更を監視するために使用される通知チャンネルとして識別します（「api#channel」）。
id string このチャンネルを識別する UUID または一意の文字列。
resourceId string このチャンネルで監視するリソースを識別する不透明な ID。異なる API バージョンでも安定しています。
resourceUri string 監視対象のリソースのバージョン固有の ID。
token string このチャンネル経由で通知と一緒に対象のアドレスに配布される任意の文字列。省略可能。
expiration long 通知チャンネルの有効期限。Unix のタイムスタンプでミリ秒単位で表示されます。省略可。