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

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

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

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

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