SuperChatEvents: list

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

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

अनुरोध

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

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

अनुमति देना

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

दायरा
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 इस संसाधन का Etag.
nextPageToken	string यह टोकन, नतीजों के सेट में अगला पेज पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
pageInfo	object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी को शामिल करता है.
pageInfo.totalResults	integer नतीजों के सेट में मौजूद नतीजों की कुल संख्या.
pageInfo.resultsPerPage	integer एपीआई के जवाब में शामिल नतीजों की संख्या.
items[]	list सुपर चैट की उन खरीदारी की सूची जो अनुरोध की शर्तों से मेल खाती हैं.

गड़बड़ियां

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

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

इसे आज़माएं!

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