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
  ]
}

प्रॉपर्टी

यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:

प्रॉपर्टी
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 संसाधन है.

गड़बड़ियां

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

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

इसे आज़माएं!

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