Events: watch

คอยดูการเปลี่ยนแปลงในทรัพยากรของกิจกรรม

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

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

ค่าที่ยอมรับมีดังนี้
  • "birthday": กิจกรรมพิเศษตลอดทั้งวันที่เกิดซ้ำทุกปี
  • "default": กิจกรรมทั่วไป
  • "focusTime": กิจกรรมที่ต้องการสมาธิ
  • "fromGmail": กิจกรรมจาก Gmail
  • "outOfOffice": กิจกรรมลางาน
  • "workingLocation": เหตุการณ์สถานที่ทํางาน

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

คำขอนี้อนุญาตการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 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
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

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

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

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

{
  "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 ระยะเวลาในการเก็บรักษาเป็นวินาทีสําหรับช่องทางการแจ้งเตือน ค่าเริ่มต้นคือ 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 ในหน่วยมิลลิวินาที ไม่บังคับ