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