Subscriptions: list

एपीआई अनुरोध की शर्तों से मेल खाने वाले सदस्यता संसाधन दिखाता है.

कोटा असर: इस तरीके को कॉल करने पर कोटा लागत एक इकाई हो जाती है.

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

अनुरोध करें

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

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

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
part	string part पैरामीटर में एक या उससे ज़्यादा subscription संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट होती है, जिसमें एपीआई से मिलने वाला जवाब शामिल होगा. अगर पैरामीटर ऐसी प्रॉपर्टी की पहचान करता है जिसमें चाइल्ड प्रॉपर्टी हैं, तो चाइल्ड प्रॉपर्टी, रिस्पॉन्स में शामिल हो जाएंगी. उदाहरण के लिए, subscription संसाधन की snippet प्रॉपर्टी में अन्य प्रॉपर्टी शामिल होती हैं, जैसे कि सदस्यता का डिसप्ले शीर्षक. part=snippet को सेट करने पर, एपीआई रिस्पॉन्स में वे सभी नेस्ट की गई प्रॉपर्टी भी शामिल होंगी. नीचे दी गई सूची में part नाम शामिल हैं, जिन्हें पैरामीटर वैल्यू में शामिल किया जा सकता है: contentDetails id snippet subscriberSnippet
फ़िल्टर (इनमें से किसी एक पैरामीटर के बारे में बताएं)
channelId	string channelId पैरामीटर में YouTube चैनल का आईडी होता है. एपीआई सिर्फ़ उस चैनल की सदस्यताएं दिखाएगा.
id	string id पैरामीटर फिर से हासिल किए जा रहे संसाधनों के लिए YouTube सदस्यता आईडी की कॉमा-सेपरेटेड लिस्ट देता है. subscription के संसाधन में, id प्रॉपर्टी से YouTube सदस्यता आईडी का पता चलता है.
mine	boolean इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. पुष्टि किए गए उपयोगकर्ता की सदस्यता का फ़ीड पाने के लिए, इस पैरामीटर की वैल्यू को true पर सेट करें.
myRecentSubscribers	boolean इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. पुष्टि किए गए उपयोगकर्ता के सदस्यों की फ़ीड को सबसे नए क्रम में फिर से पाने के लिए, इस पैरामीटर की वैल्यू true पर सेट करें. सबसे नए पहले. ध्यान दें कि इस एपीआई से सदस्य बनने की ज़्यादा से ज़्यादा संख्या सीमित हो सकती है.
mySubscribers	boolean इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. पुष्टि किए गए उपयोगकर्ता के सदस्यों की फ़ीड को किसी खास क्रम में पाने के लिए, इस पैरामीटर की वैल्यू true पर सेट करें. ध्यान दें कि इस एपीआई का इस्तेमाल करके, ज़्यादा से ज़्यादा कितने सदस्य हो सकते हैं.
ज़रूरी पैरामीटर
forChannelId	string forChannelId पैरामीटर से, चैनल आईडी की कॉमा-सेपरेटेड लिस्ट का पता चलता है. इसके बाद, एपीआई के रिस्पॉन्स में सिर्फ़ उन चैनलों की सदस्यताएं शामिल होंगी जो इनसे मिलते-जुलते हैं.
maxResults	unsigned integer maxResults पैरामीटर से पता चलता है कि नतीजों की सूची में कितने आइटम दिखाए जाने चाहिए. 0 से 50 तक के मान स्वीकार किए जाते हैं. डिफ़ॉल्ट वैल्यू 5 है.
onBehalfOfContentOwner	string ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुमति के लिए अनुरोध करने वाले, ऐसे कॉन्टेंट मैनेजमेंट सिस्टम के उपयोगकर्ता की पहचान करते हैं जो पैरामीटर की वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जो कई अलग-अलग YouTube चैनलों के मालिक हैं और उन्हें प्रबंधित करते हैं. इसकी मदद से कॉन्टेंट के मालिक एक बार पुष्टि कर सकते हैं. साथ ही, अपने सभी वीडियो और चैनल के डेटा को ऐक्सेस कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल नहीं देने होंगे. जिस कॉन्टेंट मैनेजमेंट सिस्टम खाते से उपयोगकर्ता की पुष्टि होती है उसे YouTube के कॉन्टेंट के मालिक से लिंक होना चाहिए.
onBehalfOfContentOwnerChannel	string इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwnerChannel पैरामीटर से उस चैनल के YouTube चैनल आईडी का पता चलता है जिसमें वीडियो जोड़ा जा रहा है. यह पैरामीटर तब ज़रूरी होता है, जब कोई अनुरोध onBehalfOfContentOwner पैरामीटर के लिए वैल्यू तय करता है. साथ ही, इसका इस्तेमाल सिर्फ़ उसी पैरामीटर के साथ किया जा सकता है. साथ ही, अनुरोध को ऐसे कॉन्टेंट मैनेजमेंट सिस्टम से लिंक किया जाना चाहिए जो कॉन्टेंट के मालिक से जुड़ा हो और onBehalfOfContentOwner पैरामीटर के बारे में बताता हो. आखिर में, onBehalfOfContentOwnerChannel पैरामीटर की वैल्यू के बारे में बताने वाला चैनल, उस कॉन्टेंट के मालिक से जुड़ा होना चाहिए जिसका onBehalfOfContentOwner पैरामीटर तय करता है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास अलग-अलग YouTube चैनलों का मालिकाना हक है और उन्हें मैनेज करने का अधिकार है. इसकी मदद से कॉन्टेंट के मालिक एक बार में पुष्टि कर सकते हैं. साथ ही, पैरामीटर की वैल्यू में बताए गए चैनल की तरफ़ से कार्रवाई कर सकते हैं. इसके लिए, हर अलग चैनल के लिए पुष्टि करने के क्रेडेंशियल देने की ज़रूरत नहीं होती.
order	string order पैरामीटर से पता चलता है कि एपीआई रिस्पॉन्स में संसाधनों को क्रम से लगाने के लिए किस तरीके का इस्तेमाल किया जाएगा. डिफ़ॉल्ट वैल्यू SUBSCRIPTION_ORDER_RELEVANCE है. मान्य वैल्यू ये हैं: alphabetical – अंग्रेज़ी वर्णमाला के क्रम में लगाएं. relevance – प्रासंगिकता के मुताबिक क्रम से लगाएं. unread – गतिविधि के क्रम से लगाएं.
pageToken	string pageToken पैरामीटर, नतीजों के सेट में मौजूद उस खास पेज की पहचान करता है जिसे दिखाना है. एपीआई रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी उन दूसरे पेजों की पहचान करती है जिन्हें वापस लाया जा सकता है.

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

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

जवाब

अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

प्रॉपर्टी

इस टेबल में उन प्रॉपर्टी के बारे में बताया गया है जो इस रिसॉर्स में मौजूद हैं:

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

गड़बड़ियां

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

गड़बड़ी का टाइप	गड़बड़ी की जानकारी	ब्यौरा
forbidden (403)	accountClosed	सदस्य की सदस्यता वापस नहीं ली जा सकी, क्योंकि उसका खाता बंद हो गया है.
forbidden (403)	accountSuspended	सदस्यताओं को फिर से डाउनलोड नहीं किया जा सका, क्योंकि सदस्य का खाता निलंबित कर दिया गया है.
forbidden (403)	subscriptionForbidden	अनुरोध करने वाले को, अनुरोध की गई सदस्यताओं को ऐक्सेस करने की अनुमति नहीं है.
notFound (404)	subscriberNotFound	अनुरोध करने वाले सदस्य की जानकारी नहीं मिली.

इसे आज़माएं!

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