CalendarList: watch

לעקוב אחרי שינויים במשאבי CalendarList.

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר ערך תיאור

אישור

הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים:

היקף
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

מידע נוסף זמין בדף אימות והרשאה.

גוף הבקשה

בגוף הבקשה, מספקים נתונים במבנה הבא:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
שם הנכס ערך תיאור הערות
id string מזהה UUID או מחרוזת ייחודית דומה שמזהה את הערוץ הזה.
token string מחרוזת שרירותית שנשלחת לכתובת היעד עם כל התראה שנשלחת דרך הערוץ הזה. זה שינוי אופציונלי.
type string סוג מנגנון המסירה שבו נעשה שימוש בערוץ הזה. הערכים החוקיים הם web_hook (או webhook). שני הערכים מתייחסים לערוץ שבו נעשה שימוש בבקשות Http כדי להעביר הודעות.
address string הכתובת שאליה יישלחו ההתראות מהערוץ הזה.
params object פרמטרים נוספים ששולטים בהתנהגות של ערוץ העברת הנתונים. זה שינוי אופציונלי.
params.ttl string משך החיים בשניות של ערוץ ההתראות. ברירת המחדל היא 604,800 שניות.

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר גוף תגובה עם המבנה הבא:

{
  "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, באלפיות שנייה. זה שינוי אופציונלי.