借助 镜像 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 |
要订阅的集合。允许的值为:
|
可写入 |
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 |
服务在订阅通知时提供的 Secret 验证令牌。 | |
operation[] |
list |
应订阅的操作列表。空列表表示应该订阅该集合上的所有操作。允许的值为:
|
可写入 |
updated |
datetime |
上次修改此订阅的时间,其格式遵循 RFC 3339。 | |
userToken |
string |
在通知中向订阅者发送的不透明令牌,以便它可以确定用户的 ID。 | 可写入 |
verifyToken |
string |
在通知中向订阅者发送的秘密令牌,以便验证通知是否由 Google 生成。 | 可写入 |