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

ערך בוליאני שמציין אם רצוי לשלוח את עומס העבודה. אופציונלי.
id

string

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

string

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

string

מזהה ספציפי לגרסה של המשאב במעקב.
token

string

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

string (int64 format)

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

string

סוג מנגנון המסירה שבו נעשה שימוש בערוץ הזה. הערכים החוקיים הם 'web_hook' או 'webhook'.
address

string

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

map (key: string, value: string)

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

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

string

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

Methods

stop

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