プッシュ通知

必須のプロパティ

それぞれの watchリクエストごとに、次を提供する必要があります:

• あなたのプロジェクト内でこの新しい通知チャネルをユニークに識別する、idプロパティ文字列。 私たちは、ユニバーサルにユニークな識別子(UUID)あるいは類似のユニークな文字列を使用することをお勧めします。 最大長: 64文字。

  セットした ID値は、このチャネルのために受信しるすべての通知メッセージの X-Goog-Channel-Id HTTPヘッダ内にエコーバックされます。

• 値 web_hookをセットされた typeプロパティ文字列。

• この通知チャネルのための通知をリッスンし、応答する URLをセットされた addressプロパティ文字列。 これは、あなたの Webhookコールバック URLで、それは HTTPSを使用しなければなりません。

  Drive APIは、有効な SSL証明書があなたのウェブサーバ上にインストールされている場合にのみ、この HTTPSアドレスに通知を送信することができるでしょう。 無効な証明書は次のとおりです:

  • 自己署名された証明書。
  • 信頼できないソースによって署名された証明書。
  • 取り消された証明書。
  • ターゲットホスト名と一致しないサブジェクトを持つ証明書。

オプションのプロパティ

あなたの watchリクエストを用いて、これらのオプションのフィールドを指定することもできます:

• チャネルトークンとして使用するための任意の文字列値を指定する、tokenプロパティ。 さまざまな目的のために通知チャネルを使用することができます。 例えば、それぞれの受信メッセージがあなたのアプリケーションが作成したチャネルのものであることを検証するために — 通知がスプーフィングされていないことを保証するために — あるいは、このチャネルの目的に基づいてあなたのアプリケーション内の正しい宛先にメッセージをルーティングするために、このトークンを使用することができます。 最大長: 256文字。

  トークンは、このチャネルのためにあなたのアプリケーションが受信するすべての通知メッセージ内の X-Goog-Channel-Token HTTPヘッダに含まれています。

  もし通知チャネルトークンを使用するならば、私たちは次のことをお勧めします:

  • URLクエリパラメータといった、拡張可能なエンコーディング形式を使用してください。 例: forwardTo=hr&createdBy=mobile

  • OAuthトークンといった、機密データを含めないでください。

• Drive APIがこの通知チャネルのためにメッセージを送信することを停止させたい日時の Unix timestamp(ミリ秒単位)がセットされた expirationプロパティ文字列。

  もしチャネルが有効期限を持っているならば、それは、あなたのアプリケーションがこのチャネルのために受信するすべての通知メッセージにて X-Goog-Channel-Expiration HTTPヘッダ(この時刻は人間が読み取り可能な形式)の値として含まれています。

同期メッセージ

リソースを監視するために新しい通知チャネルを作成した後、Drive APIは、通知が開始していることを示すために syncメッセージを送信します。 これらのメッセージの X-Goog-Resource-State HTTPヘッダは、syncです。 ネットワークのタイミングの問題によって、watchメソッドの応答を受信する前に、syncメッセージを受信する可能性があります。

sync通知を無視することは安全ですが、それを使用することもできます。 例えば、もしチャネルを維持したくなければ、通知の受信を停止するへの呼び出しにて X-Goog-Channel-IDおよび X-Goog-Resource-IDを使用することができます。 さらには、後のイベントを準備するための幾つかの初期化を行うために、sync通知を使用することができます。

Drive APIがあなたの受信 URLに送信する syncメッセージの形式は、次のとおりです。

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format; present only if channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

同期メッセージは、常に、値が 1である X-Goog-Message-Number HTTPヘッダを持っています。 このチャネルのためのそれぞれの後続の通知は、以前のものより大きなメッセージ番号を持っているでしょうが、そのメッセージ番号は連続しないでしょう。

ヘッダ

あなたの受信 URLに Drive APIによってポストされた通知メッセージは、次の HTTPヘッダを含んでいます:

例

ファイルリソースのための変更通知メッセージです、それは、リクエストボディを含んでいません:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: 4ba78bf0-6a47-11e2-bcfd-0800200c9a66
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://www.googleapis.com/drive/v3/files/ret08u3rv24htgh289g
X-Goog-Resource-State:  update
X-Goog-Changed: content,properties
X-Goog-Message-Number: 10

変更リソースのための変更通知メッセージです、それは、リクエストボディを含んでいます:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 118
X-Goog-Channel-ID: 8bd90be9-3a58-3122-ab43-9823188a5b43
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://www.googleapis.com/drive/v3/changes
X-Goog-Resource-State:  changed
X-Goog-Message-Number: 23

{
  "kind": "drive#changes"
}