REST Resource: channels

משאב: ערוץ

ערוץ התראות שמשמש למעקב אחרי שינויים במשאבים.

ייצוג JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
שדות
payload

boolean

ערך בוליאני שמציין אם יש צורך במטען ייעודי (payload). אופציונלי.

id

string

UUID או מחרוזת ייחודית דומה שמזהה את הערוץ הזה.

resourceId

string

מזהה אטום שמזהה את המשאב הנצפה בערוץ הזה. יציב בגרסאות שונות של ה-API.

resourceUri

string

מזהה ספציפי לגרסה של המשאב שנצפה.

token

string

מחרוזת שרירותית שנשלחת לכתובת היעד עם כל התראה שמועברת בערוץ הזה. אופציונלי.

expiration

string (int64 format)

התאריך והשעה של תפוגת ערוץ ההתראות, שמתבטאים בחותמת זמן של Unix, באלפיות השנייה. אופציונלי.

type

string

סוג מנגנון המסירה של הערוץ.

address

string

הכתובת שאליה יישלחו ההתראות של הערוץ הזה.

params

map (key: string, value: string)

פרמטרים נוספים ששולטים בהתנהגות של ערוצי המסירה. אופציונלי.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }

kind

string

מזהה את הערוץ הזה כערוץ התראות המשמש לצפייה בשינויים במשאב, שהוא api#channel.

שיטות

stop

הפסקת הצפייה במשאבים דרך הערוץ הזה.