資源變更通知

本文將說明如何使用推播通知，在資源發生變更時通知應用程式。

總覽

Google Drive API 提供推播通知，讓您監控資源的變更。您可以使用這項功能改善應用程式效能。這可讓您消除與輪詢資源相關的額外網路和運算成本，以便判斷資源是否已變更。每當有監控的資源發生變更，Google 雲端硬碟 API 就會通知您的應用程式。

如要使用推播通知，您必須完成以下兩個步驟：

  • 設定接收網址或「Webhook」回呼接收器。

    這是 HTTPS 伺服器，可處理資源變更時觸發的 API 通知訊息。

  • 為每個要監控的資源端點設定 (通知管道)。

    管道會指定通知訊息的路由資訊。在管道設定中，您必須指定要接收通知的特定網址。每當管道的資源發生變更時，Google Drive API 就會將通知訊息以 POST 要求傳送至該網址。

目前，Google 雲端硬碟 API 支援 files 和 changes 方法的變更通知。

建立通知管道

如要要求推播通知，您必須為每個要監控的資源設定通知管道。設定通知管道後，Google Drive API 會在任何監控的資源發生變更時通知您的應用程式。

提出監控要求

每個可觀看的 Google 雲端硬碟 API 資源，都會在以下格式的 URI 中，提供相關聯的 watch 方法：

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

如要設定通知管道，以便接收有關特定資源變更的訊息，請將 POST 要求傳送至資源的 watch 方法。

每個通知管道都會與特定使用者和特定資源 (或一組資源) 建立關聯。除非目前的使用者或服務帳戶擁有或具備存取此資源的權限，否則 watch 要求不會成功。

範例

以下程式碼範例說明如何使用 channels 資源，透過 files.watch 方法開始監控單一 files 資源的變更：

POST https://www.googleapis.com/drive/v3/files/fileId/watch
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your files channel token.
  "expiration": 1426325213000 // (Optional) Your requested channel expiration date and time.
}

以下程式碼範例說明如何使用 channels 資源，透過 changes.watch 方法開始監控所有 changes：

POST https://www.googleapis.com/drive/v3/changes/watch
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a77", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myChangesChannelDest", // (Optional) Your changes channel token.
  "expiration": 1426325213000 // (Optional) Your requested channel expiration date and time.
}

必要屬性

您必須在每個 watch 要求中提供下列欄位：

  • id 屬性字串，可用於在專案中唯一識別這個新的通知管道。建議您使用通用專屬 ID (UUID) 或任何類似的專屬字串。長度上限：64 個半形字元。

    您設定的 ID 值會在您透過這個管道收到的每則通知訊息的 X-Goog-Channel-Id HTTP 標頭中回應。

  • type 屬性字串設為 web_hook 值。

  • address 屬性字串會設為網址，用於監聽及回應這個通知管道的通知。這是 Webhook 回呼網址，且必須使用 HTTPS。

    請注意，只有在網路伺服器上安裝有效的 SSL 憑證時，Google Drive API 才能將通知傳送至這個 HTTPS 位址。無效的憑證包括：

    • 自行簽署的憑證。
    • 由不受信任的來源所簽署的憑證。
    • 已撤銷的憑證。
    • 憑證的主體與目標主機名稱不符。

選用屬性

您也可以在 watch 要求中指定這些選用欄位：

  • token 屬性可指定任意字串值，用於做為頻道權杖。您可以將通知管道符記用於各種用途。舉例來說，您可以使用權杖驗證每則傳入訊息是否屬於應用程式建立的管道，以確保通知不會遭到偽造，或是根據這個管道的用途，將訊息路由至應用程式中的正確目的地。長度上限：256 個半形字元。

    權杖會納入應用程式透過這個管道收到的每則通知訊息中的 X-Goog-Channel-Token HTTP 標頭。

    如果您使用通知管道符記，建議您：

    • 使用可擴充的編碼格式，例如網址查詢參數。範例：forwardTo=hr&createdBy=mobile

    • 請勿加入 OAuth 權杖等機密資料。

  • expiration 屬性字串，設為您希望 Google Drive API 停止傳送此通知管道訊息的日期和時間的 Unix 時間戳記 (以毫秒為單位)。

    如果管道設有到期時間，則在應用程式收到的每則管道通知訊息中，這項資訊會以 X-Goog-Channel-Expiration HTTP 標頭的值 (以人類可讀格式呈現) 的形式加入。

如要進一步瞭解要求，請參閱 API 參考資料中 files 和 changes 方法的 watch 方法。

觀看回應

如果 watch 要求成功建立通知管道，則會傳回 HTTP 200 OK 狀態碼。

手錶回應的訊息主體會提供您剛建立的通知管道相關資訊，如以下範例所示。

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab"", // ID you specified for this channel.
  "resourceId": "o3hgv1538sdjfh", // ID of the watched resource.
  "resourceUri": "https://www.googleapis.com/drive/v3/files/o3hgv1538sdjfh", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 1426325213000, // Actual expiration date and time as UNIX timestamp (in milliseconds), if applicable.
}

除了您在要求中傳送的屬性之外，傳回的資訊還包含 resourceId 和 resourceUri，用於識別在這個通知管道中監控的資源。

您可以將傳回的資訊傳遞至其他通知管道作業，例如想停止接收通知時。

如要進一步瞭解回應，請參閱 API 參考資料中 files 和 changes 方法的 watch 方法。

同步處理訊息

建立通知管道來監控資源後，Google Drive API 會傳送 sync 訊息，表示通知已開始。這些訊息的 X-Goog-Resource-State HTTP 標頭值為 sync。由於網路時間問題，您可能會在收到 watch 方法回應之前，就收到 sync 訊息。

您可以安全地忽略 sync 通知，但也可以使用這項通知。舉例來說，如果您決定不保留管道，可以在呼叫中使用 X-Goog-Channel-ID 和 X-Goog-Resource-ID 值，停止接收通知。您也可以使用 sync 通知進行一些初始化作業，為日後的事件做好準備。

以下是 Google Drive API 傳送至接收網址的 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 the 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

同步處理訊息的 X-Goog-Message-Number HTTP 標頭值一律為 1。這個管道的後續通知訊息編號會比前一個大，但訊息編號不會依序排列。

續訂通知管道

通知管道可以設有到期時間，而該值的決定方式則取決於您的要求，或任何 Google Drive API 內部限制或預設值 (會使用較嚴格的值)。如果管道有到期時間，watch 方法會在傳回的資訊中加入 Unix 時間戳記 (以毫秒為單位)，做為管道的到期時間。此外，應用程式在 X-Goog-Channel-Expiration HTTP 標頭中，為這個管道收到的每則通知訊息中，都會包含到期日和時間 (以人類可讀格式)。

目前無法自動續訂通知管道。當管道即將到期時，您必須呼叫 watch 方法，將其替換為新的管道。如往，您必須為新管道的 id 屬性使用專屬值。請注意，當同一個資源的兩個通知管道都處於作用中狀態時，可能會出現「重疊」的時間。

接收通知

每當監控的資源有所變更，應用程式就會收到說明變更內容的通知訊息。Google Drive API 會將這些訊息以 HTTPS POST 要求的形式傳送至您為此通知管道指定的 address 屬性網址。

解讀通知訊息格式

所有通知訊息都包含一組具有 X-Goog- 前置字串的 HTTP 標頭。某些類型的通知也可以包含訊息主體。

標頭

Google Drive API 發布至接收網址的通知訊息會包含下列 HTTP 標頭：

標頭 說明
一律顯示
X-Goog-Channel-ID 您提供的 UUID 或其他專屬字串，用於識別此通知管道。
X-Goog-Message-Number 這個通知管道用來識別此訊息的整數。sync 訊息的值一律為 1。頻道上的後續訊息會增加訊息編號，但並非依序排列。
X-Goog-Resource-ID 識別受監控資源的不易解讀值。這個 ID 在各 API 版本中皆為穩定狀態。
X-Goog-Resource-State 觸發通知的新資源狀態。可能的值： sync、add、remove、update、trash、untrash 或 change。
X-Goog-Resource-URI 受監控資源的 API 版本專屬 ID。
有時會出現
X-Goog-Changed 變更的其他詳細資料。 可能的值：content、parents、children 或 permissions。sync 訊息不提供此資訊。
X-Goog-Channel-Expiration 通知管道到期日，以人類可讀的格式表示。只有在定義時才會出現。
X-Goog-Channel-Token 應用程式設定的通知管道符記，可用於驗證通知來源。只有在定義時才會出現。

files 和 changes 的通知訊息為空白。

範例

變更 files 資源的通知訊息 (不含要求主體)：

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

變更 changes 資源的通知訊息，其中包含要求主體：

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"
}

根據通知內容採取行動

如要表示成功，您可以傳回下列任一狀態碼：200、201、202、204 或 102。

如果您的服務使用 Google 的 API 用戶端程式庫，並傳回 500、502、503 或 504，Google Drive API 會以指數回退方式重試。其他所有傳回狀態碼都會視為訊息傳送失敗。

瞭解 Google Drive API 通知事件

本節將詳細說明使用 Google Drive API 推播通知時，您可能會收到的通知訊息。

X-Goog-Resource-State 適用對象 送達時
sync files、changes 已成功建立管道。你應該會開始收到相關通知。
add files 建立或共用資源。
remove files 已刪除或取消共用現有資源。
update files 資源的一或多項屬性 (中繼資料) 已更新。
trash files 資源已移至垃圾桶。
untrash files 資源已從垃圾桶移除。
change changes 新增一或多個變更記錄項目。

對於 update 事件，系統可能會提供 X-Goog-Changed HTTP 標頭。該標頭包含以半形逗號分隔的清單，說明發生的變更類型。

變更類型 意義
content 資源內容已更新。
properties 已更新一或多項資源屬性。
parents 已新增或移除一或多個資源父項。
children 新增或移除一或多個資源子項。
permissions 資源權限已更新。

以下是使用 X-Goog-Changed 標頭的範例：

X-Goog-Resource-State: update
X-Goog-Changed: content, permissions

停止通知

expiration 屬性可控制通知何時自動停止。您可以選擇在特定管道到期前停止接收通知，方法是在下列 URI 中呼叫 stop 方法：

https://www.googleapis.com/drive/v3/channels/stop

這個方法需要您至少提供管道的 id 和 resourceId 屬性，如以下範例所示。請注意，如果 Google 雲端硬碟 API 有多種具有 watch 方法的資源類型，就只有一個 stop 方法。

只有具備適當權限的使用者才能停止頻道。請特別注意以下幾點：

  • 如果頻道是由一般使用者帳戶建立，只有建立頻道的使用者 (透過 OAuth 2.0 授權憑證的用戶端 ID 識別) 才能停止頻道。
  • 如果頻道是由服務帳戶建立，則同一個用戶端的任何使用者都能停止頻道。

以下程式碼範例說明如何停止接收通知：

POST https://www.googleapis.com/drive/v3/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}