फ़ैन फ़ंडिंग की सुविधा को बंद कर दिया गया है. साथ ही, फ़ैन फ़ंडिंग एपीआई 28 फ़रवरी, 2017 को बंद कर दिया जाएगा. इस सुविधा के बंद होने का एलान, YouTube की नई सुपर चैट की सुविधा के रिलीज़ होने के साथ मेल खाता है.
चैनल के लिए फ़ैन फ़ंडिंग इवेंट की सूची बनाता है. एपीआई अनुरोध को चैनल के मालिक से अनुमति लेनी होगी.
अनुरोध करें
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/fanFundingEvents
अनुमति दें
इस अनुरोध के लिए, इनमें से कम से कम एक दायरे की अनुमति लेना ज़रूरी है. पुष्टि करने और अनुमति देने के बारे में ज़्यादा जानें.
दायरा |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
पैरामीटर
इस टेबल में ऐसे पैरामीटर दिए गए हैं जो क्वेरी के साथ काम करते हैं. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर में fanFundingEvent संसाधन वाले उन हिस्सों के बारे में बताया गया है जो एपीआई रिस्पॉन्स में शामिल होंगे. id और snippet को वैल्यू के तौर पर इस्तेमाल किया जा सकता है. |
|
ज़रूरी पैरामीटर | ||
hl |
string hl पैरामीटर, एपीआई को स्थानीय भाषा में दिखाए गए खास डिसप्ले की स्ट्रिंग को वापस पाने का निर्देश देता है. इसमें ऐप्लिकेशन की भाषा, YouTube की वेबसाइट के साथ काम करती है. उदाहरण के लिए, अंग्रेज़ी में मुद्रा $1.50 के तौर पर दिखेगी, लेकिन फ़्रेंच में इसे 1,50$ के तौर पर दिखाया जाएगा.पैरामीटर वैल्यू, i18nLanguages.list कोड से मिली सूची में शामिल भाषा कोड से होनी चाहिए. |
|
maxResults |
unsigned integer maxResults पैरामीटर से पता चलता है कि नतीजों की सूची में कितने आइटम दिखाए जाने चाहिए. 0 से 50 तक के मान स्वीकार किए जाते हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
pageToken |
string pageToken पैरामीटर, नतीजों के सेट में उस खास पेज की पहचान करता है जिसे दिखाने के लिए एपीआई सर्वर से कहा जा रहा है. एपीआई के जवाब में nextPageToken प्रॉपर्टी, अनुरोध के नतीजों के अगले पेज की पहचान करती है. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:
{ "kind": "youtube#fanFundingEventListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ fanFundingEvent resource ] }
प्रॉपर्टी
इस टेबल में उन प्रॉपर्टी के बारे में बताया गया है जो इस रिसॉर्स में मौजूद हैं:
प्रॉपर्टी | |
---|---|
kind |
string इससे यह पता चलता है कि एपीआई संसाधन किस तरह का है. वैल्यू youtube#fanFundingEventListResponse होगी. |
etag |
etag इस संसाधन का ऐट. |
nextPageToken |
string यह टोकन, pageToken सेट की वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इससे नतीजों के सेट में, अगला पेज फिर से मिल जाता है. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजों के सेट में कुल नतीजे. |
pageInfo.resultsPerPage |
integer एपीआई रिस्पॉन्स में शामिल किए गए नतीजों की संख्या. |
items[] |
list फ़ैन फ़ंडिंग से जुड़े उन इवेंट की सूची जो अनुरोध की शर्तों को पूरा करते हैं. |
गड़बड़ियां
इस टेबल में उन गड़बड़ी के मैसेज के बारे में बताया गया है जो इस तरीके से कॉल करने पर एपीआई मिल सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी का मैसेज दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
---|---|---|
forbidden (403) |
insufficientPermissions |
आपके पास चैनल के फ़ैन फ़ंडिंग इवेंट देखने के लिए ज़रूरी अनुमतियां नहीं हैं. |
invalidValue (400) |
fanFundingNotEnabledForChannelId |
इस चैनल पर फ़ैन फ़ंडिंग की सुविधा चालू नहीं है. |
इसे आज़माएं!
इस तरीके को लाइव डेटा पर कॉल करने के लिए, एपीआई एक्सप्लोरर का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और उसका जवाब देखें.