חשוב לשים לב לשינויים במשאבי האירועים.
בקשה
בקשת HTTP
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
פרמטרים
שם הפרמטר | ערך | תיאור |
---|---|---|
פרמטרים של נתיב | ||
calendarId |
string |
מזהה היומן. כדי לאחזר מזהי יומנים צריך לקרוא לשיטה calendarList.list. כדי לגשת ליומן הראשי של המשתמש שמחובר כרגע, יש להשתמש במילת המפתח "primary ".
|
פרמטרים אופציונליים של שאילתות | ||
eventTypes |
string |
סוגי אירועים לצפייה. זה שינוי אופציונלי. אפשר לחזור על הפרמטר הזה כמה פעמים כדי לצפות במשאבים מסוגים שונים. אם היא לא מוגדרת, היא מחזירה את כל סוגי האירועים.
הערכים הקבילים הם:
|
אישור
הבקשה הזו מאפשרת הרשאה עם לפחות אחד מההיקפים הבאים:
היקף |
---|
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, באלפיות השנייה. זה שינוי אופציונלי. |