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 The 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 के कॉन्टेंट पार्टनर के लिए है. The onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति देने वाले क्रेडेंशियल, YouTube सीएमएस के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में तय किए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो YouTube के कई अलग-अलग चैनलों के मालिक हैं और उन्हें मैनेज करते हैं. इससे, कॉन्टेंट के मालिक एक बार पुष्टि करके, अपने सभी वीडियो और चैनल के डेटा का ऐक्सेस पा सकते हैं. इसके लिए, उन्हें हर चैनल के लिए अनुमति देने वाले क्रेडेंशियल देने की ज़रूरत नहीं होती. जिस CMS खाते से उपयोगकर्ता पुष्टि करता है वह, तय किए गए YouTube कॉन्टेंट के मालिक से लिंक होना चाहिए.
onBehalfOfContentOwnerChannel	string इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwnerChannel पैरामीटर, उस YouTube चैनल का चैनल आईडी तय करता है जिसमें कोई वीडियो जोड़ा जा रहा है. यह पैरामीटर तब ज़रूरी होता है, जब किसी अनुरोध में onBehalfOfContentOwner पैरामीटर के लिए कोई वैल्यू तय की जाती है. इसका इस्तेमाल, सिर्फ़ उस पैरामीटर के साथ किया जा सकता है. इसके अलावा, अनुरोध को अनुमति देने के लिए, CMS के ऐसे खाते का इस्तेमाल करना ज़रूरी है जो उस कॉन्टेंट के मालिक से लिंक हो जिसे onBehalfOfContentOwner पैरामीटर तय करता है. आखिर में, onBehalfOfContentOwnerChannel पैरामीटर की वैल्यू में तय किया गया चैनल, उस कॉन्टेंट के मालिक से लिंक होना चाहिए जिसे onBehalfOfContentOwner पैरामीटर तय करता है. यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो YouTube के कई अलग-अलग चैनलों के मालिक हैं और उन्हें मैनेज करते हैं. इससे, कॉन्टेंट के मालिक एक बार पुष्टि करके, पैरामीटर वैल्यू में तय किए गए चैनल की ओर से कार्रवाइयां कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं होती.
order	string order पैरामीटर, उस तरीके को तय करता है जिसका इस्तेमाल, एपीआई से मिली जानकारी में संसाधनों को क्रम से लगाने के लिए किया जाएगा. डिफ़ॉल्ट वैल्यू SUBSCRIPTION_ORDER_RELEVANCE है. इन वैल्यू का इस्तेमाल किया जा सकता है: alphabetical – नाम के पहले अक्षर के हिसाब से क्रम में लगाएं. relevance – काम के नतीजों के हिसाब से क्रम में लगाएं. unread – गतिविधि के क्रम के हिसाब से क्रम में लगाएं.
pageToken	string The 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 यह इस संसाधन का 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 का इस्तेमाल करें.