CalendarList: watch

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

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר Value התיאור

הרשאות

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

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

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

גוף הבקשה

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

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

תשובה

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

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
שם הנכס Value התיאור הערות
kind string המזהה הזה מופיע כערוץ התראות שמשמש למעקב אחר שינויים במשאב, שהוא 'api#channel'.
id string מזהה ייחודי אוניברסלי (UUID) או מחרוזת ייחודית דומה לזיהוי הערוץ הזה.
resourceId string מזהה אטום שמזהה את המשאב שצופים בו בערוץ הזה. יציבות בגרסאות שונות של API.
resourceUri string מזהה ספציפי לגרסה של המשאב שנצפה.
token string מחרוזת אקראית שנמסרת לכתובת היעד עם כל התראה שמועברת בערוץ הזה. אפשרות.
expiration long התאריך והשעה של תפוגת ערוץ ההתראות, מבוטאים כחותמת זמן של Unix, באלפיות השנייה. אפשרות.