คอยดูการเปลี่ยนแปลงของทรัพยากรเหตุการณ์
ส่งคำขอ
คำขอ 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 } }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | Notes |
---|---|---|---|
id |
string |
UUID หรือสตริงที่ไม่ซ้ำกันที่คล้ายกันซึ่งระบุแชแนลนี้ | |
token |
string |
สตริงที่กำหนดเองที่ส่งไปยังที่อยู่เป้าหมายพร้อมการแจ้งเตือนแต่ละรายการที่ส่งผ่านแชแนลนี้ ไม่บังคับ | |
type |
string |
ประเภทของกลไกการนำส่งที่ใช้สำหรับช่องทางนี้ ค่าที่ถูกต้องคือ "web_hook " (หรือ "webhook ") ทั้ง 2 ค่าหมายถึงแชแนลที่ใช้คำขอ HTTP เพื่อส่งข้อความ |
|
address |
string |
ที่อยู่ที่ส่งการแจ้งเตือนสำหรับช่องนี้ | |
params |
object |
พารามิเตอร์เพิ่มเติมที่ควบคุมลักษณะการทำงานของช่องทางการแสดงโฆษณา ไม่บังคับ | |
params.ttl |
string |
Time to Live เป็นวินาทีสำหรับช่องทางการแจ้งเตือน ค่าเริ่มต้นคือ 604,800 วินาที |
คำตอบ
หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบสนองที่มีโครงสร้างต่อไปนี้
{ "kind": "api#channel", "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": long }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | Notes |
---|---|---|---|
kind |
string |
ระบุว่าช่องทางนี้เป็นช่องทางการแจ้งเตือนที่ใช้ในการดูการเปลี่ยนแปลงของแหล่งข้อมูล ซึ่งก็คือ "api#channel " |
|
id |
string |
UUID หรือสตริงที่ไม่ซ้ำกันที่คล้ายกันซึ่งระบุแชแนลนี้ | |
resourceId |
string |
รหัสทึบที่ระบุแหล่งข้อมูลที่มีการรับชมในช่องนี้ เสถียรใน API เวอร์ชันต่างๆ | |
resourceUri |
string |
ตัวระบุเฉพาะเวอร์ชันสำหรับทรัพยากรที่ดู | |
token |
string |
สตริงที่กำหนดเองที่ส่งไปยังที่อยู่เป้าหมายพร้อมการแจ้งเตือนแต่ละรายการที่ส่งผ่านแชแนลนี้ ไม่บังคับ | |
expiration |
long |
วันที่และเวลาหมดอายุของช่องทางการแจ้งเตือน ซึ่งแสดงเป็นการประทับเวลา Unix ในหน่วยมิลลิวินาที ไม่บังคับ |