LiveStreams: list

एपीआई अनुरोध के पैरामीटर से मेल खाने वाली वीडियो स्ट्रीम की सूची दिखाता है.

इस्तेमाल के सामान्य उदाहरण

अनुरोध

एचटीटीपी अनुरोध

GET https://www.googleapis.com/youtube/v3/liveStreams

अनुमति देना

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति की ज़रूरत होती है. (अनुमति और पुष्टि के बारे में ज़्यादा जानें).

दायरा
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

पैरामीटर

यहां दी गई टेबल में, वे पैरामीटर दिए गए हैं जिन्हें इस क्वेरी में इस्तेमाल किया जा सकता है. यहां दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.

पैरामीटर
ज़रूरी पैरामीटर
part string
part पैरामीटर, liveStream संसाधन की एक या उससे ज़्यादा प्रॉपर्टी की कॉमा से अलग की गई सूची तय करता है. यह सूची, एपीआई के जवाब में शामिल होगी. पैरामीटर वैल्यू में, part नाम शामिल किए जा सकते हैं: id, snippet, cdn, और status.
फ़िल्टर (इनमें से कोई एक पैरामीटर तय करें)
id string
id पैरामीटर, YouTube स्ट्रीम आईडी की कॉमा लगाकर अलग की गई लिस्ट तय करता है. इससे उन स्ट्रीम की पहचान होती है जिन्हें वापस पाया जा रहा है. liveStream संसाधन में, id प्रॉपर्टी से स्ट्रीम के आईडी की जानकारी मिलती है.
mine boolean
यह पैरामीटर, सिर्फ़ अनुमति वाले अनुरोध में इस्तेमाल किया जा सकता है. एपीआई को सिर्फ़ पुष्टि किए गए उपयोगकर्ता की स्ट्रीम दिखाने के लिए, mine पैरामीटर का इस्तेमाल किया जा सकता है. सिर्फ़ अपनी स्ट्रीम वापस पाने के लिए, पैरामीटर की वैल्यू true पर सेट करें.
वैकल्पिक पैरामीटर
maxResults unsigned integer
maxResults पैरामीटर, नतीजों के सेट में वापस दिखाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या तय करता है. 0 से 50 तक की वैल्यू मान्य हैं. डिफ़ॉल्ट वैल्यू 5 है.
onBehalfOfContentOwner string
इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है.

onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति के क्रेडेंशियल, YouTube सीएमएस के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में तय किए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो YouTube के कई अलग-अलग चैनलों के मालिक हैं और उन्हें मैनेज करते हैं. इससे, कॉन्टेंट के मालिक एक बार पुष्टि करके, अपने सभी वीडियो और चैनल के डेटा का ऐक्सेस पा सकते हैं. इसके लिए, उन्हें हर चैनल के लिए अनुमति के क्रेडेंशियल देने की ज़रूरत नहीं होती. जिस CMS खाते से उपयोगकर्ता पुष्टि करता है वह, तय किए गए YouTube कॉन्टेंट के मालिक से लिंक होना चाहिए.
onBehalfOfContentOwnerChannel string
इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है.

onBehalfOfContentOwnerChannel पैरामीटर, उस YouTube चैनल के चैनल आईडी की जानकारी देता है जिसमें कोई वीडियो जोड़ा जा रहा है. जब किसी अनुरोध में onBehalfOfContentOwner पैरामीटर के लिए कोई वैल्यू तय की जाती है, तब इस पैरामीटर का इस्तेमाल करना ज़रूरी होता है. साथ ही, इसका इस्तेमाल सिर्फ़ उस पैरामीटर के साथ किया जा सकता है. इसके अलावा, अनुरोध को अनुमति देने के लिए, CMS के उस खाते का इस्तेमाल करना होगा जो onBehalfOfContentOwner पैरामीटर में तय किए गए कॉन्टेंट के मालिक से लिंक हो. आखिर में, onBehalfOfContentOwnerChannel पैरामीटर की वैल्यू में तय किया गया चैनल, onBehalfOfContentOwner पैरामीटर में तय किए गए कॉन्टेंट के मालिक से लिंक होना चाहिए.

यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो YouTube के कई अलग-अलग चैनलों के मालिक हैं और उन्हें मैनेज करते हैं. इससे, कॉन्टेंट के मालिक एक बार पुष्टि करके, पैरामीटर वैल्यू में तय किए गए चैनल की ओर से कार्रवाइयां कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए अनुमति के क्रेडेंशियल देने की ज़रूरत नहीं होती.
pageToken string
pageToken पैरामीटर, नतीजों के सेट में मौजूद किसी खास पेज की पहचान करता है. यह पेज, जवाब के तौर पर दिखाया जाता है. एपीआई से मिली जानकारी में, nextPageToken और prevPageToken प्रॉपर्टी से उन अन्य पेजों की पहचान होती है जिन्हें वापस पाया जा सकता है.

अनुरोध का मुख्य भाग

इस तरीके को कॉल करते समय, अनुरोध का मुख्य भाग न दें.

जवाब

अगर अनुरोध सही से काम करता है, तो यह तरीका जवाब के मुख्य हिस्से में, यहां दिया गया स्ट्रक्चर दिखाता है:

{
  "kind": "youtube#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream Resource
  ]
}

प्रॉपर्टी

यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:

प्रॉपर्टी
kind string
इससे एपीआई संसाधन के टाइप की पहचान होती है. इसकी वैल्यू youtube#liveStreamListResponse होगी.
etag etag
यह इस संसाधन का Etag है.
nextPageToken string
यह टोकन, नतीजों के सेट में मौजूद अगले पेज को वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
prevPageToken string
यह टोकन, नतीजों के सेट में मौजूद पिछले पेज को वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
pageInfo object
pageInfo ऑब्जेक्ट, नतीजों के सेट के लिए पेजिंग की जानकारी देता है.
pageInfo.totalResults integer
यह नतीजों के सेट में मौजूद नतीजों की कुल संख्या है.
pageInfo.resultsPerPage integer
एपीआई से मिली जानकारी में शामिल नतीजों की संख्या.
items[] list
यह उन लाइव स्ट्रीम की सूची है जो अनुरोध की शर्तों के मुताबिक हैं.

गड़बड़ियां

यहां दी गई टेबल में, गड़बड़ी के उन मैसेज की जानकारी दी गई है जो इस तरीके को कॉल करने पर, एपीआई के जवाब में दिख सकते हैं. ज़्यादा जानकारी के लिए, गड़बड़ी के मैसेज से जुड़ा दस्तावेज़ देखें.

गड़बड़ी का टाइप गड़बड़ी की जानकारी ब्यौरा
insufficientPermissions insufficientLivePermissions अनुरोध के पास, तय की गई लाइव स्ट्रीम को वापस पाने की अनुमति नहीं है.
insufficientPermissions liveStreamingNotEnabled जिस उपयोगकर्ता ने अनुरोध को अनुमति दी है उसके पास, YouTube पर लाइव वीडियो स्ट्रीम करने की अनुमति नहीं है. उपयोगकर्ता, https://www.youtube.com/features पर जाकर ज़्यादा जानकारी पा सकता है.

इसे आज़माएं!

इस एपीआई को कॉल करने और एपीआई अनुरोध और जवाब को देखने के लिए, APIs Explorer का इस्तेमाल करें.