कैप्शन ट्रैक डाउनलोड करता है. कैप्शन ट्रैक को उसके ओरिजनल फ़ॉर्मैट में दिखाया जाता है. हालांकि, अगर अनुरोध में tfmt पैरामीटर के लिए कोई वैल्यू दी गई है, तो कैप्शन ट्रैक को उस वैल्यू के हिसाब से दिखाया जाता है. इसी तरह, कैप्शन ट्रैक को उसकी ओरिजनल भाषा में दिखाया जाता है. हालांकि, अगर अनुरोध में tlang पैरामीटर के लिए कोई वैल्यू दी गई है, तो कैप्शन ट्रैक को उस वैल्यू के हिसाब से दिखाया जाता है.
कोटा पर असर: इस तरीके को कॉल करने पर, 200 यूनिट का कोटा शुल्क लगता है.
इस तरीके का इस्तेमाल करने के लिए, उपयोगकर्ता के पास वीडियो में बदलाव करने की अनुमति होनी चाहिए.
इस्तेमाल के सामान्य उदाहरण
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/captions/id
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति लेना ज़रूरी है (पुष्टि और अनुमति के बारे में ज़्यादा जानें).
| दायरा |
|---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
पैरामीटर
यहां दी गई टेबल में उन पैरामीटर के बारे में बताया गया है जिनका इस्तेमाल इस क्वेरी में किया जा सकता है. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
| पैरामीटर | ||
|---|---|---|
| ज़रूरी पैरामीटर | ||
id |
stringid पैरामीटर, उस कैप्शन ट्रैक की पहचान करता है जिसे वापस लाया जा रहा है. इसकी वैल्यू, कैप्शन ट्रैक आईडी होती है. इसकी पहचान, caption रिसॉर्स में मौजूद id प्रॉपर्टी से की जाती है. |
|
| वैकल्पिक पैरामीटर | ||
onBehalfOfContentOwner |
stringइस पैरामीटर का इस्तेमाल सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध के अनुमति क्रेडेंशियल, YouTube सीएमएस के उस उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर, YouTube कॉन्टेंट पार्टनर के लिए है. ये पार्टनर, कई YouTube चैनलों का मालिकाना हक रखते हैं और उन्हें मैनेज करते हैं. इससे कॉन्टेंट के मालिकों को एक बार पुष्टि करने के बाद, अपने सभी वीडियो और चैनल के डेटा का ऐक्सेस मिल जाता है. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं होती. उपयोगकर्ता जिस सीएमएस खाते से पुष्टि करता है वह YouTube कॉन्टेंट के मालिकाना हक वाले खाते से लिंक होना चाहिए. |
|
tfmt |
stringtfmt पैरामीटर से यह तय होता है कि कैप्शन ट्रैक को किसी खास फ़ॉर्मैट में दिखाया जाना चाहिए. अगर पैरामीटर को अनुरोध में शामिल नहीं किया जाता है, तो ट्रैक को उसके मूल फ़ॉर्मैट में दिखाया जाता है.इस्तेमाल की जा सकने वाली वैल्यू ये हैं:
|
|
tlang |
stringtlang पैरामीटर से यह तय होता है कि एपीआई से मिली जानकारी में, तय किए गए कैप्शन ट्रैक का अनुवाद दिखना चाहिए. इस पैरामीटर की वैल्यू, ISO 639-1 के दो अक्षरों वाला भाषा कोड होती है. इससे कैप्शन की पसंदीदा भाषा की पहचान होती है. अनुवाद, मशीन से अनुवाद करने की सुविधा का इस्तेमाल करके जनरेट किया जाता है. जैसे, Google Translate. |
|
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर यह तरीका काम करता है, तो इससे एक बाइनरी फ़ाइल मिलती है. रिस्पॉन्स के लिए Content-Type हेडर, application/octet-stream है.
गड़बड़ियां
नीचे दी गई टेबल में, उन गड़बड़ी के मैसेज के बारे में बताया गया है जो इस तरीके को कॉल करने पर एपीआई दिखा सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी के मैसेज वाला दस्तावेज़ देखें.
| गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
|---|---|---|
forbidden (403) |
forbidden |
अनुरोध से जुड़ी अनुमतियां, कैप्शन ट्रैक डाउनलोड करने के लिए काफ़ी नहीं हैं. ऐसा हो सकता है कि अनुरोध को सही तरीके से अनुमति न मिली हो. |
invalidValue (400) |
couldNotConvert |
कैप्शन ट्रैक के डेटा को अनुरोध की गई भाषा और/या फ़ॉर्मैट में नहीं बदला जा सका. पक्का करें कि अनुरोध की गई tfmt और tlang वैल्यू मान्य हों. साथ ही, अनुरोध किए गए कैप्शन ट्रैक का snippet.status, failed न हो. |
notFound (404) |
captionNotFound |
कैप्शन ट्रैक नहीं मिला. अनुरोध के id पैरामीटर की वैल्यू की जांच करें, ताकि यह पक्का किया जा सके कि वह सही है. |
इसे आज़माएं!
इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.