Videos: list

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

कोटे पर असर: इस तरीके को कॉल करने पर, कोटे की एक यूनिट का खर्च आता है.

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

अनुरोध

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

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

पैरामीटर

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

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

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

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

इसके लिए ये वैल्यू डाली जा सकती हैं:
id string
id पैरामीटर, उन संसाधनों के लिए YouTube वीडियो आईडी की कॉमा से अलग की गई सूची तय करता है जिन्हें वापस पाया जा रहा है. video संसाधन में, id प्रॉपर्टी वीडियो का आईडी तय करती है.
myRating string

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



एपीआई, दिखाए जाने वाले नतीजों के सेट को ज़्यादा से ज़्यादा 1,000 वीडियो तक सीमित करता है. भले ही, जवाब की pageInfo.totalResults प्रॉपर्टी, ज़्यादा कुल संख्या दिखाए, लेकिन pageToken पैरामीटर का इस्तेमाल करके पेज पर बांटने की सुविधा से, सिर्फ़ हाल के 1,000 आइटम वापस पाए जा सकते हैं.



यह पैरामीटर, इन वैल्यू को स्वीकार करता है:

  • 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
The maxResults पैरामीटर, नतीजों के सेट में दिखाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या तय करता है.

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

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

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

ध्यान दें: इस पैरामीटर का इस्तेमाल, myRating पैरामीटर के साथ किया जा सकता है. हालांकि, इसका इस्तेमाल id पैरामीटर के साथ नहीं किया जा सकता.
regionCode string
regionCode पैरामीटर, एपीआई को तय किए गए इलाके में उपलब्ध वीडियो चार्ट चुनने का निर्देश देता है. इस पैरामीटर का इस्तेमाल, सिर्फ़ chart पैरामीटर के साथ किया जा सकता है. पैरामीटर वैल्यू, ISO 3166-1 alpha-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
इस संसाधन का 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 का इस्तेमाल करें.