Captions: list

यह फ़ंक्शन, तय किए गए वीडियो से जुड़े कैप्शन ट्रैक की सूची दिखाता है. ध्यान दें कि एपीआई से मिली जानकारी में, असली कैप्शन शामिल नहीं होते. साथ ही, captions.download तरीके से, कैप्शन ट्रैक को वापस पाने की सुविधा मिलती है.

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

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

अनुरोध

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

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

अनुमति देना

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति की ज़रूरत होती है. अनुमति और पुष्टि करने की प्रोसेस के बारे में ज़्यादा जानें.

दायरा
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
part string
part पैरामीटर से पता चलता है कि एपीआई से मिली जानकारी में, caption संसाधन के कौनसे हिस्से शामिल होंगे.

यहां दी गई सूची में, part के उन नामों के बारे में बताया गया है जिन्हें पैरामीटर वैल्यू में शामिल किया जा सकता है:
  • id
  • snippet
videoId string
videoId पैरामीटर से, उस वीडियो के YouTube वीडियो आईडी के बारे में पता चलता है जिसके लिए एपीआई को कैप्शन ट्रैक दिखाने चाहिए.
वैकल्पिक पैरामीटर
id string
id पैरामीटर से, उन caption संसाधनों की पहचान करने वाले आईडी की कॉमा लगाकर अलग की गई लिस्ट के बारे में पता चलता है जिन्हें वापस पाना है. हर आईडी से, तय किए गए वीडियो से जुड़े कैप्शन ट्रैक की पहचान होनी चाहिए.
onBehalfOfContentOwner string
इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है.

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

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

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

जवाब

अगर अनुरोध सही से काम करता है, तो यह तरीका, जवाब के मुख्य भाग में यह स्ट्रक्चर दिखाता है:

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

प्रॉपर्टी

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

प्रॉपर्टी
kind string
इससे, एपीआई संसाधन के टाइप की पहचान होती है. इसकी वैल्यू youtube#captionListResponse होगी.
etag etag
यह इस संसाधन का Etag है.
items[] list
यह उन कैप्शन की सूची है जो अनुरोध की शर्तों के मुताबिक हैं.

गड़बड़ियां

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

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

इसे आज़माएं!

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