यह लाइव चैट के लिए मॉडरेटर की सूची बनाता है. लाइव चैट में शामिल चैनल के मालिक से, अनुरोध करने की अनुमति मिलनी चाहिए.
इस्तेमाल के सामान्य उदाहरण
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
पैरामीटर
इस टेबल में वे पैरामीटर दिए गए हैं जो इस क्वेरी पर काम करते हैं. सूची में शामिल सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
liveChatId |
string liveChatId पैरामीटर से, YouTube लाइव चैट की वह जानकारी मिलती है जिसके लिए एपीआई को मॉडरेटर वापस करना चाहिए. ब्रॉडकास्ट से जुड़े लाइव चैट आईडी को, liveBroadcast के संसाधन की snippet.liveChatId प्रॉपर्टी में दिखाया जाता है. |
|
part |
string part पैरामीटर से, liveChatModerator रिसॉर्स के ऐसे हिस्से के बारे में पता चलता है जो एपीआई के रिस्पॉन्स में शामिल होंगे. id और snippet को वैल्यू के तौर पर इस्तेमाल किया जा सकता है. |
|
वैकल्पिक पैरामीटर | ||
maxResults |
unsigned integer maxResults पैरामीटर से यह तय होता है कि ज़्यादा से ज़्यादा कितने आइटम, नतीजे के सेट में दिखाए जाने चाहिए. स्वीकार किए जाने वाले मान 0 से 50 तक हैं, जिसमें ये दोनों भी शामिल हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
pageToken |
string pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई के रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती हैं जिन्हें वापस पाया जा सकता है. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर यह तरीका काम करता है, तो यह इस स्ट्रक्चर का इस्तेमाल करके रिस्पॉन्स का मुख्य हिस्सा दिखाता है:
{ "kind": "youtube#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator Resource ] }
प्रॉपर्टी
यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string इससे पता चलता है कि एपीआई रिसॉर्स किस तरह का है. मान youtube#liveChatModeratorListResponse होगा. |
etag |
etag इस संसाधन का ईटैग. |
prevPageToken |
string नतीजे के सेट में पिछले पेज को वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन. |
nextPageToken |
string नतीजे के सेट का अगला पेज वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजे के सेट में मौजूद नतीजों की कुल संख्या. |
pageInfo.resultsPerPage |
integer एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या. |
items[] |
list अनुरोध की शर्तों को पूरा करने वाले मॉडरेटर की सूची. |
गड़बड़ियां
एपीआई सिर्फ़ ऐसे गड़बड़ी के मैसेज के बारे में नहीं बताता जो सिर्फ़ एपीआई के इस तरीके के लिए हो. हालांकि, इस तरीके से अब भी एपीआई से जुड़ी सामान्य गड़बड़ियां मिल सकती हैं. ये गड़बड़ियां, गड़बड़ी के मैसेज दस्तावेज़ में मौजूद होती हैं.
इसे आज़माएं!
इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.