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

رقم تعريف مبهم يحدد المورد الذي تتم مشاهدته على هذه القناة. ثابت عبر إصدارات مختلفة من واجهة برمجة التطبيقات.

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

تتوقف عن مشاهدة الموارد من خلال هذه القناة.