REST Resource: channels

משאב: ערוץ

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

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

map (key: string, value: string)

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

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

boolean

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

string

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

string

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

string

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

string

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

string (int64 format)

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

string

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

string

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

string

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

Methods

stop

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