Videos: list

यह विकल्प, एपीआई अनुरोध के पैरामीटर से मेल खाने वाले वीडियो की सूची दिखाता है.

कोटा पर असर: इस तरीके का इस्तेमाल करने पर एक यूनिट की कोटे की कीमत लागू होती है.

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

अनुरोध

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

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

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
part string
part पैरामीटर, एक या एक से ज़्यादा video संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. इस सूची में एपीआई के रिस्पॉन्स शामिल होंगे.

अगर पैरामीटर किसी ऐसी प्रॉपर्टी की पहचान करता है जिसमें चाइल्ड प्रॉपर्टी शामिल हैं, तो जवाब में चाइल्ड प्रॉपर्टी शामिल हो जाएंगी. उदाहरण के लिए, video संसाधन में, snippet प्रॉपर्टी में channelId, title, description, tags, और categoryId प्रॉपर्टी शामिल हैं. इसलिए, अगर part=snippet को सेट किया जाता है, तो एपीआई से मिले रिस्पॉन्स में वे सभी प्रॉपर्टी शामिल होंगी.

यहां दी गई सूची में part नाम हैं, जिन्हें पैरामीटर की वैल्यू में शामिल किया जा सकता है:
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
फ़िल्टर (इनमें से कोई एक पैरामीटर बताएं)
chart string
chart पैरामीटर उस चार्ट की पहचान करता है जिसे आपको फिर से पाना है.

ये वैल्यू स्वीकार की जाती हैं:
id string
id पैरामीटर, रिकवर किए जा रहे संसाधनों के YouTube वीडियो आईडी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. video संसाधन में, id प्रॉपर्टी वीडियो के आईडी के बारे में बताती है.
myRating string
इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर की वैल्यू को like या dislike पर सेट करें, ताकि एपीआई सिर्फ़ वही वीडियो दिखाए जो पुष्टि किए गए उपयोगकर्ता के पसंद या नापसंद किए गए हैं.

ये वैल्यू स्वीकार की जाती हैं:
  • dislike – सिर्फ़ वे वीडियो दिखाता है जिन्हें पुष्टि किए गए उपयोगकर्ता ने नापसंद किया है.
  • like – इससे सिर्फ़ वह वीडियो दिखता है जिसे पुष्टि किए गए उपयोगकर्ता ने पसंद किया है.
वैकल्पिक पैरामीटर
hl string
hl पैरामीटर, एपीआई को यह निर्देश देता है कि वह YouTube की वेबसाइट पर काम करने वाली किसी खास ऐप्लिकेशन भाषा के लिए, स्थानीय भाषा में उपलब्ध संसाधन मेटाडेटा को वापस ला सके. पैरामीटर की वैल्यू, एक भाषा कोड होना चाहिए. यह कोड, i18nLanguages.list तरीके से दी गई सूची में शामिल होता है.

अगर स्थानीय भाषा में संसाधन की जानकारी उस भाषा में उपलब्ध है, तो संसाधन के snippet.localized ऑब्जेक्ट में स्थानीय भाषा के हिसाब से वैल्यू शामिल होंगी. हालांकि, अगर स्थानीय भाषा के हिसाब से जानकारी उपलब्ध नहीं है, तो snippet.localized ऑब्जेक्ट में संसाधन की डिफ़ॉल्ट भाषा में संसाधन की जानकारी होगी.
maxHeight unsigned integer
maxHeight पैरामीटर, player.embedHtml प्रॉपर्टी में एम्बेड किए गए प्लेयर की ज़्यादा से ज़्यादा ऊंचाई की जानकारी देता है. इस पैरामीटर का इस्तेमाल करके यह तय किया जा सकता है कि डिफ़ॉल्ट डाइमेंशन के बजाय, एम्बेड कोड को आपके ऐप्लिकेशन लेआउट के हिसाब से सही ऊंचाई का इस्तेमाल करना चाहिए. अगर maxWidth पैरामीटर भी दिया गया है, तो प्लेयर की चौड़ाई maxHeight से छोटी हो सकती है, ताकि ज़्यादा से ज़्यादा चौड़ाई का उल्लंघन न हो. स्वीकार किए जाने वाले मान 72 से 8192 तक हैं, जिसमें ये दोनों भी शामिल हैं.
maxResults unsigned integer
maxResults पैरामीटर उन आइटम की ज़्यादा से ज़्यादा संख्या तय करता है जिन्हें नतीजे के सेट में दिखाया जाना चाहिए.

ध्यान दें: इस पैरामीटर का इस्तेमाल myRating पैरामीटर के साथ किया जा सकता है, लेकिन id पैरामीटर के साथ इसका इस्तेमाल नहीं किया जा सकता. स्वीकार किए जाने वाले मान 1 से 50 तक हैं, जिसमें ये दोनों भी शामिल हैं. डिफ़ॉल्ट वैल्यू 5 है.
maxWidth unsigned integer
maxWidth पैरामीटर, player.embedHtml प्रॉपर्टी में एम्बेड किए गए प्लेयर की ज़्यादा से ज़्यादा चौड़ाई की जानकारी देता है. इस पैरामीटर का इस्तेमाल यह बताने के लिए किया जा सकता है कि डिफ़ॉल्ट डाइमेंशन के बजाय, एम्बेड कोड को आपके ऐप्लिकेशन लेआउट के मुताबिक सही चौड़ाई का इस्तेमाल करना चाहिए.

अगर maxHeight पैरामीटर भी दिया गया है, तो प्लेयर की लंबाई maxWidth से छोटी हो सकती है, ताकि ज़्यादा से ज़्यादा ऊंचाई का उल्लंघन न हो. स्वीकार किए जाने वाले मान 72 से 8192 तक हैं, जिसमें ये दोनों भी शामिल हैं.
onBehalfOfContentOwner string
इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है.

onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति देने वाले क्रेडेंशियल, YouTube सीएमएस के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास कई अलग-अलग YouTube चैनलों का मालिकाना हक होता है और उन्हें मैनेज करने का अधिकार होता है. इससे कॉन्टेंट के मालिकों को एक बार पुष्टि करने के साथ-साथ, अपने वीडियो और चैनल के पूरे डेटा का ऐक्सेस मिल जाता है. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं पड़ती. उपयोगकर्ता जिस कॉन्टेंट मैनेजमेंट सिस्टम से पुष्टि करता है वह खाता, YouTube कॉन्टेंट के उस मालिक से जुड़ा होना चाहिए.
pageToken string
pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई के रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती हैं जिन्हें वापस पाया जा सकता है.

ध्यान दें: इस पैरामीटर का इस्तेमाल, myRating पैरामीटर के साथ किया जा सकता है. हालांकि, id पैरामीटर के साथ इसका इस्तेमाल नहीं किया जा सकता.
regionCode string
regionCode पैरामीटर, एपीआई को किसी खास क्षेत्र में उपलब्ध वीडियो चार्ट चुनने का निर्देश देता है. इस पैरामीटर का इस्तेमाल सिर्फ़ chart पैरामीटर के साथ जोड़कर किया जा सकता है. पैरामीटर वैल्यू, ISO 3166-1 ऐल्फ़ा-2 देश का कोड है.
videoCategoryId string
videoCategoryId पैरामीटर से उस वीडियो कैटगरी की पहचान होती है जिसके लिए चार्ट को हासिल किया जाना चाहिए. इस पैरामीटर का इस्तेमाल सिर्फ़ chart पैरामीटर के साथ जोड़कर किया जा सकता है. डिफ़ॉल्ट रूप से, चार्ट किसी खास कैटगरी तक सीमित नहीं होते. डिफ़ॉल्ट वैल्यू 0 है.

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

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

जवाब

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

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

प्रॉपर्टी

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

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

गड़बड़ियां

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

गड़बड़ी का टाइप गड़बड़ी की जानकारी ब्यौरा
badRequest (400) videoChartNotFound अनुरोध किया गया वीडियो चार्ट समर्थित नहीं है या उपलब्ध नहीं है.
forbidden (403) forbidden वीडियो फ़ाइल का ऐक्सेस देने या जानकारी प्रोसेस करने के लिए, अनुरोध को सही तरीके से अनुमति नहीं है. ध्यान दें कि fileDetails, processingDetails, और suggestions के हिस्से, सिर्फ़ उस वीडियो के मालिक के लिए उपलब्ध हैं.
forbidden (403) forbidden अनुरोध, उपयोगकर्ता रेटिंग की जानकारी को ऐक्सेस नहीं कर सकता है. यह गड़बड़ी इसलिए हो सकती है, क्योंकि अनुरोध के पास myRating पैरामीटर का इस्तेमाल करने की अनुमति नहीं है.
notFound (404) videoNotFound आपको जिस वीडियो को वापस पाने की कोशिश करनी है वह नहीं मिला. अनुरोध के id पैरामीटर की वैल्यू की जांच करके पक्का करें कि वह सही है.

इसे आज़माएं!

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