Subscriptions

Mirror API 可讓您訂閱通知，當使用者針對時間軸項目採取特定動作或使用者位置資訊更新時，就會傳送相關通知。

如需本資源的方法清單，請見本頁結尾。

資源表示法

集合上的事件訂閱。

{
  "kind": "mirror#subscription",
  "id": string,
  "updated": datetime,
  "collection": string,
  "operation": [
    string
  ],
  "callbackUrl": string,
  "verifyToken": string,
  "userToken": string,
  "notification": {
    "collection": string,
    "itemId": string,
    "operation": string,
    "userActions": [
      {
        "type": string,
        "payload": string
      }
    ],
    "verifyToken": string,
    "userToken": string
  }
}
屬性名稱 值 說明 附註
callbackUrl string 要傳送通知的網址 (開頭必須為 https://)。 可寫入
collection string 要訂閱的最愛。允許的值包括：
  • timeline - 時間軸中的變更，包括插入、刪除和更新。
  • locations - 位置更新。
  • settings - 設定更新。
 可寫入
id string 訂閱項目的 ID。
kind string 資源的類型。一律為 mirror#subscription。
notification nested object 通知的容器物件。系統不會在 Subscription 資源中填入這項資訊。
notification.collection string 產生通知的集合。
notification.itemId string 產生通知的項目 ID。
notification.operation string 產生通知的作業類型。

可接受的值為：
  • 「DELETE」
  • 「INSERT」
  • 「MENU_ACTION」
  • 「UPDATE」
notification.userActions[] list 觸發通知的使用者所採取的動作清單。
notification.userActions[].payload string 動作的選用酬載。

如果是 CUSTOM 類型的動作，這是所選自訂選單項目的 ID。
notification.userActions[].type string 動作類型。這個值可以是：
  • SHARE - 使用者共用了一個項目。
  • REPLY - 使用者回覆了一個項目。
  • REPLY_ALL - 使用者回覆了某個項目的所有收件者。
  • CUSTOM - 使用者在時間軸項目中選取自訂選單項目。
  • DELETE - 使用者刪除了這個項目。
  • PIN：使用者固定了該項目。
  • UNPIN：使用者已取消固定項目。
  • LAUNCH：使用者啟動語音指令。
，日後我們可能會新增其他類型。請忽略類型無法辨識的 UserActions。
notification.userToken string 服務訂閱通知時所提供的使用者憑證。
notification.verifyToken string 服務在訂閱通知時提供的密鑰驗證權杖。
operation[] list 列出應訂閱的作業。如果清單空白，代表要訂閱集合的所有作業。允許的值包括：
  • UPDATE - 項目已更新。
  • INSERT - 已插入新項目。
  • DELETE - 項目已刪除。
 可寫入
updated datetime 這個訂閱項目上次修改的時間，採用 RFC 3339 格式。
userToken string 傳送至通知訂閱者的不透明權杖，以便系統判斷使用者的 ID。 可寫入
verifyToken string 透過通知傳送給訂閱者的秘密權杖，用於驗證通知是否由 Google 產生。 可寫入

方法

刪除
刪除訂閱項目。
插入
建立新的訂閱項目。
list
擷取已驗證使用者和服務的訂閱清單。
更新
更新現有的訂閱項目。