Subscriptions

Mirror API cho phép bạn đăng ký nhận thông báo được gửi khi người dùng thực hiện một số thao tác trên một mục dòng thời gian hoặc khi thông tin vị trí của người dùng được cập nhật.

Để biết danh sách các phương thức cho tài nguyên này, hãy xem ở cuối trang.

Biểu diễn tài nguyên

Gói đăng ký tham gia các sự kiện trên một bộ sưu tập.

{
  "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
  }
}

Tên tài sản	Giá trị	Mô tả	Ghi chú
callbackUrl	string	URL của trang cần gửi thông báo (phải bắt đầu bằng https://).	có thể ghi
collection	string	Bộ sưu tập bạn muốn đăng ký. Các giá trị được phép là: timeline – Các thay đổi trong dòng thời gian, bao gồm cả thao tác chèn, xoá và cập nhật. locations – Thông báo cập nhật vị trí. settings – Cập nhật chế độ cài đặt.	có thể ghi
id	string	Mã nhận dạng gói thuê bao.
kind	string	Loại tài nguyên. Thao tác này luôn là mirror#subscription.
notification	nested object	Đối tượng vùng chứa cho thông báo. Mã này không được điền sẵn trong tài nguyên Subscription.
notification.collection	string	Bộ sưu tập tạo thông báo.
notification.itemId	string	Mã của mặt hàng đã tạo thông báo.
notification.operation	string	Loại hoạt động đã tạo ra thông báo. Các giá trị được chấp nhận là: "DELETE" "INSERT" "MENU_ACTION" "UPDATE"
notification.userActions[]	list	Danh sách các hành động của người dùng đã kích hoạt thông báo.
notification.userActions[].payload	string	Tải trọng không bắt buộc cho thao tác. Đối với các thao tác thuộc loại CUSTOM, đây là mã của mục trong trình đơn tuỳ chỉnh đã chọn.
notification.userActions[].type	string	Loại hành động. Giá trị của tín hiệu này có thể là: SHARE - người dùng đã chia sẻ một mục. REPLY - người dùng đã trả lời một mặt hàng. REPLY_ALL - người dùng đã trả lời tất cả người nhận của một mục. CUSTOM – người dùng đã chọn một mục trong trình đơn tuỳ chỉnh trên mục trong dòng thời gian. DELETE – người dùng đã xoá mặt hàng. PIN - người dùng đã ghim mục. UNPIN – người dùng đã bỏ ghim mục. LAUNCH – người dùng đã bắt đầu một lệnh thoại. Trong tương lai, chúng tôi có thể thêm các loại khác. Bạn nên bỏ qua UserAction thuộc loại không nhận dạng được.
notification.userToken	string	Mã thông báo người dùng do dịch vụ cung cấp khi đăng ký nhận thông báo.
notification.verifyToken	string	Mã xác minh bí mật do dịch vụ cung cấp khi dịch vụ đăng ký nhận thông báo.
operation[]	list	Danh sách các thao tác cần được đăng ký. Danh sách trống cho biết tất cả các thao tác trên tập hợp đều phải được đăng ký. Các giá trị được phép là: UPDATE – Mục đã được cập nhật. INSERT – Một mục mới đã được chèn vào. DELETE – Mục đã bị xoá.	có thể ghi
updated	datetime	Thời điểm gói thuê bao này được sửa đổi lần gần đây nhất và được định dạng theo RFC 3339.
userToken	string	Mã thông báo mờ được gửi tới người đăng ký trong thông báo để có thể xác định ID của người dùng.	có thể ghi
verifyToken	string	Một mã bí mật được gửi đến người đăng ký trong phần thông báo để có thể xác minh rằng thông báo đó là do Google tạo.	có thể ghi

Phương thức

xóa

Xoá một gói thuê bao.

chèn

Tạo gói thuê bao mới.

list

Truy xuất danh sách gói thuê bao cho người dùng và dịch vụ đã được xác thực.

cập nhật

Cập nhật gói thuê bao hiện tại.