推播通知

必要屬性

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

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

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

• 設為 web_hook 值的 type 屬性字串。

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

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

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

選用屬性

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

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

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

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

  • 使用經過延伸的編碼格式，例如網址查詢參數。範例：forwardTo=hr&createdBy=mobile

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

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

  如果管道設有到期時間，則會在應用程式收到的每則管道通知訊息中，將該時間納入 X-Goog-Channel-Expiration HTTP 標頭的值 (以人類可讀格式表示)。

觀看回應

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

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

{
  "kind": "api#channel",
  "id": "reportsApiId", // ID you specified for this channel.
  "resourceId": "o3hgv1538sdjfh", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 3600, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

除了您在要求中傳送的屬性之外，系統也會傳回 resourceId 和 resourceUri，用於識別這個通知管道中正在監控的資源。

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

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

同步處理訊息

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

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

Admin SDK 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。這個管道的後續通知訊息編號會比前一個大，但訊息編號不會依序排列。

更新通知管道

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

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

解讀通知訊息格式

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

活動通知訊息會在要求主體中包含下列資訊：

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName
X-Goog-Resource-State:  eventName
X-Goog-Message-Number: 10

{
  "kind": "admin#reports#activity",
  "id": {
    "time": datetime,
    "uniqueQualifier": long,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "callerType": string,
    "email": string,
    "profileId": long
  },
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "name": string,
          "value": string,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 596
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?alt=json
X-Goog-Resource-State:  CREATE_USER
X-Goog-Message-Number: 23

{
  "kind": "admin#reports#activity",
  "id": {
    "time": "2013-09-10T18:23:35.808Z",
    "uniqueQualifier": "-0987654321",
    "applicationName": "admin",
    "customerId": "ABCD012345"
  },
  "actor": {
    "callerType": "USER",
    "email": "admin@example.com",
    "profileId": "0123456789987654321"
  },
  "ownerDomain": "apps-reporting.example.com",
  "ipAddress": "192.0.2.0",
  "events": [
    {
      "type": "USER_SETTINGS",
      "name": "CREATE_USER",
      "parameters": [
        {
          "name": "USER_EMAIL",
          "value": "liz@example.com"
        }
      ]
    }
  ]
}

根據通知內容採取行動

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

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

瞭解 Admin SDK API 通知事件

本節將詳細說明搭配 Admin SDK API 使用推播通知時可接收的通知訊息。

Reports API 推播通知包含兩種類型的訊息：同步訊息和事件通知。郵件類型會顯示在 X-Goog-Resource-State HTTP 標頭中。事件通知的可能值與 activities.list 方法相同。每個應用程式都有獨特的事件：

• admin
• 日曆
• 雲端硬碟
• groups
• login
• mobile
• saml
• 符記
• user_accounts