Events: watch

כדאי לשים לב לשינויים במשאבים של 'אירועים'.

בקשה

בקשת HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

פרמטרים

שם הפרמטר ערך תיאור
פרמטרים של נתיב
calendarId string מזהה היומן. כדי לאחזר מזהי יומנים, צריך להפעיל את השיטה calendarList.list. כדי להיכנס ליומן הראשי של המשתמש שמחובר כרגע, אפשר להשתמש באפשרות 'primary' במילת מפתח.
פרמטרים אופציונליים של שאילתה
eventTypes string סוגי אירועים של משאבים לצפייה. זה שינוי אופציונלי. אפשר לחזור על הפרמטר הזה כמה פעמים כדי לצפות במשאבים מסוגים שונים. אם המדיניות לא מוגדרת, כל סוגי האירועים יוחזרו.

הערכים הקבילים הם:
  • "default": אירועים רגילים.
  • 'focusTime': אירועי 'זמן לעצמי'.
  • "fromGmail": אירועים מ-Gmail.
  • "outOfOffice": אירועים לא בעבודה.
  • "workingLocation": אירועים של מיקום עבודה.

אישור

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

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

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

גוף הבקשה

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

{
  "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 שניות.

תשובה

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

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