कैप्शन ट्रैक को अपडेट करता है. कैप्शन ट्रैक को अपडेट करते समय, ट्रैक की ड्राफ़्ट स्थिति बदली जा सकती है. साथ ही, ट्रैक के लिए कैप्शन की नई फ़ाइल अपलोड की जा सकती है या ये दोनों काम किए जा सकते हैं.
यह तरीका, मीडिया अपलोड करने की सुविधा के साथ काम करता है. अपलोड की गई फ़ाइलें, इन शर्तों के मुताबिक होनी चाहिए:
- फ़ाइल का ज़्यादा से ज़्यादा साइज़: 100 एमबी
- स्वीकार किए जाने वाले मीडिया के एमआईएमई टाइप:
text/xml,application/octet-stream,*/*
कोटे पर असर: इस तरीके को कॉल करने पर, कोटे की 450 यूनिट खर्च होती हैं.
इस्तेमाल के सामान्य उदाहरण
अनुरोध
एचटीटीपी अनुरोध
PUT https://www.googleapis.com/upload/youtube/v3/captions
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति की ज़रूरत होती है. (अनुमति और पुष्टि के बारे में ज़्यादा जानें).
| दायरा |
|---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
पैरामीटर
यहां दी गई टेबल में, उन पैरामीटर की सूची दी गई है जिन्हें इस क्वेरी में इस्तेमाल किया जा सकता है. यहां दी गई सूची में शामिल सभी पैरामीटर, क्वेरी पैरामीटर हैं.
| पैरामीटर | ||
|---|---|---|
| ज़रूरी पैरामीटर | ||
part |
stringइस कार्रवाई में, part पैरामीटर का इस्तेमाल दो मकसद से किया जाता है. इससे उन प्रॉपर्टी की पहचान होती है जिन्हें राइट ऑपरेशन सेट करेगा. साथ ही, उन प्रॉपर्टी की पहचान होती है जिन्हें एपीआई से मिली जानकारी में शामिल किया जाएगा. अगर ट्रैक की ड्राफ़्ट स्थिति अपडेट की जा रही है, तो प्रॉपर्टी की वैल्यू को snippet पर सेट करें. अन्यथा, प्रॉपर्टी की वैल्यू को id पर सेट करें.यहां दी गई सूची में, part के उन नामों के बारे में बताया गया है जिन्हें पैरामीटर वैल्यू में शामिल किया जा सकता है:
|
|
| वैकल्पिक पैरामीटर | ||
onBehalfOfContentOwner |
stringइस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति के क्रेडेंशियल, YouTube सीएमएस के ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो YouTube के कई अलग-अलग चैनलों के मालिक हैं और उन्हें मैनेज करते हैं. इससे कॉन्टेंट के मालिक, एक बार पुष्टि करके अपने सभी वीडियो और चैनल के डेटा को ऐक्सेस कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए अनुमति के क्रेडेंशियल देने की ज़रूरत नहीं होती. जिस CMS खाते से उपयोगकर्ता पुष्टि करता है वह, बताए गए YouTube के कॉन्टेंट के मालिक से लिंक होना चाहिए. |
|
sync |
booleanइस पैरामीटर का इस्तेमाल बंद कर दिया गया है. ध्यान दें: एपीआई सर्वर, पैरामीटर की वैल्यू को सिर्फ़ तब प्रोसेस करता है, जब अनुरोध में कैप्शन की अपडेट की गई फ़ाइल शामिल हो. The sync पैरामीटर से पता चलता है कि YouTube को कैप्शन की फ़ाइल को वीडियो के ऑडियो ट्रैक के साथ अपने-आप सिंक करना चाहिए या नहीं. अगर वैल्यू को true पर सेट किया जाता है, तो YouTube, कैप्शन ट्रैक को ऑडियो ट्रैक के साथ अपने-आप सिंक कर देगा. |
|
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में, कैप्शन का संसाधन उपलब्ध कराएं. उस संसाधन के लिए:
-
आपको इन प्रॉपर्टी के लिए वैल्यू तय करनी होगी:
id
-
इन प्रॉपर्टी के लिए वैल्यू सेट की जा सकती हैं:
snippet.isDraft
अगर अपडेट का अनुरोध सबमिट किया जा रहा है और आपके अनुरोध में किसी ऐसी प्रॉपर्टी के लिए वैल्यू तय नहीं की गई है जिसकी पहले से कोई वैल्यू है, तो प्रॉपर्टी की मौजूदा वैल्यू मिटा दी जाएगी.
जवाब
अगर यह तरीका काम करता है, तो जवाब के मुख्य भाग में कैप्शन का संसाधन दिखता है.
गड़बड़ियां
यहां दी गई टेबल में, गड़बड़ी के उन मैसेज की पहचान की गई है जो इस तरीके को कॉल करने पर, एपीआई के जवाब में दिख सकते हैं. ज़्यादा जानकारी के लिए, गड़बड़ी के मैसेज से जुड़ा दस्तावेज़ देखें.
| गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
|---|---|---|
badRequest (400) |
contentRequired |
अनुरोध में, कैप्शन की अपडेट की गई फ़ाइल अपलोड नहीं की गई. अगर sync पैरामीटर को true पर सेट किया जाता है, तो ट्रैक का असली कॉन्टेंट ज़रूरी है. |
forbidden (403) |
forbidden |
कैप्शन ट्रैक को अपडेट करने के लिए, अनुरोध से जुड़ी अनुमतियां काफ़ी नहीं हैं. हो सकता है कि अनुरोध को सही तरीके से अनुमति न मिली हो. |
notFound (404) |
captionNotFound |
बताया गया कैप्शन ट्रैक नहीं मिला. अनुरोध की id प्रॉपर्टी की वैल्यू की जांच करें, ताकि यह पक्का किया जा सके कि यह सही है. |
इसे आज़माएं!
इस एपीआई को कॉल करने और एपीआई अनुरोध और जवाब को देखने के लिए, APIs Explorer का इस्तेमाल करें.