訂閱 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 } }
資源名稱 | 值 | 說明 | Notes |
---|---|---|---|
callbackUrl |
string |
通知傳送網址 (開頭必須為 https:// )。 |
可寫入 |
collection |
string |
要訂閱的珍藏內容。允許的值包括:
|
可寫入 |
id |
string |
訂閱項目的 ID。 | |
kind |
string |
資源類型。一律為 mirror#subscription 。 |
|
notification |
nested object |
通知的容器物件。這不會填入 Subscription 資源。 |
|
notification.collection |
string |
產生通知的集合。 | |
notification.itemId |
string |
產生通知的項目 ID。 | |
notification.operation |
string |
產生通知的作業類型。 可接受的值如下:
|
|
notification.userActions[] |
list |
觸發通知的使用者執行的動作清單。 | |
notification.userActions[].payload |
string |
動作的選用酬載。 如果是「 CUSTOM 」類型的動作,這是指所選自訂選單項目的 ID。 |
|
notification.userActions[].type |
string |
動作類型。可能的值包括:
|
|
notification.userToken |
string |
服務訂閱通知時提供的使用者憑證。 | |
notification.verifyToken |
string |
服務訂閱通知時提供的密鑰驗證憑證。 | |
operation[] |
list |
需要訂閱的作業清單。如果清單空白,代表該集合的所有作業都必須訂閱。允許的值包括:
|
可寫入 |
updated |
datetime |
上次修改此訂閱項目的時間,格式為 RFC 3339。 | |
userToken |
string |
通知中的不透明權杖傳送給訂閱者,以便判斷使用者的 ID。 | 可寫入 |
verifyToken |
string |
系統會透過通知傳送給訂閱者的密鑰憑證,以確認通知是由 Google 產生。 | 可寫入 |