क्लास: ImaSdkSettings

google.ima.ImaSdkSettings

class सार्वजनिक स्टैटिक

इस कक्षा में SDK टूल के सभी वर्शन की सेटिंग शामिल हैं.

गणना

कंपैनियन बैकफ़िलमोड

लगातार स्टैटिक

स्ट्रिंग

साथ-साथ बैकफ़िल सेटिंग के लिए कॉन्सटेंट के सेट के बारे में बताता है. इस सेटिंग से यह पता चलता है कि अलग-अलग स्थितियों में, सहयोगियों को बैकफ़िल किया जाना चाहिए या नहीं.

अगर वैल्यू ALWAYS है, तो कंपेनियन बैकफ़िल को सभी स्थितियों में इस्तेमाल करने की कोशिश की जाएगी, भले ही मुख्य विज्ञापन न दिखाया गया हो.

अगर वैल्यू ON_MASTER_AD है, तो कॉन्टेंट के बैकफ़िल की कोशिश की जाएगी. ऐसा तब होगा, जब मुख्य विज्ञापन में, कंपैनियन स्लॉट की तुलना में कम विज्ञापन दिखेंगे. जो साथी मौजूद नहीं हैं उन्हें बैकफ़िल कर दिया जाएगा.

डिफ़ॉल्ट वैल्यू ALWAYS है.

ध्यान दें कि क्लाइंट-साइड साथी बैकफ़िल के लिए, आपके साथियों को Google पब्लिशर टैग (GPT) का इस्तेमाल करके, सही तरीके से टैग करना होगा. बैकफ़िल चालू करने के लिए, मानक GPT सेटअप में ये बदलाव करने ज़रूरी हैं: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
वीडियो अपने-आप चलने के लिए, हमारा सुझाव है कि साथी स्लॉट पहले से लोड न होने दें. इसके बाद, इन्हें कंपैनियन के साथ बदल दिया जाए. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

वैल्यू

हमेशा

ऑन_मास्टर_विज्ञापन

पेडमोड

लगातार स्टैटिक

संख्या

VPAID फ़ंक्शन को चालू करने के लिए कॉन्सटेंट का सेट.

वैल्यू

बंद है

VPAID विज्ञापन नहीं चलेंगे और एक गड़बड़ी दिखेगी.

चालू किया गया

VPAID विज्ञापन क्रॉस डोमेन iframe का इस्तेमाल करके चालू किए जाते हैं. VPAID विज्ञापन साइट को ऐक्सेस नहीं कर सकता. ऐसे VPAID विज्ञापन जो अनुकूल iframe ऐक्सेस पर निर्भर हैं, गड़बड़ी हो सकते हैं. यह डिफ़ॉल्ट रूप से होता है.

जानकारी नहीं है

VPAID विज्ञापन किसी अनुकूल iframe का इस्तेमाल करके चालू किए जाते हैं. इससे, JavaScript का इस्तेमाल करके, विज्ञापन को साइट का ऐक्सेस मिल जाता है.

प्रॉपर्टी

कंपैनियन बैकफ़िलमोड

लगातार स्टैटिक

स्ट्रिंग

साथ-साथ बैकफ़िल सेटिंग के लिए कॉन्सटेंट के सेट के बारे में बताता है. इस सेटिंग से यह पता चलता है कि अलग-अलग स्थितियों में, सहयोगियों को बैकफ़िल किया जाना चाहिए या नहीं.

अगर वैल्यू ALWAYS है, तो कंपेनियन बैकफ़िल को सभी स्थितियों में इस्तेमाल करने की कोशिश की जाएगी, भले ही मुख्य विज्ञापन न दिखाया गया हो.

अगर वैल्यू ON_MASTER_AD है, तो कॉन्टेंट के बैकफ़िल की कोशिश की जाएगी. ऐसा तब होगा, जब मुख्य विज्ञापन में, कंपैनियन स्लॉट की तुलना में कम विज्ञापन दिखेंगे. जो साथी मौजूद नहीं हैं उन्हें बैकफ़िल कर दिया जाएगा.

डिफ़ॉल्ट वैल्यू ALWAYS है.

ध्यान दें कि क्लाइंट-साइड साथी बैकफ़िल के लिए, आपके साथियों को Google पब्लिशर टैग (GPT) का इस्तेमाल करके, सही तरीके से टैग करना होगा. बैकफ़िल चालू करने के लिए, मानक GPT सेटअप में ये बदलाव करने ज़रूरी हैं: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
वीडियो अपने-आप चलने के लिए, हमारा सुझाव है कि साथी स्लॉट पहले से लोड न होने दें. इसके बाद, इन्हें कंपैनियन के साथ बदल दिया जाए. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

वैल्यू

हमेशा

ऑन_मास्टर_विज्ञापन

पेडमोड

लगातार स्टैटिक

संख्या

VPAID फ़ंक्शन को चालू करने के लिए कॉन्सटेंट का सेट.

वैल्यू

बंद है

VPAID विज्ञापन नहीं चलेंगे और एक गड़बड़ी दिखेगी.

चालू किया गया

VPAID विज्ञापन क्रॉस डोमेन iframe का इस्तेमाल करके चालू किए जाते हैं. VPAID विज्ञापन साइट को ऐक्सेस नहीं कर सकता. ऐसे VPAID विज्ञापन जो अनुकूल iframe ऐक्सेस पर निर्भर हैं, गड़बड़ी हो सकते हैं. यह डिफ़ॉल्ट रूप से होता है.

जानकारी नहीं है

VPAID विज्ञापन किसी अनुकूल iframe का इस्तेमाल करके चालू किए जाते हैं. इससे, JavaScript का इस्तेमाल करके, विज्ञापन को साइट का ऐक्सेस मिल जाता है.

तरीके

getCompanionबैकफ़िल

getCompanionBackfill() कंपैनियन के लिए बैकफ़िलमोड

मौजूदा साथी बैकफ़िल मोड दिखाता है.

एक्सप्रेशन से मिलने वाला नतीजा

non-null CompanionBackfillMode मौजूदा वैल्यू.

कस्टमप्लेबैकForIOS10 अक्षम करें

getDisabledCustomPlaybackForIOS10Plus() बूलियन को वापस लौटाता है

यह पाएं कि iOS 10 के बाद वाले वर्शन पर, पसंद के मुताबिक वीडियो चलाने की सुविधा बंद करनी है या नहीं. डिफ़ॉल्ट वैल्यू गलत होती है.

एक्सप्रेशन से मिलने वाला नतीजा

boolean 

getFeatureFlags पाएं

getFeatureFlags() किसी भी तरह की प्रॉपर्टी के साथ ऑब्जेक्ट दिखाता है

एक ऑब्जेक्ट को उनकी मौजूदा स्थिति के तौर पर दिखाता है, जिसमें फ़ीचर फ़्लैग और वैल्यू होती हैं.

एक्सप्रेशन से मिलने वाला नतीजा

non-null Object with any type properties 

getLocale

getLocale() स्ट्रिंग दिखाता है

पब्लिशर की दी गई स्थान-भाषा दिखाता है.

एक्सप्रेशन से मिलने वाला नतीजा

string पब्लिशर ने स्थान-भाषा दी.

getNumredirects

getNumredirects() रिटर्न नंबर

इससे, बार-बार होने वाले रीडायरेक्ट को स्वीकार नहीं किया जाएगा.

एक्सप्रेशन से मिलने वाला नतीजा

number रीडायरेक्ट की ज़्यादा से ज़्यादा संख्या.

getPlayerType

getPlayerType() वापस लौटाने वाली स्ट्रिंग

पार्टनर का दिया गया प्लेयर टाइप दिखाता है.

एक्सप्रेशन से मिलने वाला नतीजा

string पार्टनर प्लेयर टाइप.

getPlayerVersion

getPlayerVersion() स्ट्रिंग लौटाता है

पार्टनर का दिया गया प्लेयर वर्शन दिखाता है.

एक्सप्रेशन से मिलने वाला नतीजा

string पार्टनर प्लेयर वर्शन.

getPpid

getPpid() रिटर्न (शून्य या स्ट्रिंग)

पब्लिशर का दिया गया आईडी दिखाता है.

एक्सप्रेशन से मिलने वाला नतीजा

(null or string) पब्लिशर का आईडी.

isकुकी सक्षम है

isकुकीEnabled()() बूलियन दिखाता है

एक्सप्रेशन से मिलने वाला नतीजा

boolean पब्लिशर, कुकी का इस्तेमाल कर सकता है या नहीं.

AutoPlayAdBreaks सेट करें

setAutoPlayBreaks(autoPlayAdBreaks) का सेट शून्य

सेट करें कि विज्ञापन के ब्रेक और विज्ञापन के लिए ब्रेक के दौरान, विज्ञापन के लिए ब्रेक की सुविधा अपने-आप चालू हो

पैरामीटर

ऑटोप्लेविज्ञापन ब्रेक

बूलियन

क्या विज्ञापन के लिए ब्रेक अपने-आप चले.
एक्सप्रेशन से मिलने वाला नतीजा

void 

सेट-कंपैनियनबैकफ़िल

setCompanionBackfill(mode) पर शून्य वैल्यू सेट की जाती है

साथी बैकफ़िल मोड सेट करता है. ImaSdkSettings.CompanionBackfillMode में उपलब्ध कई मोड देखें.

डिफ़ॉल्ट मोड ImaSdkSettings.CompanionBackfillMode.ALWAYS है.

पैरामीटर

मोड

कंपैनियन बैकफ़िलमोड

चुना गया साथी बैकफ़िल मोड.

वैल्यू शून्य नहीं होनी चाहिए.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setcookiesचालू है

setcookiesEnabled(कुकी के चालू होने की वजह से) वैल्यू वापस आने पर

SDK टूल को, प्रकाशक के डोमेन पर Google Ad Manager कुकी (जीएफ़पी कुकी) को, पहले पक्ष की कुकी के तौर पर स्टोर करना चाहिए या नहीं. इससे एक ही डोमेन के लिए, तीसरे पक्ष की कुकी का इस्तेमाल किए बिना, एक से ज़्यादा साइटों पर लगातार आने की सुविधा चालू हो जाती है. डिफ़ॉल्ट वैल्यू 'सही' पर सेट होती है.

इस सेटिंग का असर उन दूसरी कुकी पर नहीं पड़ता जिन्हें दूसरे पक्ष सेट कर सकते हैं या किसी दूसरे मकसद से सेट किया जा सकता है. उपयोगकर्ता की सहमति और ऑप्ट-आउट करने से, पहले-पक्ष की कुकी का इस्तेमाल भी बंद हो सकता है. इन्हें प्रकाशक के इस्तेमाल के आधार पर चुना जाएगा. हालांकि, इसके लिए ज़रूरी है कि पब्लिशर, IAB के मुताबिक सहमति देने वाली सेवा देने वाली कंपनी का इस्तेमाल करे, अगर वह उसी फ़्रेम में हो.

पैरामीटर

कुकी चालू की गईं

बूलियन
एक्सप्रेशन से मिलने वाला नतीजा

void 

CustomPlaybackForIOS10 को बंद करें

setAllowCustomPlaybackForIOS10Plus(cancel) वापस लेने की वैल्यू अमान्य है

इस नीति से यह सेट होता है कि iOS 10 या उसके बाद के वर्शन वाले ब्राउज़र पर, पसंद के मुताबिक वीडियो चलाने की सुविधा बंद करनी है या नहीं. अगर सही है, तो कॉन्टेंट का वीडियो इनलाइन होने पर, विज्ञापन इनलाइन दिखेंगे. यह TrueView स्किप किए जा सकने वाले विज्ञापनों को चालू करता है. हालांकि, विज्ञापन इनलाइन रहेगा और iOS के नेटिव फ़ुलस्क्रीन में काम नहीं करेगा. गलत होने पर, विज्ञापन उसी प्लेयर में चलेंगे जिसमें आपका कॉन्टेंट चलता है. यहां दिए गए मान का इस्तेमाल विज्ञापन डिसप्ले कंटेनर बनाते समय, कंटेनर की अवधि के लिए किया जाता है. डिफ़ॉल्ट वैल्यू गलत होती है.

पैरामीटर

बंद करो

बूलियन

वीडियो को पसंद के मुताबिक चलाने की सुविधा को बंद करना है या नहीं.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setFeatureFlags को सेट करें

setFeatureFlags(featureFlags) का कोड शून्य दिखता है

फ़ीचर फ़्लैग के लिए कोई वैल्यू सेट करें. विज्ञापनों का अनुरोध करने से पहले, इसे जल्द से जल्द सेट कर देना चाहिए. जब तक अगले विज्ञापन अनुरोध की सेटिंग लागू नहीं हो जाती, तब तक सेटिंग पहले जैसी ही रहेगी. इस तरीके से दोबारा कॉल करने पर, अगले विज्ञापन अनुरोध के लिए फ़ीचर फ़्लैग रीसेट हो जाएंगे.

पैरामीटर

फ़ीचर फ़्लैग

किसी भी तरह की प्रॉपर्टी वाला ऑब्जेक्ट

वैल्यू शून्य नहीं होनी चाहिए.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setLocale

setLocale(local) की वापसी

पब्लिशर की दी हुई स्थान-भाषा को सेट करता है. AdsLoader या AdDisplayContainer बनाने से पहले, इसे कॉल करना ज़रूरी है. स्थान-भाषा से उस भाषा के बारे में पता चलता है जिसमें यूज़र इंटरफ़ेस (यूआई) एलिमेंट दिखाए जाते हैं. इस्तेमाल किए जा सकने वाले कोड, भाषा और स्थान-भाषा के लिए स्थानीय भाषा में लिखें में देखे जा सकते हैं.

पैरामीटर

स्थान-भाषा

स्ट्रिंग

पब्लिशर की दी गई स्थान-भाषा.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setNumredirects

setNumredirects(numredirects) रिटर्न शून्य

इससे पता चलता है कि बाद के रीडायरेक्ट के अस्वीकार होने से पहले, रीडायरेक्ट की ज़्यादा से ज़्यादा संख्या क्या होगी. साथ ही, इससे विज्ञापन लोड करने की प्रोसेस रद्द हो जाती है. रीडायरेक्ट की संख्या का सीधे तौर पर यह पता चलता है कि इंतज़ार का समय कितना है. इससे उपयोगकर्ता अनुभव पर भी असर पड़ता है. यह सभी VAST रैपर विज्ञापनों पर लागू होता है.

पैरामीटर

numredirects

संख्या

रीडायरेक्ट की ज़्यादा से ज़्यादा संख्या.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setPlayerType

setPlayerType(playerType) शून्य हो जाता है

पार्टनर का दिया गया प्लेयर टाइप सेट करें. इस सेटिंग का इस्तेमाल, उस प्लेयर का नाम बताने के लिए किया जाना चाहिए जिसे SDK टूल के साथ इंटिग्रेट किया जा रहा है. प्लेयर टाइप में 20 से ज़्यादा वर्ण छोटे कर दिए जाएंगे. प्लेयर का टाइप छोटा और खास होना चाहिए. यह एक वैकल्पिक सेटिंग है. इसका इस्तेमाल प्लेयर के टाइप को ट्रैक करके, SDK टूल के इस्तेमाल को बेहतर बनाने के लिए किया जाता है.

उदाहरण: 


settings.setPlayerType('google/gmf-player');

पैरामीटर

प्लेयर का प्रकार

स्ट्रिंग

पार्टनर प्लेयर का टाइप.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setPlayerVersion

setPlayerVersion(playerVersion) शून्य लगाता है

पार्टनर का दिया गया प्लेयर वर्शन सेट करें. इस सेटिंग का इस्तेमाल, पार्टनर प्लेयर के उस वर्शन के बारे में बताने के लिए किया जाना चाहिए जिसे SDK टूल के साथ इंटिग्रेट किया गया है. 20 वर्णों से ज़्यादा वाले प्लेयर वर्शन छोटे कर दिए जाएंगे. यह एक वैकल्पिक सेटिंग है. इसका इस्तेमाल प्लेयर के वर्शन को ट्रैक करके, SDK टूल के इस्तेमाल को बेहतर बनाने के लिए किया जाता है.

उदाहरण: 


settings.setPlayerVersion('1.0.0');

पैरामीटर

प्लेयर वर्शन

स्ट्रिंग

पार्टनर प्लेयर का वर्शन.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setPpid

setPpid(ppid) वापस आने पर कोई वैल्यू नहीं दिखेगी

पब्लिशर का दिया गया आईडी सेट करता है.

पैरामीटर

पीआईडी

स्ट्रिंग

पब्लिशर का आईडी.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setSessionId

setSessionId(sessionId) रिटर्न शून्य

सेशन आईडी, कुछ समय के लिए एक आईडी है. इसे खास तौर पर फ़्रीक्वेंसी कैपिंग के लिए इस्तेमाल किया जाता है. सेशन आईडी एक UUID होना चाहिए.

पैरामीटर

सेशन का आईडी

स्ट्रिंग

फ़्रीक्वेंसी कैपिंग के लिए इस्तेमाल होने वाला अस्थायी UUID.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) का रिटर्न अमान्य है

समर्थन नहीं होना या रुकना. setVpaidMode का इस्तेमाल करें. सेट करता है कि VPAID क्रिएटिव की अनुमति है या नहीं.

पैरामीटर

allowVpaid

बूलियन

VPAID क्रिएटिव को अनुमति देनी है या नहीं.
एक्सप्रेशन से मिलने वाला नतीजा

void 

setVpaidMode

setVpaidMode(vpaidMode) की वैल्यू शून्य होती है

VPAID प्लेबैक मोड सेट करता है.

पैरामीटर

vpaidMode

पेडमोड

यह सेट करता है कि VPAID विज्ञापन कैसे चलेंगे. सुरक्षित मोड डिफ़ॉल्ट है.

वैल्यू शून्य नहीं होनी चाहिए.
एक्सप्रेशन से मिलने वाला नतीजा

void