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 服务在订阅通知时提供的 Secret 验证令牌。
operation[] list 应订阅的操作列表。空列表表示应订阅对集合的所有操作。允许的值包括：
  • UPDATE - 项目已更新。
  • INSERT - 已插入新项。
  • DELETE - 项目已删除。
 可写入
updated datetime 此订阅的上次修改时间，格式遵循 RFC 3339 标准。
userToken string 在通知中发送给订阅者的不透明令牌，以便订阅者可以确定用户的 ID。 可写入
verifyToken string 一个在通知中发送给订阅者的秘密令牌，用于验证通知是否由 Google 生成。 可写入

方法

删除
删除订阅。
insert
创建新订阅。
list
检索经过身份验证的用户和服务的订阅列表。
update
更新现有订阅项目。