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 |
URL สำหรับส่งการแจ้งเตือน (ต้องขึ้นต้นด้วย https:// ) |
เขียนได้ |
collection |
string |
คอลเล็กชันที่จะติดตาม ค่าที่ใช้ได้คือ
|
เขียนได้ |
id |
string |
รหัสของการสมัครใช้บริการ | |
kind |
string |
ประเภทของทรัพยากร นี่คือ mirror#subscription เสมอ |
|
notification |
nested object |
ออบเจ็กต์คอนเทนเนอร์สำหรับการแจ้งเตือน ข้อมูลดังกล่าวไม่ได้สร้างขึ้นในทรัพยากร Subscription |
|
notification.collection |
string |
คอลเล็กชันที่สร้างการแจ้งเตือน | |
notification.itemId |
string |
รหัสของรายการที่สร้างการแจ้งเตือน | |
notification.operation |
string |
ประเภทของการดำเนินการที่สร้างการแจ้งเตือน
ค่าที่ยอมรับได้ มีดังนี้
|
|
notification.userActions[] |
list |
รายการการดำเนินการของผู้ใช้ที่ทำให้มีการแจ้งเตือน | |
notification.userActions[].payload |
string |
เพย์โหลดที่ไม่บังคับสำหรับการดำเนินการ สำหรับการดำเนินการประเภท CUSTOM นี่คือรหัสของรายการในเมนูที่กำหนดเองซึ่งเลือกไว้ |
|
notification.userActions[].type |
string |
ประเภทการทำงาน ค่าของเกณฑ์นี้อาจเป็น:
|
|
notification.userToken |
string |
โทเค็นผู้ใช้ที่บริการระบุเมื่อสมัครรับการแจ้งเตือน | |
notification.verifyToken |
string |
โทเค็นการยืนยันข้อมูลลับที่บริการมอบให้เมื่อสมัครใช้บริการการแจ้งเตือน | |
operation[] |
list |
รายการการดำเนินการที่ควรสมัครใช้บริการ รายการที่ว่างเปล่าระบุว่าการดำเนินการทั้งหมดในคอลเล็กชันควรมีการสมัคร ค่าที่ใช้ได้คือ
|
เขียนได้ |
updated |
datetime |
เวลาที่แก้ไขการสมัครใช้บริการนี้ครั้งล่าสุด ซึ่งอยู่ในรูปแบบตาม RFC 3339 | |
userToken |
string |
โทเค็นทึบที่ส่งไปยังสมาชิกในการแจ้งเตือนเพื่อให้ระบุรหัสของผู้ใช้ได้ | เขียนได้ |
verifyToken |
string |
โทเค็นลับที่ส่งไปยังสมาชิกในการแจ้งเตือน เพื่อให้ยืนยันว่าการแจ้งเตือนนั้นสร้างโดย Google | เขียนได้ |