क्लास: StreamRequest

ima.StreamRequest

class   static

निर्माता

StreamRequest

नया स्ट्रीम अनुरोध()

इस कुकी का इस्तेमाल, स्ट्रीम के अनुरोध की प्रॉपर्टी तय करने के लिए किया जाता है.

प्रॉपर्टी

adTagParameters

static

स्ट्रिंग

ज़रूरी नहीं. आप अपने स्ट्रीम अनुरोध पर विज्ञापन टैग पैरामीटर के सीमित सेट को ओवरराइड कर सकते हैं. अपनी स्ट्रीम के लिए टारगेटिंग पैरामीटर उपलब्ध कराएं से ज़्यादा जानकारी मिलती है. आप स्ट्रीम वैरिएंट वरीयता के लिए dai-ot और dai-ov पैरामीटर का भी उपयोग कर सकते हैं. अधिक जानकारी के लिए स्ट्रीम वैरिएंट पैरामीटर ओवरराइड करें देखें.

adUiNode

static

roSGNode

यह सीन ग्राफ़ नोड है, जहां विज्ञापन का यूज़र इंटरफ़ेस (यूआई) दिखता है. विज्ञापन दिखाने के दौरान, IMA इस एलिमेंट पर यह विज्ञापन क्यों और स्किप करें जैसे बटन जोड़ता है. यह एलिमेंट, पूरे वीडियो एलिमेंट पर ओवरले होना चाहिए.

apiKey

static

स्ट्रिंग

ज़रूरी नहीं. इन कुंजियों का उपयोग स्ट्रीम अनुरोधों को प्रमाणित करने के लिए किया जा सकता है. DAI ऑथेंटिकेशन कुंजियां, DFP यूज़र इंटरफ़ेस (यूआई) में सेट अप की जानी चाहिए.

assetKey

static

स्ट्रिंग

लाइव स्ट्रीम के लिए ज़रूरी है. इस कुकी का इस्तेमाल यह तय करने के लिए किया जाता है कि कौनसी स्ट्रीम चलाई जानी चाहिए. लाइव स्ट्रीम के अनुरोध की ऐसेट कुंजी एक आइडेंटिफ़ायर है. यह DFP के यूज़र इंटरफ़ेस (यूआई) में मिल सकता है.

authToken

static

स्ट्रिंग

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

contentSourceId

static

स्ट्रिंग

मांग पर उपलब्ध स्ट्रीम के लिए ज़रूरी है. cmsid, DFP यूज़र इंटरफ़ेस (यूआई) में मौजूद DFP वीडियो कॉन्टेंट सोर्स से मिलता है.

customAssetKey

static

स्ट्रिंग

कस्टम ऐसेट कुंजी का इस्तेमाल यह तय करने के लिए किया जाता है कि कौनसा स्ट्रीम चलाया जाना चाहिए. पॉड के ज़रिए स्ट्रीम करने के अनुरोधों के लिए, कस्टम ऐसेट कुंजियां ज़रूरी होती हैं.

प्रारूप

static

ima.StreamFormat

स्ट्रीम का प्रारूप. डिफ़ॉल्ट रूप से ima.StreamFormat.HLS.

networkCode

static

स्ट्रिंग

स्ट्रीम अनुरोध करने वाले प्रकाशक के लिए नेटवर्क कोड. createPodLiveStreamRequest या createPodVodStreamRequest का इस्तेमाल करके किए गए पॉड सर्विंग स्ट्रीम के अनुरोधों के लिए, नेटवर्क कोड ज़रूरी होते हैं. ये कोड createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, या createVideoStitcherVodStreamRequestWithVodConfig के साथ किए गए क्लाउड स्टिचिंग स्ट्रीम अनुरोधों के लिए भी आवश्यक हैं. ये कोड वैकल्पिक हैं. हालांकि, createLiveStreamRequest या createVodStreamRequest की मदद से किए गए Full service स्ट्रीम के अनुरोधों के लिए, इनका इस्तेमाल करने का सुझाव दिया जाता है. नेटवर्क कोड जोड़ने से, Ad Manager के यूज़र इंटरफ़ेस (यूआई) में चुनी गई सेटिंग लागू होती हैं. जैसे, प्रोग्राम के हिसाब से विज्ञापनों को सीमित तौर पर दिखाने की सुविधा चालू करना. पॉड सर्विंग और क्लाउड स्टिचिंग के लिए, नेटवर्क कोड जोड़ने से स्ट्रीम का पता चलता है और उसे चलाया जाता है. नेटवर्क कोड जानने के लिए, यह लेख देखें.

खिलाड़ी

static

(ima.Player या अमान्य)

प्लेयर इंटरफ़ेस का एक वर्शन.

ppid

static

स्ट्रिंग

समर्थन नहीं होना या रुकना. adTagParameters का उपयोग करें. ज़रूरी नहीं. DFP ऑडियंस प्रकाशक द्वारा प्रदान किया गया पहचानकर्ता.

streamActivityMonitorId

static

स्ट्रिंग

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

videoId

static

स्ट्रिंग

ऑन-डिमांड स्ट्रीम के लिए आवश्यक. वीडियो कॉन्टेंट के सोर्स के लिए आइडेंटिफ़ायर.

videoObject

static

(roVideo या अमान्य)

वीडियो ऑब्जेक्ट (जैसे वीडियो roSGNode) क्लाइंट ऐप पर वीडियो प्लेबैक के लिए ज़िम्मेदार है. इस ऑब्जेक्ट को लाइव HLS ID3 इवेंट्स के सही समय निर्धारण के लिए विभिन्न डेटा के लिए पोल किया जाएगा.

videoStitcherSessionOptions

static

V की सरणी

सेशन के विकल्पों का इस्तेमाल, VideoStitcher streamRequests के लिए VideoStitcher से जुड़े खास पैरामीटर सेट करने के लिए किया जाता है.

तरीके

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) ima.StreamRequest लौटाता है

लाइव StreamRequest के आवश्यक गुणों को आरंभ करता है. इस API का उपयोग करने से किसी भी अन्य StreamType-विशिष्ट प्रॉपर्टी को अनदेखा कर दिया जाएगा. यदि कोई आवश्यक पैरामीटर रिक्त स्ट्रिंग हैं, तो त्रुटि लॉगिंग होती है और API एक सामान्य StreamRequest लौटाता है, जिसमें किसी भी गुण को अनदेखा नहीं किया जाता है.

पैरामीटर
assetKey	स्ट्रिंग
apiKey	स्ट्रिंग लौटाए गए ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी को निर्दिष्ट पैरामीटर. यदि कोई API कुंजी मौजूद नहीं है, तो एक रिक्त स्ट्रिंग पास करें.
networkCode	स्ट्रिंग स्ट्रीम का अनुरोध करने वाले पब्लिशर के लिए नेटवर्क कोड. नेटवर्क कोड शामिल करना ज़रूरी नहीं है, लेकिन हमारा सुझाव है कि आप ऐसा करें.

रिटर्न

ima.StreamRequest ima.StreamRequest ऑब्जेक्ट, जिसमें लाइव ऑब्जेक्ट की ज़रूरी प्रॉपर्टी मौजूद हों.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) returns StreamRequest

पॉड लाइव ima.StreamRequest के आवश्यक गुणों को आरंभ करता है. इस एपीआई का इस्तेमाल करने पर, ima.StreamType से जुड़ी किसी भी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर कोई ज़रूरी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉगिंग होती है. साथ ही, एपीआई सामान्य StreamRequest दिखाता है. इसमें किसी भी प्रॉपर्टी को अनदेखा नहीं किया जाता.

पैरामीटर
customAssetKey	स्ट्रिंग
networkCode	स्ट्रिंग
apiKey	स्ट्रिंग लौटाए गए ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी को असाइन किया गया वैकल्पिक पैरामीटर; डिफ़ॉल्ट रूप से खाली स्ट्रिंग होता है.

रिटर्न

StreamRequest ima.StreamRequest ऑब्जेक्ट, जिसमें PodLive की ज़रूरी प्रॉपर्टी मौजूद हों.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) returns StreamRequest

किसी तृतीय पक्ष वीडियो स्टिचर के साथ DAI पॉड सेवा का उपयोग करते समय VOD स्ट्रीम पंजीकृत करने के लिए ima.StreamRequest के आवश्यक गुणों को आरंभ करता है. यह फ़ंक्शन, अनुरोध के टाइप को ima.StreamType.POD_VOD पर सेट करता है. साथ ही, यह उन सभी ज़रूरी प्रॉपर्टी की पुष्टि करता है जिनमें डेटा मौजूद नहीं है. पुष्टि न होने पर, डीबग कंसोल में गड़बड़ी लॉग की जाएगी.

पैरामीटर
networkCode	स्ट्रिंग Google Ad Manager नेटवर्क कोड

रिटर्न

StreamRequest एक ima.StreamRequest ऑब्जेक्ट. यदि सभी आवश्यक गुण निर्दिष्ट हैं, तो अनुरोध प्रकार ima.StreamType.POD_VOD पर सेट किया जाता है.

createStreamRequest

static

createStreamRequest() ima.StreamRequest दिखाता है

रिटर्न

ima.StreamRequest एक खाली ima.StreamRequest ऑब्जेक्ट.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) ima.StreamRequest लौटाता है

यह Video Stitcher Live StreamRequest की ज़रूरी प्रॉपर्टी शुरू करता है. इस API का उपयोग करने से किसी भी अन्य StreamType-विशिष्ट प्रॉपर्टी को अनदेखा कर दिया जाएगा. यदि कोई आवश्यक पैरामीटर रिक्त स्ट्रिंग हैं, तो त्रुटि लॉगिंग होती है और API एक सामान्य StreamRequest लौटाता है, जिसमें किसी भी गुण को अनदेखा नहीं किया जाता है.

पैरामीटर
customAssetKey	स्ट्रिंग
networkCode	स्ट्रिंग
liveConfigId	स्ट्रिंग
प्रांत	स्ट्रिंग
projectNumber	स्ट्रिंग
oAuthToken	स्ट्रिंग

रिटर्न

ima.StreamRequest ima.StreamRequest ऑब्जेक्ट, जिसमें VideoStitcherLive की ज़रूरी प्रॉपर्टी शामिल हों.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) returns ima.StreamRequest

यह Video Stitcher VOD StreamRequest की ज़रूरी प्रॉपर्टी को शुरू करता है. इस एपीआई का इस्तेमाल करने पर, StreamType से जुड़ी किसी भी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर ज़रूरी पैरामीटर में से कोई भी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉगिंग होती है. साथ ही, एपीआई सामान्य StreamRequest दिखाता है. इसमें किसी भी प्रॉपर्टी को अनदेखा नहीं किया जाता.

पैरामीटर
adTagUrl	स्ट्रिंग
networkCode	स्ट्रिंग
contentSourceUrl	स्ट्रिंग
प्रांत	स्ट्रिंग
projectNumber	स्ट्रिंग
oAuthToken	स्ट्रिंग

रिटर्न

ima.StreamRequest ima.StreamRequest ऑब्जेक्ट, जिसमें VideoStitcherVod की ज़रूरी प्रॉपर्टी शामिल हों.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) returns ima.StreamRequest

यह फ़ंक्शन, Video Stitcher VOD की ज़रूरी प्रॉपर्टी को शुरू करता है. इसके लिए, यह StreamRequest का इस्तेमाल करता है. इसे क्लाउड वीडियो स्टिचिंग की सुविधा से बनाया गया है.vodConfigId इस एपीआई का इस्तेमाल करने पर, StreamType से जुड़ी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर ज़रूरी पैरामीटर में से कोई भी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉगिंग होती है. साथ ही, एपीआई सामान्य StreamRequest दिखाता है. इसमें किसी भी प्रॉपर्टी को अनदेखा नहीं किया जाता.

पैरामीटर
vodConfigId	स्ट्रिंग
networkCode	स्ट्रिंग
प्रांत	स्ट्रिंग
projectNumber	स्ट्रिंग
oAuthToken	स्ट्रिंग

रिटर्न

ima.StreamRequest ima.StreamRequest ऑब्जेक्ट, जिसमें VideoStitcherVod की ज़रूरी प्रॉपर्टी शामिल हों.

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) returns ima.StreamRequest

यह फ़ंक्शन, वीओडी ima.StreamRequest की ज़रूरी प्रॉपर्टी को शुरू करता है. इस एपीआई का इस्तेमाल करने पर, ima.StreamType से जुड़ी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर ज़रूरी पैरामीटर में से कोई भी पैरामीटर खाली स्ट्रिंग है, तो गड़बड़ी लॉगिंग होती है. साथ ही, एपीआई सामान्य StreamRequest दिखाता है. इसमें किसी भी प्रॉपर्टी को अनदेखा नहीं किया जाता.

पैरामीटर
contentSourceId	स्ट्रिंग
videoId	स्ट्रिंग
apiKey	स्ट्रिंग लौटाए गए ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी को निर्दिष्ट पैरामीटर. यदि कोई API कुंजी मौजूद नहीं है, तो एक रिक्त स्ट्रिंग पास करें.
networkCode	स्ट्रिंग स्ट्रीम का अनुरोध करने वाले पब्लिशर के लिए नेटवर्क कोड. नेटवर्क कोड शामिल करना ज़रूरी नहीं है, लेकिन हमारा सुझाव है कि आप ऐसा करें.

रिटर्न

ima.StreamRequest ima.StreamRequest ऑब्जेक्ट, जिसमें वीओडी की ज़रूरी प्रॉपर्टी शामिल हों.