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

यूयूआईडी या ऐसी ही कोई यूनीक स्ट्रिंग जो इस चैनल की पहचान करती है.

resourceId

string

ऐसा आईडी जिससे इस चैनल पर देखे जा रहे संसाधन की पहचान की जा सकती है. यह एपीआई के अलग-अलग वर्शन पर काम करता है.

resourceUri

string

देखे गए रिसॉर्स के लिए, वर्शन के हिसाब से आइडेंटिफ़ायर.

token

string

इस चैनल से भेजी गई हर सूचना के साथ, टारगेट पते पर डिलीवर की जाने वाली कोई भी स्ट्रिंग. ज़रूरी नहीं.

expiration

string (int64 format)

सूचना चैनल की समयसीमा खत्म होने की तारीख और समय, जो मिलीसेकंड में यूनिक्स टाइमस्टैंप के तौर पर दिखाया जाता है. ज़रूरी नहीं.

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

इस चैनल से संसाधन देखना बंद कर दिया जाता है.