このページは Cloud Translation API によって翻訳されました。

Events: watch

イベントリソースの変更を監視します。

リクエスト

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`

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

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

{
  "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 のタイムスタンプでミリ秒単位で表示されます。省略可。