नीचे दिए गए उदाहरणों में बताया गया है कि कैप्शन से जुड़े फ़ंक्शन करने के लिए, YouTube डेटा एपीआई (v3) का इस्तेमाल कैसे किया जाता है.
किसी वीडियो के लिए कैप्शन ट्रैक की सूची फिर से पाएं
किसी खास वीडियो के लिए उपलब्ध कैप्शन ट्रैक की सूची फिर से पाने के लिए, captions.list
तरीके पर कॉल करें. YouTube वीडियो आईडी में videoId
पैरामीटर वैल्यू सेट करें. इससे, उस वीडियो की खास तौर पर पहचान होती है जिसके लिए आपको कैप्शन मिल रहे हैं. आपके अनुरोध को OAuth 2.0 का इस्तेमाल करके अनुमति देनी होगी.
नीचे दिया गया अनुरोध, Google स्टोरीज़ के YouTube चैनल पर एक वीडियो के लिए कैप्शन की सूची दिखाता है:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list? part=snippet &videoId=PRU2ShMzQRg
कोड सैंपल के लिए, captions.list
तरीके का दस्तावेज़ देखें.
कैप्शन ट्रैक बनाना
इस क्वेरी का परीक्षण API एक्सप्लोरर का उपयोग कर नहीं किया जा सकता, क्योंकि API एक्सप्लोरर फ़ाइलें अपलोड करने की क्षमता का समर्थन नहीं करता, जो इस विधि के लिए एक आवश्यक है.
एपीआई के captions.insert
तरीके का इस्तेमाल करके, किसी वीडियो के लिए नया कैप्शन ट्रैक अपलोड किया जा सकता है. ट्रैक अपलोड करते समय, आपको इन caption
संसाधन प्रॉपर्टी के लिए मान तय करना होगा:
snippet.videoId
- यह उस वीडियो की पहचान करता है जिसमें कैप्शन ट्रैक जोड़ा जा रहा है.snippet.language
- कैप्शन ट्रैक की भाषा.snippet.name
- कैप्शन ट्रैक का नाम.
कैप्शन ट्रैक अपलोड करते समय, ये अन्य विकल्प उपलब्ध होते हैं:
-
अगर
sync
पैरामीटर कोtrue
पर सेट किया जाता है, तो YouTube अपलोड किए गए कैप्शन की फ़ाइल में मौजूद किसी भी समय कोड को अनदेखा कर देगा और कैप्शन के लिए नए टाइम कोड जनरेट करेगा.अगर आप ऐसी ट्रांसक्रिप्ट अपलोड कर रहे हैं जिसमें कोई समय कोड नहीं है या अगर आपको लगता है कि आपकी फ़ाइल में समय कोड गलत हैं और आप चाहते हैं कि YouTube उन्हें ठीक करने की कोशिश करे, तो आपको
sync
पैरामीटर कोtrue
पर सेट करना चाहिए. -
अगर
caption
संसाधन कीsnippet.isDraft
प्रॉपर्टी कोtrue
पर सेट किया जाता है, तो ट्रैक सार्वजनिक तौर पर नहीं दिखेगा.
कोड सैंपल के लिए, captions.insert
तरीके का दस्तावेज़ देखें.
कोई कैप्शन ट्रैक डाउनलोड करें
इस क्वेरी का परीक्षण API एक्सप्लोरर का उपयोग करके नहीं किया जा सकता, क्योंकि API एक्सप्लोरर फ़ाइलों को डाउनलोड करने की क्षमता का समर्थन नहीं करता.
कोई खास कैप्शन ट्रैक डाउनलोड करने के लिए, captions.download
तरीके पर कॉल करें. id
कैप्शन की वैल्यू को YouTube कैप्शन ट्रैक आईडी पर सेट करें. इससे, डाउनलोड किए जा रहे कैप्शन ट्रैक की पहचान करने में मदद मिलती है. आपके अनुरोध को OAuth 2.0 का इस्तेमाल करके अनुमति देनी होगी.
वर्शन 3 को इन विकल्पों के साथ इस्तेमाल किया जा सकता है:
-
यह बताने के लिए कि किसी खास फ़ॉर्मैट में कैप्शन ट्रैक दिखाया जाए, अपने हिसाब से फ़ॉर्मैट की पहचान करने के लिए
tfmt
पैरामीटर वैल्यू सेट करें. पैरामीटर की परिभाषा में, इस्तेमाल की जा सकने वाली वैल्यू शामिल होती हैं. -
कैप्शन ट्रैक का अनुवाद पाने के लिए,
tlang
पैरामीटर वैल्यू को ISO 639-1 दो अक्षर वाले भाषा कोड पर सेट करें. इससे, कैप्शन की मनचाही भाषा की पहचान की जा सकती है. Google Translate जैसे मशीन अनुवाद का इस्तेमाल करके अनुवाद किया जाता है.
कोड सैंपल के लिए, captions.download
तरीके का दस्तावेज़ देखें.
कैप्शन ट्रैक को अपडेट करना
एपीआई, कैप्शन ट्रैक के ड्राफ़्ट स्टेटस को बदलने, फ़ाइल के लिए नया कैप्शन ट्रैक अपलोड करने या दोनों को अपडेट करने की सुविधा देता है.
एपीआई एक्सप्लोरर का इस्तेमाल करके, ट्रैक के ड्राफ़्ट की स्थिति बदली जा सकती है. हालांकि, आप API के इस्तेमाल से, कैप्शन ट्रैक को अपडेट नहीं कर सकते, क्योंकि टूल में फ़ाइलें अपलोड करने की सुविधा काम नहीं करती.
नीचे दिया गया अनुरोध, Google स्टोरीज़ के YouTube चैनल पर एक वीडियो के लिए कैप्शन की सूची दिखाता है:
अनुरोध, कैप्शन ट्रैक के ड्राफ़्ट की स्थिति को true
में अपडेट कर देता है. इसका मतलब है कि ट्रैक सार्वजनिक तौर पर नहीं दिखेगा. एपीआई एक्सप्लोरर में अनुरोध पूरा करने के लिए, किसी कैप्शन ट्रैक की पहचान करने के लिए, आपको id
प्रॉपर्टी की वैल्यू सेट करनी होगी.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update? part=snippet
कोड सैंपल के लिए, captions.update
तरीके का दस्तावेज़ देखें.
कैप्शन ट्रैक को मिटाना
इस उदाहरण में कैप्शन ट्रैक को मिटाने का तरीका दिखाया गया है. इस उदाहरण में यह तरीका दिया गया है:
-
पहला चरण: कैप्शन ट्रैक आईडी को वापस पाना
किसी वीडियो के लिए कैप्शन ट्रैक की सूची पाने के लिए, ऊपर बताया गया तरीका अपनाएं. सूची का इस्तेमाल कैप्शन ट्रैक की सूची दिखाने के लिए किया जा सकता है. इसके लिए हर ट्रैक के आईडी को कुंजी के तौर पर इस्तेमाल किया जा सकता है.
-
दूसरा चरण: ट्रैक को मिटाना
किसी खास वीडियो को मिटाने के लिए,
captions.delete
का तरीका अपनाएं. अनुरोध में,id
पैरामीटर उस ट्रैक का कैप्शन ट्रैक आईडी बताता है जिसे आप मिटा रहे हैं. अनुरोध को OAuth 2.0 का इस्तेमाल करके अनुमति दी जानी चाहिए. अगर आप इस क्वेरी की जांच एपीआई एक्सप्लोरर में कर रहे हैं, तो आपकोid
पैरामीटर वैल्यू के लिए, एक मान्य कैप्शन ट्रैक आईडी बदलना होगा.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete? id=CAPTION_TRACK_ID