CalendarList リソースの変更を監視します。
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/calendar/v3/users/me/calendarList/watch
パラメータ
パラメータ名 | 値 | 説明 |
---|
承認
このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。
範囲 |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.calendarlist |
https://www.googleapis.com/auth/calendar.calendarlist.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 のタイムスタンプでミリ秒単位で表示されます。省略可。 |