LiveChatMessages: list

यह एपीआई, किसी चैट के लिए लाइव चैट मैसेज की सूची दिखाता है.

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

कोटा पर असर: इस तरीके को कॉल करने पर, 5 यूनिट का कोटा खर्च होता है.

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

अनुरोध

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

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 है.

कंटिन्यूएशन टोकन के बिना किए गए शुरुआती अनुरोध में, सिर्फ़ सबसे नए मैसेज शामिल होंगे. अगर यह वैल्यू दी गई है, तो यह maxResults से कम हो सकती है.

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

गड़बड़ियां

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

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

इसे आज़माएं!

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