کلاس: ImaSdkSettings

گوگل ایما . ImaSdkSettings

کلاس عمومی استاتیک

این کلاس شامل تنظیمات گسترده SDK است.

شمارش ها

CompanionBackfillMode

ثابت ثابت

رشته

مجموعه ای از ثابت ها را برای تنظیم backfill همراه تعریف می کند. این تنظیم نشان می دهد که آیا همراهان باید در سناریوهای مختلف پر شوند یا خیر.

اگر مقدار ALWAYS باشد، پر کردن همراه در همه موقعیت‌ها انجام می‌شود، حتی زمانی که هیچ آگهی اصلی بازگردانده نشده باشد.

اگر مقدار ON_MASTER_AD باشد، اگر آگهی اصلی با تعداد همراهان کمتر از اسلات‌های همراه وجود داشته باشد، تکمیل مجدد همراه انجام می‌شود. همراهان مفقود شده پر خواهند شد.

مقدار پیش فرض ALWAYS است.

توجه داشته باشید که پر کردن پشتیبان همراه سمت سرویس گیرنده نیاز به برچسب گذاری صحیح همراهان خود با یک برچسب ناشر Google (GPT) دارد. برای فعال کردن Backfill، تغییرات زیر در راه‌اندازی استاندارد 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();

ارزش
همیشه
ON_MASTER_AD

حالت Vpaid

ثابت ثابت

عدد

مجموعه ای از ثابت ها برای فعال کردن عملکرد VPAID.

ارزش
معلول	تبلیغات VPAID پخش نمی شود و خطا برگردانده می شود.
فعال شد	تبلیغات VPAID با استفاده از iframe متقابل دامنه فعال می شوند. تبلیغ VPAID نمی تواند به سایت دسترسی پیدا کند. تبلیغات VPAID که به دسترسی دوستانه iframe وابسته هستند ممکن است دچار خطا شوند. این پیش فرض است.
ناامن	تبلیغات VPAID با استفاده از یک iframe دوستانه فعال می شوند. این اجازه می دهد تا آگهی از طریق جاوا اسکریپت به سایت دسترسی پیدا کند.

خواص

CompanionBackfillMode

ثابت ثابت

رشته

مجموعه ای از ثابت ها را برای تنظیم backfill همراه تعریف می کند. این تنظیم نشان می دهد که آیا همراهان باید در سناریوهای مختلف پر شوند یا خیر.

اگر مقدار ALWAYS باشد، پر کردن همراه در همه موقعیت‌ها انجام می‌شود، حتی زمانی که هیچ آگهی اصلی بازگردانده نشده باشد.

اگر مقدار ON_MASTER_AD باشد، اگر آگهی اصلی با تعداد همراهان کمتر از اسلات‌های همراه وجود داشته باشد، تکمیل مجدد همراه انجام می‌شود. همراهان مفقود شده پر خواهند شد.

مقدار پیش فرض ALWAYS است.

توجه داشته باشید که پر کردن پشتیبان همراه سمت سرویس گیرنده نیاز به برچسب گذاری صحیح همراهان خود با یک برچسب ناشر Google (GPT) دارد. برای فعال کردن Backfill، تغییرات زیر در راه‌اندازی استاندارد 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();

ارزش
همیشه
ON_MASTER_AD

حالت Vpaid

ثابت ثابت

عدد

مجموعه ای از ثابت ها برای فعال کردن عملکرد VPAID.

ارزش
معلول	تبلیغات VPAID پخش نمی شود و خطا برگردانده می شود.
فعال شد	تبلیغات VPAID با استفاده از iframe متقابل دامنه فعال می شوند. تبلیغ VPAID نمی تواند به سایت دسترسی پیدا کند. تبلیغات VPAID که به دسترسی دوستانه iframe وابسته هستند ممکن است دچار خطا شوند. این پیش فرض است.
ناامن	تبلیغات VPAID با استفاده از یک iframe دوستانه فعال می شوند. این اجازه می دهد تا آگهی از طریق جاوا اسکریپت به سایت دسترسی پیدا کند.

مواد و روش ها

getCompanionBackfill

getCompanionBackfill() CompanionBackfillMode را برمی گرداند

حالت پس‌پر کردن همراه فعلی را برمی‌گرداند.

برمی گرداند

non-null CompanionBackfillMode مقدار فعلی.

getDisableCustomPlaybackForIOS10Plus

getDisableCustomPlaybackForIOS10Plus() بولی را برمی گرداند

دریافت می‌کند پخش سفارشی در مرورگرهای iOS 10 و بالاتر غیرفعال شود یا خیر. مقدار پیش فرض غلط است.

برمی گرداند

boolean

getFeatureFlags

getFeatureFlags() Object را با هر نوع خاصیت برمی گرداند

یک شی را با کلیدها به عنوان پرچم های ویژگی و مقادیر را به عنوان وضعیت فعلی آنها برمی گرداند.

برمی گرداند

non-null Object with any type properties

getLocale

getLocale() رشته را برمی گرداند

منطقه ارائه‌شده ناشر را برمی‌گرداند.

برمی گرداند

string Publisher محلی را ارائه کرده است.

getNumRedirects

getNumRedirects() عدد را برمی گرداند

حداکثر تعداد تغییر مسیرها را برای تغییر مسیرهای بعدی برمی گرداند رد خواهد شد.

برمی گرداند

number حداکثر تعداد تغییر مسیرها.

getPlayerType

getPlayerType() رشته را برمی گرداند

نوع پخش کننده ارائه شده توسط شریک را برمی گرداند.

برمی گرداند

نوع پخش کننده شریک string .

getPlayerVersion

getPlayerVersion() رشته را برمی گرداند

نسخه پخش کننده ارائه شده توسط شریک را برمی گرداند.

برمی گرداند

نسخه پخش کننده شریک string .

getPpid

getPpid() برمی گرداند (تهی یا رشته ای)

شناسه ارائه شده ناشر را برمی گرداند.

برمی گرداند

(null or string) ناشر شناسه ارائه شده است.

isCookiesEnabled است

isCookiesEnabled() بولی را برمی گرداند

برمی گرداند

boolean آیا ناشر اجازه استفاده از کوکی ها را می دهد.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) باطل برمی گرداند

تنظیم می‌کند که آیا VMAP و قوانین تبلیغات، وقفه‌های تبلیغاتی به‌طور خودکار پخش شوند یا خیر

پارامتر
autoPlayAdBreaks	بولی پخش خودکار وقفه های تبلیغاتی.

برمی گرداند

void

setCompanionBackfill

setCompanionBackfill(mode) void را برمی گرداند

حالت پر کردن همراه را تنظیم می کند. حالت های مختلف موجود در ImaSdkSettings.CompanionBackfillMode را ببینید.

حالت پیش فرض ImaSdkSettings.CompanionBackfillMode.ALWAYS است.

پارامتر
حالت	CompanionBackfillMode حالت پر کردن همراه انتخاب شده. مقدار نباید صفر باشد.

برمی گرداند

void

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) باطل را برمی گرداند

آیا SDK باید یک کوکی Google Ad Manager (کوکی GFP) را در دامنه ناشر به عنوان یک کوکی شخص اول ذخیره کند یا خیر. این امکان تداوم بازدیدهای متعدد از یک دامنه را بدون استفاده از کوکی های شخص ثالث فراهم می کند. پیش فرض ها به درست است.

این تنظیم روی سایر کوکی‌هایی که ممکن است توسط طرف‌های دیگر یا برای مقاصد دیگر تنظیم شده باشند، تأثیری نخواهد داشت. رضایت کاربر و انصراف‌ها نیز ممکن است استفاده از کوکی‌های شخص اول را غیرفعال کند. این موارد با استفاده ناشر از یک ارائه‌دهنده مدیریت رضایت منطبق بر IAB، اگر در یک چارچوب باشد، دریافت می‌شود.

پارامتر
کوکی ها فعال است	بولی

برمی گرداند

void

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus(disable) void را برمی گرداند

تنظیم می‌کند که آیا پخش سفارشی در مرورگرهای iOS 10 و بالاتر غیرفعال شود. اگر درست باشد، اگر محتوای ویدیوی درون خطی باشد، تبلیغات به صورت درون خطی پخش خواهند شد. این تبلیغات TrueView قابل رد شدن را فعال می کند. با این حال، تبلیغ به صورت درون خطی باقی می‌ماند و از تمام صفحه اصلی iOS پشتیبانی نمی‌کند. در صورت نادرست بودن، تبلیغات در همان پخش کننده محتوای شما پخش می شود. مقدار تنظیم شده در اینجا هنگام ایجاد AdDisplayContainer برای طول عمر کانتینر استفاده می شود. مقدار پیش فرض غلط است.

پارامتر
غیر فعال کردن	بولی غیرفعال کردن پخش سفارشی یا خیر.

برمی گرداند

void

setFeatureFlags

setFeatureFlags(featureFlags) باطل را برمی گرداند

مقدار را برای هر پرچم ویژگی تنظیم کنید. این باید در اسرع وقت، قبل از درخواست تبلیغات تنظیم شود. تنظیمات تا درخواست آگهی بعدی ثابت خواهد ماند. فراخوانی مجدد این روش باعث بازنشانی پرچم‌های ویژگی برای درخواست آگهی بعدی می‌شود.

پارامتر
ویژگی پرچم ها	شی با هر نوع خاصیت مقدار نباید صفر باشد.

برمی گرداند

void

setLocale

setLocale(locale) void را برمی گرداند

محل ارائه شده توسط ناشر را تنظیم می کند. باید قبل از ایجاد AdsLoader یا AdDisplayContainer فراخوانی شود. زبان محلی برای نمایش عناصر UI زبانی را مشخص می کند. کدهای پشتیبانی شده را می توان در Localizing for Language و Locale یافت.

پارامتر
محل	رشته منطقه محلی ارائه شده توسط ناشر.

برمی گرداند

void

setNumRedirects

setNumRedirects(numRedirects) باطل برمی‌گرداند

حداکثر تعداد تغییر مسیرها را قبل از اینکه ریدایرکت های بعدی رد شوند و بار آگهی لغو شود، مشخص می کند. تعداد تغییر مسیرها مستقیماً بر تأخیر و در نتیجه تجربه کاربر تأثیر می گذارد. این مورد برای همه تبلیغات بسته بندی VAST اعمال می شود.

پارامتر
numRedirects	عدد حداکثر تعداد تغییر مسیرها

برمی گرداند

void

setPlayerType

setPlayerType(playerType) void را برمی گرداند

نوع پخش کننده ارائه شده توسط شریک را تنظیم می کند. این تنظیم باید برای تعیین نام پخش کننده ای که با SDK ادغام می شود استفاده شود. نوع پخش کننده بیشتر از 20 کاراکتر کوتاه می شود. نوع بازیکن مشخص شده باید کوتاه و منحصر به فرد باشد. این یک تنظیم اختیاری است که برای بهبود قابلیت استفاده از SDK با ردیابی انواع پخش کننده استفاده می شود.

مثال:

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

پارامتر
نوع بازیکن	رشته نوع بازیکن شریک.

برمی گرداند

void

setPlayerVersion

setPlayerVersion(playerVersion) void برمی گرداند

نسخه پخش کننده ارائه شده توسط شریک را تنظیم می کند. این تنظیم باید برای تعیین نسخه پخش کننده شریک که با SDK یکپارچه شده است استفاده شود. نسخه های پخش کننده بیشتر از 20 کاراکتر کوتاه می شوند. این یک تنظیم اختیاری است که برای بهبود قابلیت استفاده از SDK با ردیابی نسخه پخش کننده استفاده می شود.

مثال:

settings.setPlayerVersion('1.0.0');

پارامتر
بازیکن نسخه	رشته نسخه پخش کننده شریک.

برمی گرداند

void

setPpid

setPpid(ppid) void را برمی گرداند

شناسه ارائه شده ناشر را تنظیم می کند.

پارامتر
ppid	رشته ناشر شناسه ارائه کرد

برمی گرداند

void

setSessionId

setSessionId(sessionId) void را برمی گرداند

شناسه جلسه یک شناسه تصادفی موقت است. این به طور انحصاری برای دربندی فرکانس استفاده می شود. شناسه جلسه باید UUID باشد.

پارامتر
شناسه جلسه	رشته یک UUID موقت که برای محدود کردن فرکانس استفاده می‌شود.

برمی گرداند

void

setVpaidAllowed

setVpaidAllowed(allowVpaid) void برمی گرداند

منسوخ. از setVpaidMode استفاده کنید. تعیین می کند که آیا خلاقیت های VPAID مجاز هستند یا خیر.

پارامتر
allowVpaid	بولی آیا به خلاقیت های VPAID اجازه داده می شود.

برمی گرداند

void

setVpaidMode

setVpaidMode(vpaidMode) void را برمی گرداند

حالت پخش VPAID را تنظیم می کند.

پارامتر
vpaidMode	حالت Vpaid نحوه پخش تبلیغات VPAID را تنظیم می کند. حالت پیش فرض امن است. مقدار نباید صفر باشد.

برمی گرداند

void