LiveChatMessages: list

यह चुनिंदा चैट के लाइव चैट मैसेज की सूची बनाता है.

जब आप पहली बार चैट मैसेज वापस पाने का अनुरोध करते हैं, तो एपीआई चैट के इतिहास का कुछ या पूरा हिस्सा दिखाता है. यह इस बात पर निर्भर करता है कि इतिहास कितना लंबा है. जवाब में मौजूद मैसेज, सबसे पुराने से सबसे नए के क्रम में दिए जाते हैं.

• रिस्पॉन्स में मौजूद nextPageToken से एक टोकन मिलता है. यह टोकन आपके अगले अनुरोध में मिलता है. यह टोकन, नतीजों के उस अगले सेट की पहचान करता है जिसे आपके एपीआई क्लाइंट को फिर से हासिल करना चाहिए.
• pollingIntervalMillis प्रॉपर्टी से पता चलता है कि अन्य नतीजों के लिए अनुरोध करने से पहले, आपके एपीआई क्लाइंट को कितना इंतज़ार करना चाहिए.

अन्य नतीजों का अनुरोध करने पर, pageToken पैरामीटर को nextPageToken वैल्यू पर सेट किया जाता है. साथ ही, उपलब्ध होने पर एपीआई सर्वर, अतिरिक्त चैट मैसेज दिखाता है. फिर से, उस नतीजे के सेट में, मैसेज सबसे पुराने से सबसे नए के क्रम में लगाए जाते हैं.

इस्तेमाल के सामान्य उदाहरण

अनुरोध

एचटीटीपी अनुरोध

GET https://www.googleapis.com/youtube/v3/liveChat/messages

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
liveChatId	string liveChatId पैरामीटर उस चैट का आईडी बताता है जिसके मैसेज दिखाए जाएंगे. किसी ब्रॉडकास्ट से जुड़ा लाइव चैट आईडी, liveBroadcast संसाधन की snippet.liveChatId प्रॉपर्टी में दिखाया जाता है.
part	string part पैरामीटर में, liveChatMessage संसाधन के ऐसे हिस्से तय किए जाते हैं जो एपीआई के रिस्पॉन्स में शामिल होते हैं. id, snippet, और authorDetails को वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
वैकल्पिक पैरामीटर
hl	string hl पैरामीटर, एपीआई को यह निर्देश देता है कि वह YouTube की वेबसाइट पर काम करने वाली ऐप्लिकेशन भाषा के लिए, स्थानीय मुद्रा में दिखाई गई स्ट्रिंग को फिर से हासिल करे. उदाहरण के लिए, अंग्रेज़ी में, मुद्रा $1.50 के तौर पर दिखेगी. वहीं, फ़्रेंच में 1,50$ के तौर पर दिखेगी. पैरामीटर की वैल्यू, i18nLanguages.list तरीके से दिखाई गई सूची में शामिल भाषा कोड होना चाहिए.
maxResults	unsigned integer maxResults पैरामीटर से पता चलता है कि नतीजे के सेट में ज़्यादा से ज़्यादा कितने मैसेज दिखाए जाने चाहिए. स्वीकार की जाने वाली वैल्यू 200 से 2000 तक हैं. इसमें ये वैल्यू भी शामिल हैं. डिफ़ॉल्ट वैल्यू 500 है.
pageToken	string pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई से मिले रिस्पॉन्स में, nextPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती है जिन्हें वापस लाया जा सकता है.
profileImageSize	unsigned integer profileImageSize पैरामीटर, उपयोगकर्ता की प्रोफ़ाइल फ़ोटो का साइज़ बताता है जो नतीजे के सेट में दिखना चाहिए. इमेज स्क्वेयर हैं. इसकी डिफ़ॉल्ट वैल्यू 88 है. इसका मतलब है कि इमेज का साइज़ 88 पिक्सल x 88 पिक्सल होना चाहिए. स्वीकार की जाने वाली वैल्यू, 16 से 720 की रेंज में होती हैं. इसमें ये वैल्यू भी शामिल हैं.

अनुरोध का मुख्य भाग

इस तरीके का इस्तेमाल करते समय अनुरोध का मुख्य हिस्सा न भेजें.

जवाब

सही तरीके से काम करने पर, यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स का मुख्य हिस्सा दिखाता है:

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage Resource
}

प्रॉपर्टी

नीचे दी गई टेबल में, इस संसाधन में मौजूद प्रॉपर्टी के बारे में बताया गया है:

प्रॉपर्टी
kind	string यह एपीआई संसाधन के टाइप की पहचान करता है. वैल्यू youtube#liveChatMessageListResponse होगी.
etag	etag इस संसाधन का इटैग.
nextPageToken	string वह टोकन जिसका इस्तेमाल pageToken पैरामीटर की वैल्यू के तौर पर किया जा सकता है, ताकि नतीजे के सेट का अगला पेज फिर से पाया जा सके.
pollingIntervalMillis	unsigned integer लाइव चैट के नए मैसेज पाने के लिए, क्लाइंट को फिर से पोल करने से पहले मिलीसेकंड में इंतज़ार करना चाहिए.
offlineAt	datetime वह तारीख और समय जब लाइव स्ट्रीम ऑफ़लाइन हो गई. यह प्रॉपर्टी सिर्फ़ तब दिखती है, जब स्ट्रीम पहले से ही ऑफ़लाइन हो. यह वैल्यू ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) फ़ॉर्मैट में दी गई है.
pageInfo	object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी को इनकैप्सुलेट करता है.
pageInfo.totalResults	integer नतीजे के सेट में नतीजों की कुल संख्या.
pageInfo.resultsPerPage	integer एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या.
items[]	list मैसेज की सूची. सूची का हर आइटम, liveChatMessage संसाधन है.
activePollItem	object मैसेज में मौजूद पोल का डेटा. हर पोल, pollEvent टाइप का एक liveChatMessage संसाधन होता है. इससे मौजूदा पोल के बारे में पता चलता है. हर चैट में सिर्फ़ एक पोल हो सकता है.

गड़बड़ियां

नीचे दी गई टेबल में उन गड़बड़ी के मैसेज की पहचान की गई है जिन्हें एपीआई इस तरीके का इस्तेमाल करने पर जवाब में लौटा सकता है. ज़्यादा जानकारी के लिए गड़बड़ी का मैसेज दस्तावेज़ देखें.

गड़बड़ी का टाइप	गड़बड़ी विवरण	ब्यौरा
forbidden (403)	forbidden	आपके पास उस लाइव चैट के मैसेज वापस पाने की ज़रूरी अनुमतियां नहीं हैं जिसमें वह चैट की गई है.
forbidden (403)	liveChatDisabled	चुने गए ब्रॉडकास्ट के लिए लाइव चैट की सुविधा चालू नहीं है.
forbidden (403)	liveChatEnded	बताई गई लाइव चैट अब लाइव नहीं है.
notFound (404)	liveChatNotFound	आपको जिस लाइव चैट को वापस लाना है वह नहीं मिली. अनुरोध के liveChatId पैरामीटर की वैल्यू की जांच करके, पक्का करें कि वह सही है.
rateLimitExceeded	rateLimitExceeded	पिछले अनुरोध के बाद, अनुरोध बहुत जल्दी भेजा गया. यह गड़बड़ी तब होती है, जब मैसेज वापस पाने के लिए एपीआई के अनुरोध, YouTube की रीफ़्रेश दरों की तुलना में ज़्यादा बार भेजे जाते हैं. इससे बैंडविथ बेवजह खर्च होता है.

इसे आज़माएं!

इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई का अनुरोध और रिस्पॉन्स देखें.