Events: watch

รับชมการเปลี่ยนแปลงทรัพยากรกิจกรรม

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
calendarId string ตัวระบุปฏิทิน หากต้องการเรียกรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ ให้ใช้คีย์เวิร์ด "primary"
พารามิเตอร์การค้นหาที่ไม่บังคับ
eventTypes string ระบบจะไม่สนใจประเภทเหตุการณ์สําหรับวิธีการรับชม

การให้สิทธิ์

คําขอนี้อนุญาตการให้สิทธิ์ที่มีขอบเขตดังต่อไปนี้อย่างน้อย 1 ขอบเขต

ขอบเขต
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events

สําหรับข้อมูลเพิ่มเติม โปรดดูหน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อหาของคำขอ

ในเนื้อหาคําขอ ให้ระบุข้อมูลที่มีโครงสร้างต่อไปนี้

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
id string UUID หรือสตริงที่ไม่ซ้ํากันซึ่งระบุถึงช่องนี้
token string สตริงที่กําหนดเองซึ่งส่งไปที่ที่อยู่เป้าหมาย โดยมีการแจ้งเตือนแต่ละรายการที่ส่งผ่านแชแนลนี้ ไม่บังคับ
type string ประเภทของกลไกการนําส่งที่ใช้สําหรับช่องนี้ ค่าที่ถูกต้องคือ "web_hook" (หรือ "webhook") ทั้ง 2 ค่าหมายถึงแชแนลที่ใช้คําขอ HTTP เพื่อส่งข้อความ
address string ที่อยู่สําหรับส่งการแจ้งเตือนสําหรับช่องนี้
params object พารามิเตอร์เพิ่มเติมที่ควบคุมลักษณะการทํางานของช่องทางการแสดงโฆษณา ไม่บังคับ
params.ttl string Time to Live เป็นวินาทีสําหรับช่องทางการแจ้งเตือน ค่าเริ่มต้นคือ 604800 วินาที

คำตอบ

หากสําเร็จ วิธีนี้จะแสดงผลเนื้อหาการตอบกลับที่มีโครงสร้างต่อไปนี้

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
kind string ระบุรายการนี้เป็นช่องทางการแจ้งเตือนที่ใช้เพื่อดูการเปลี่ยนแปลงทรัพยากร ซึ่งก็คือ "api#channel"
id string UUID หรือสตริงที่ไม่ซ้ํากันซึ่งระบุถึงช่องนี้
resourceId string รหัสทึบที่ระบุทรัพยากรที่กําลังรับชมในช่องนี้ มีความเสถียรใน API เวอร์ชันต่างๆ
resourceUri string ตัวระบุเฉพาะเวอร์ชันสําหรับทรัพยากรที่ดู
token string สตริงที่กําหนดเองซึ่งส่งไปที่ที่อยู่เป้าหมาย โดยมีการแจ้งเตือนแต่ละรายการที่ส่งผ่านแชแนลนี้ ไม่บังคับ
expiration long วันที่และเวลาที่การแจ้งเตือนช่องทางหมดอายุ แสดงเป็นการประทับเวลา Unix ในหน่วยมิลลิวินาที ไม่บังคับ