SubscriptionChannel

یک کانال اعلان که برای مشاهده تغییرات منابع استفاده می شود.

نمایندگی JSON
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
زمینه های
id

string

یک UUID یا یک رشته منحصر به فرد مشابه که این کانال را شناسایی می کند.

token

string

یک رشته دلخواه با هر اعلان از طریق این کانال به آدرس مورد نظر تحویل داده می شود. اختیاری.

expiration

string ( int64 format)

تاریخ و زمان انقضای کانال اعلان، به صورت مهر زمانی یونیکس، در میلی ثانیه بیان می شود. اختیاری.

type

string

نوع مکانیزم تحویل مورد استفاده برای این کانال.

address

string

آدرسی که اعلان‌های این کانال در آن ارسال می‌شود.

payload

boolean

یک مقدار Boolean برای نشان دادن اینکه آیا محموله مورد نظر است یا خیر. اختیاری.

params

map (key: string, value: string)

پارامترهای اضافی کنترل کننده رفتار کانال تحویل اختیاری. به عنوان مثال، params.ttl مدت زمان زندگی را بر حسب ثانیه برای کانال اعلان مشخص می کند، که در آن پیش فرض 2 ساعت و حداکثر TTL 2 روز است.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

resourceId

string

یک شناسه غیر شفاف که منبع در حال تماشا را در این کانال مشخص می کند. در نسخه های مختلف API پایدار است.

resourceUri

string

یک شناسه مخصوص نسخه برای منبع تماشا شده.

kind

string

این را به عنوان یک کانال اعلان شناسایی می کند که برای مشاهده تغییرات در یک منبع، که api#channel است، استفاده می شود.