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 चैनलों का मालिकाना हक होता है और उन्हें मैनेज करने का अधिकार होता है. इससे कॉन्टेंट के मालिकों को एक बार पुष्टि करने के साथ-साथ, अपने वीडियो और चैनल के पूरे डेटा का ऐक्सेस मिल जाता है. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं पड़ती. उपयोगकर्ता जिस असली कॉन्टेंट मैनेजमेंट सिस्टम से पुष्टि करता है उसे, 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 पैरामीटर से पहचाना गया वीडियो नहीं मिला.