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

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