API Phản chiếu 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 hành động cụ thể trên một mục trong dòng thời gian hoặc khi vị trí của người dùng đã được cập nhật.
Để biết danh sách phương thức cho tài nguyên này, hãy xem phần cuối của trang này.
Biểu diễn tài nguyên
Đăng ký theo dõi các sự kiện trong 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 nơi gửi thông báo (phải bắt đầu bằng https://). |
có thể ghi |
collection |
string |
Bộ sưu tập mà bạn muốn đăng ký. Các giá trị được cho phép là:
|
có thể ghi |
id |
string |
Mã của gói thuê bao. | |
kind |
string |
Loại tài nguyên. Đây luôn là mirror#subscription. |
|
notification |
nested object |
Đối tượng vùng chứa cho các thông báo. Nội dung này không được điền trong tài nguyên Subscription. |
|
notification.collection |
string |
Bộ sưu tập đã tạo ra thông báo. | |
notification.itemId |
string |
Mã của mục đã tạo thông báo. | |
notification.operation |
string |
Loại thao tác đã tạo ra thông báo.
Các giá trị được chấp nhận là:
|
|
notification.userActions[] |
list |
Danh sách hành động do người dùng thực hiện đã kích hoạt thông báo. | |
notification.userActions[].payload |
string |
Dung lượng tuỳ chọn cho hành động. Đối với thao tác thuộc loại CUSTOM, đây là mã của mục trong trình đơn tuỳ chỉnh đã được chọn. |
|
notification.userActions[].type |
string |
Loại hành động. Giá trị của việc này có thể là:
|
|
notification.userToken |
string |
Mã thông báo của 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 đăng ký nhận thông báo. | |
operation[] |
list |
Danh sách các thao tác cần đăng ký. Danh sách trống cho biết rằng mọi thao tác trên bộ sưu tập sẽ được đăng ký. Các giá trị được cho phép là:
|
có thể ghi |
updated |
datetime |
Thời điểm sửa đổi gần đây nhất cho gói thuê bao này, theo định dạng của RFC 3339. | |
userToken |
string |
Mã thông báo mờ được gửi đến người đăng ký trong các thông báo để có thể xác định mã nhận dạng của người dùng. | có thể ghi |
verifyToken |
string |
Mã thông báo bí mật được gửi đến người đăng ký trong phần thông báo để họ có thể xác minh rằng thông báo đó là do Google tạo ra. | có thể ghi |