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

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

address

string

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

params

map (key: string, value: string)

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

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

kind

string

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

שיטות

stop

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