SuperChatEvents: list

चैनल की लाइव स्ट्रीम के, पिछले 30 दिनों में सुपर चैट के इवेंट की सूची बनाएं.

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

अनुरोध

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

GET https://www.googleapis.com/youtube/v3/superChatEvents

अनुमति

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति देना ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा पढ़ें).

स्कोप
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
part	string part पैरामीटर से, superChatEvent रिसॉर्स के ऐसे हिस्से के बारे में पता चलता है जो एपीआई के रिस्पॉन्स में शामिल होंगे. id और snippet को वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
वैकल्पिक पैरामीटर
hl	string hl पैरामीटर, एपीआई सर्वर को snippet.displayString प्रॉपर्टी की वैल्यू को फ़ॉर्मैट करने का निर्देश देता है. इस वैल्यू से, किसी खास भाषा के लिए सुपर चैट की खरीदारी की रकम और मुद्रा की जानकारी मिलती है. पैरामीटर की वैल्यू, भाषा का कोड होना चाहिए. यह कोड, i18nLanguages.list तरीके से दिखाई गई सूची में शामिल होना चाहिए. डिफ़ॉल्ट वैल्यू en है. इसका मतलब है कि डिफ़ॉल्ट तौर पर, डिसप्ले स्ट्रिंग को उसी फ़ॉर्मैट में फ़ॉर्मैट किया जाता है जिस तरह वे अंग्रेज़ी में इस्तेमाल की जाएंगी. उदाहरण के लिए, डिफ़ॉल्ट रूप से स्ट्रिंग को $1,00 के बजाय $1.00 के तौर पर फ़ॉर्मैट किया जाता है.
maxResults	unsigned integer maxResults पैरामीटर से यह तय होता है कि ज़्यादा से ज़्यादा कितने आइटम, नतीजे के सेट में दिखाए जाने चाहिए. स्वीकार किए जाने वाले मान 1 से 50 तक हैं, जिसमें ये दोनों भी शामिल हैं. डिफ़ॉल्ट वैल्यू 5 है.
pageToken	string pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई के रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती हैं जिन्हें वापस पाया जा सकता है.

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

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

जवाब

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

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

प्रॉपर्टी

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

प्रॉपर्टी
kind	string इससे पता चलता है कि एपीआई रिसॉर्स किस तरह का है. मान youtube#superChatEventListResponse होगा.
etag	etag इस संसाधन का ईटैग.
nextPageToken	string नतीजे के सेट का अगला पेज वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन.
pageInfo	object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी इकट्ठा करता है.
pageInfo.totalResults	integer नतीजे के सेट में मौजूद नतीजों की कुल संख्या.
pageInfo.resultsPerPage	integer एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या.
items[]	list अनुरोध की शर्तों के हिसाब से, सुपर चैट की खरीदारी की सूची.

गड़बड़ियां

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

गड़बड़ी का टाइप	गड़बड़ी की जानकारी	ब्यौरा
forbidden (403)	insufficientPermissions	अनुरोध को सुपर चैट इवेंट को फिर से पाने की अनुमति सही नहीं है.

इसे आज़माएं!

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