Sponsors: list

ध्यान दें: यह तरीका 31 मार्च, 2020 से काम नहीं करेगा. इसे members.list तरीके से बदल दिया गया है. इस तरीके के बारे में जानकारी आपको YouTube Data API दस्तावेज़ में मिल जाएगी.

sponsors.list वाला तरीका, 30 सितंबर, 2020 या उसके बाद काम नहीं करेगा. एपीआई क्लाइंट को कॉल को sponsors.list वाले तरीके पर अपडेट करना चाहिए, ताकि वे members.list तरीके का इस्तेमाल कर सकें.

यह किसी चैनल के सदस्यों (पहले इन्हें "स्पॉन्सर" के नाम से जाना जाता था) की सूची बनाता है. एपीआई अनुरोध के लिए, चैनल के मालिक से अनुमति मिलनी चाहिए.

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

अनुरोध

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

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

अनुमति

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

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

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
part string
part पैरामीटर से, sponsor रिसॉर्स के ऐसे हिस्से के बारे में पता चलता है जो एपीआई के रिस्पॉन्स में शामिल होंगे. id और snippet को वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
वैकल्पिक पैरामीटर
filter string
filter पैरामीटर से पता चलता है कि किस चैनल को स्पॉन्सर करना है. डिफ़ॉल्ट वैल्यू newest है.

ये वैल्यू स्वीकार की जाती हैं:
  • all – सबसे नए से सबसे पुराने तक, सभी स्पॉन्सर पर वापस आएं.
  • newest – सबसे हाल ही के प्रायोजित करने वालों में से एक पेज दिखाएं. nextPageToken का इस्तेमाल करने पर मिलने वाले अनुरोधों पर, नए सदस्यों को उनके साइन अप करने पर वापस पाया जाता है.
maxResults unsigned integer
maxResults पैरामीटर से यह तय होता है कि ज़्यादा से ज़्यादा कितने आइटम, नतीजे के सेट में दिखाए जाने चाहिए. स्वीकार किए जाने वाले मान 0 से 50 तक हैं, जिसमें ये दोनों भी शामिल हैं. डिफ़ॉल्ट वैल्यू 5 है.
pageToken string
pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई के रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती हैं जिन्हें वापस पाया जा सकता है.

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

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

जवाब

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

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

प्रॉपर्टी

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

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

गड़बड़ियां

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

गड़बड़ी का टाइप गड़बड़ी की जानकारी ब्यौरा
forbidden (403) insufficientPermissions आपके पास चैनल के स्पॉन्सर को देखने के लिए ज़रूरी अनुमतियां नहीं हैं.
invalidValue (400) invalidValueInRequest अनुरोध में एक अमान्य मान है.
invalidValue (400) sponsorshipNotEnabledForChannelId इस चैनल पर स्पॉन्सरशिप चालू नहीं की गई है.

इसे आज़माएं!

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