Changes: watch

注: 認証が必要です。

ユーザーの変更に登録します。このメソッドを使用するには、pageToken クエリ パラメータを含める必要があります。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/drive/v3/changes/watch

パラメータ

パラメータ名	値	説明
省略可能なクエリ パラメータ
fields	string	レスポンスに含めるフィールドのパスです。指定しない場合は、このメソッドに固有のデフォルトのフィールド セットがレスポンスに含まれます。開発の場合、特別な値 * を使用してすべてのフィールドを返すことができますが、必要なフィールドのみを選択してパフォーマンスを向上させることができます。詳しくは、ファイルの特定のフィールドを返すをご覧ください。
includeLabels	string	レスポンスの labelInfo 部分に含めるラベルの ID のカンマ区切りのリスト。

承認

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

範囲
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.photos.readonly

一部のスコープは制限されているため、アプリで使用するにはセキュリティ評価が必要です。詳細については、認証と承認のページをご覧ください。

リクエスト本文

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

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    (key): string
  }
}

プロパティ名	値	説明	備考
kind	string	リソース（api#channel）の変更を監視するために使用される通知チャンネルであることを示します。
id	string	このチャンネルを識別する UUID または一意の文字列。
resourceId	string	このチャンネルで監視するリソースを識別する不透明な ID。異なる API バージョンでも安定しています。
resourceUri	string	監視対象のリソースのバージョン固有の ID。
token	string	このチャンネル経由で通知と一緒に対象のアドレスに配布される任意の文字列。省略可。
expiration	long	通知チャンネルの有効期限。Unix のタイムスタンプでミリ秒単位で表示されます。省略可。
type	string	このチャンネルで使用される配信方法の種類。有効な値は「web_hook」（または「webhook」）です。どちらの値も、メッセージの配信に HTTP リクエストを使用するチャネルを指します。
address	string	このチャンネルの通知が配信されるアドレス。
payload	boolean	ペイロードが必要かどうかを表すブール値。省略可。
params	object	配信チャンネルの操作を制御する追加のパラメータ。省略可。
params.(key)	string	新しいパラメータを名前で宣言します。

レスポンス

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

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    (key): string
  }
}

プロパティ名	値	説明	備考
kind	string	リソース（api#channel）の変更を監視するために使用される通知チャンネルであることを示します。
id	string	このチャンネルを識別する UUID または一意の文字列。
resourceId	string	このチャンネルで監視するリソースを識別する不透明な ID。異なる API バージョンでも安定しています。
resourceUri	string	監視対象のリソースのバージョン固有の ID。
token	string	このチャンネル経由で通知と一緒に対象のアドレスに配布される任意の文字列。省略可。
expiration	long	通知チャンネルの有効期限。Unix のタイムスタンプでミリ秒単位で表示されます。省略可。
type	string	このチャンネルで使用される配信方法の種類。有効な値は「web_hook」（または「webhook」）です。どちらの値も、メッセージの配信に HTTP リクエストを使用するチャネルを指します。
address	string	このチャンネルの通知が配信されるアドレス。
payload	boolean	ペイロードが必要かどうかを表すブール値。省略可。
params	object	配信チャンネルの操作を制御する追加のパラメータ。省略可。
params.(key)	string	新しいパラメータを名前で宣言します。