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

วิธีการ

ลบ

ลบการสมัครใช้บริการ

แทรก

สร้างการสมัครใช้บริการใหม่

list

เรียกข้อมูลรายการการสมัครใช้บริการของผู้ใช้และบริการที่ตรวจสอบสิทธิ์แล้ว

อัปเดต

อัปเดตการสมัครใช้บริการที่มีอยู่