Settings: watch

หมายเหตุ: ต้องมีการให้สิทธิ์

คอยดูการเปลี่ยนแปลงในทรัพยากรการตั้งค่า

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/calendar/v3/users/me/settings/watch

พารามิเตอร์

ชื่อพารามิเตอร์	ค่า	คำอธิบาย

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

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

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

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

เนื้อความของคำขอ

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

{
  "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 ในหน่วยมิลลิวินาที ไม่บังคับ