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 चैनलों का मालिकाना हक होता है और उन्हें मैनेज करने का अधिकार होता है. इससे कॉन्टेंट के मालिकों को एक बार पुष्टि करने के साथ-साथ, अपने वीडियो और चैनल के पूरे डेटा का ऐक्सेस मिल जाता है. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं पड़ती. उपयोगकर्ता जिस कॉन्टेंट मैनेजमेंट सिस्टम से पुष्टि करता है वह खाता, 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 का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.