दिए गए वीडियो के लिए कैप्शन ट्रैक की सूची दिखाता है. ध्यान दें कि एपीआई रिस्पॉन्स में असल कैप्शन शामिल नहीं होते और 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 नाम शामिल हैं, जिन्हें आप पैरामीटर वैल्यू में शामिल कर सकते हैं:
|
|
videoId |
string videoId पैरामीटर उस वीडियो के YouTube वीडियो आईडी के बारे में बताता है जिसके लिए एपीआई को कैप्शन ट्रैक लौटाने चाहिए. |
|
ज़रूरी पैरामीटर | ||
id |
string id पैरामीटर, आईडी की कॉमा-सेपरेटेड लिस्ट बनाता है. इससे, उन caption संसाधनों की पहचान होती है जिन्हें वापस पाना है. हर आईडी से, बताए गए वीडियो के कैप्शन ट्रैक की पहचान की जानी चाहिए. |
|
onBehalfOfContentOwner |
string इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की पुष्टि के लिए, किसी YouTube कॉन्टेंट मैनेजमेंट सिस्टम के उपयोगकर्ता की पहचान की गई है. यह उपयोगकर्ता, पैरामीटर वैल्यू में तय किए गए कॉन्टेंट के मालिक की तरफ़ से काम करता है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जो कई अलग-अलग YouTube चैनलों के मालिक हैं और उन्हें प्रबंधित करते हैं. इसकी मदद से कॉन्टेंट के मालिक एक बार पुष्टि कर सकते हैं. साथ ही, अपने सभी वीडियो और चैनल के डेटा को ऐक्सेस कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल नहीं देने होंगे. जिस असल कॉन्टेंट मैनेजर के साथ उपयोगकर्ता की पुष्टि होती है उसे YouTube के कॉन्टेंट के मालिक से लिंक होना चाहिए. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:
{ "kind": "youtube#captionListResponse", "etag": etag, "items": [ caption Resource ] }
प्रॉपर्टी
इस टेबल में उन प्रॉपर्टी के बारे में बताया गया है जो इस रिसॉर्स में मौजूद हैं:
प्रॉपर्टी | |
---|---|
kind |
string इससे यह पता चलता है कि एपीआई संसाधन किस तरह का है. वैल्यू youtube#captionListResponse होगी. |
etag |
etag इस संसाधन का ऐट. |
items[] |
list कैप्शन की सूची, जो अनुरोध की शर्तों को पूरा करती है. |
गड़बड़ियां
इस टेबल में उन गड़बड़ी के मैसेज के बारे में बताया गया है जो इस तरीके से कॉल करने पर एपीआई मिल सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी का मैसेज दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
---|---|---|
forbidden (403) |
forbidden |
एक या उससे ज़्यादा कैप्शन ट्रैक वापस नहीं लाए जा सके, क्योंकि अनुरोध से जुड़ी अनुमतियां, अनुरोध किए गए संसाधनों को पाने के लिए काफ़ी नहीं हैं. हो सकता है कि अनुरोध को सही तरीके से अनुमति न दी गई हो. |
notFound (404) |
captionNotFound |
बताए गए एक या इससे ज़्यादा कैप्शन ट्रैक नहीं मिले. यह गड़बड़ी तब होती है, जब videoId पैरामीटर किसी सही वीडियो की पहचान करता है. हालांकि, id पैरामीटर या तो ऐसे कैप्शन ट्रैक आईडी की पहचान करता है जो मौजूद नहीं हैं या फिर ऐसे आईडी ट्रैक करता है जो दूसरे वीडियो से जुड़े हैं. अनुरोध के id और videoId पैरामीटर की वैल्यू देखकर, पक्का करें कि वे सही हैं. |
notFound (404) |
videoNotFound |
videoId पैरामीटर से पहचाना गया वीडियो नहीं मिला. |
इसे आज़माएं!
इस एपीआई को कॉल करने और एपीआई का अनुरोध और जवाब देखने के लिए, APIs Explorer का इस्तेमाल करें.