Settings: watch

הערה: נדרשת הרשאה.

מעקב אחרי שינויים במשאבי ההגדרות.

בקשה

בקשת HTTP

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

פרמטרים

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

אישור

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

היקף
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"). שני הערכים מתייחסים לערוץ שבו בקשות 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, באלפיות השנייה. אופציונלי.