الفئة: إعدادات ImaSdk

google.ima.ImaSdkSettings

class علني static

يحتوي هذا الصف على إعدادات على مستوى حزمة تطوير البرامج (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();

القيمة
دومًا
ON_MASTER_AD

وضع الدفع المدفوع

ثابت ثابت

number

مجموعة من الثوابت لتمكين وظائف 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();

القيمة
دومًا
ON_MASTER_AD

وضع الدفع المدفوع

ثابت ثابت

number

مجموعة من الثوابت لتمكين وظائف VPAID.

القيمة
متوقّف	لن يتم تشغيل إعلانات VPAID وسيتم عرض خطأ.
مفعّلة	يتم تمكين إعلانات VPAID باستخدام إطار iframe عبر النطاقات. ولا يمكن لإعلان VPAID الدخول إلى الموقع. قد يحدث خطأ في إعلانات VPAID التي تعتمد على إمكانية الوصول المضمَّنة في إطار iframe. هذا هو الخيار التلقائي.
غير آمن	يتم تفعيل إعلانات VPAID باستخدام إطار iframe صديق. ويسمح هذا للإعلان بالوصول إلى الموقع الإلكتروني من خلال JavaScript.

الطُرق

getCompanionBackfill

getCompanionBackfill() يعرض CompanionBackfillMode

لعرض وضع إعادة التعبئة المصاحب الحالي.

المرتجعات

non-null CompanionBackfillMode القيمة الحالية.

getDisableCustomالتشغيلForIOS10Plus

getDisableCustomالتشغيلForIOS10Plus() يعرض القيمة المنطقية

يمكنك تحديد ما إذا كنت تريد إيقاف التشغيل المخصّص على متصفّحات iOS 10 والإصدارات الأحدث. القيمة الافتراضية هي false.

المرتجعات

boolean 

الحصول على علامات الميزات

تعرض getFeatureFlags() كائنًا مع أي نوع من الخصائص

لعرض عنصر به مفاتيح كعلامات وعلامات للقيم كحالتها الحالية.

المرتجعات

non-null Object with any type properties 

الدليل المحلي

تعرض getLocale() سلسلة

لعرض اللغة التي يوفرها الناشر.

المرتجعات

string اللغة التي يقدّمها الناشر

getNumRedirects

getNumRedirects() تعرض رقمًا

لعرض الحد الأقصى لعدد عمليات إعادة التوجيه لعمليات إعادة التوجيه اللاحقة.

المرتجعات

number الحد الأقصى لعدد عمليات إعادة التوجيه.

getPlayerType

تعرض الدالة getPlayerType() سلسلة

لعرض نوع المشغل الذي قدمه الشريك.

المرتجعات

string نوع مشغّل الشريك.

getPlayerVersion

تعرض getPlayerVersion() سلسلة

لعرض إصدار المشغّل الذي قدّمه الشريك.

المرتجعات

string إصدار مشغّل الشريك.

getPpid

getPpid() returns (null or string)

لعرض المعرّف الذي قدّمه الناشر.

المرتجعات

رقم التعريف الذي قدّمه الناشر (null or string)

تم تمكين ملفات تعريف الارتباط

يعرض isCookiesEnabled() قيمة منطقية

المرتجعات

boolean ما إذا كان الناشر يسمح باستخدام ملفات تعريف الارتباط.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) returns void

يحدّد ما إذا كان سيتم تشغيل فواصل إعلانات VMAP وقواعد الإعلانات تلقائيًا.

المعلمة
autoPlayAdBreaks	منطقي لتحديد ما إذا كان سيتم تشغيل الفواصل الإعلانية تلقائيًا.

المرتجعات

void 

إعادة تعبئة الإعلانات المصاحبة

setCompanionBackfill(mode) returns void

لتعيين وضع إعادة التعبئة المصاحب. يمكنك الاطّلاع على الأوضاع المتنوعة المتاحة في ImaSdkSettings.CompanionBackfillMode.

الوضع التلقائي هو ImaSdkSettings.CompanionBackfillMode.ALWAYS.

المعلمة
الوضع	وضع ملء الفراغات المصاحب وضع إعادة التعبئة المصاحب المختار. يجب ألا تكون القيمة فارغة.

المرتجعات

void 

setCookiesEnabled

setcookiesEnabled(cookiesEnabled) returns void

ما إذا كانت حزمة تطوير البرامج (SDK) يجب أن تخزِّن ملف تعريف ارتباط "مدير إعلانات Google" (GFP Cookie) على نطاق الناشر، كملف تعريف ارتباط للطرف الأول أم لا. ويتيح ذلك الثبات على عدة زيارات إلى النطاق نفسه بدون استخدام ملفات تعريف الارتباط التابعة لجهات خارجية. إعداد القيمة الافتراضية على true.

لن يؤثر هذا الإعداد في ملفات تعريف الارتباط الأخرى التي قد تحدّدها أطراف أخرى أو لأغراض أخرى. وقد تؤدي موافقة المستخدم وإيقافه أيضًا إلى إيقاف استخدام ملفات تعريف الارتباط للطرف الأول. وسيختار الناشر هذه المعلومات عند استخدام "مقدِّم خدمة إدارة الموافقة" المتوافق مع IAB، إذا كانت ضمن الإطار نفسه.

المعلمة
تمكين ملفات تعريف الارتباط	منطقي

المرتجعات

void 

setDisableCustomالتشغيلForIOS10Plus

setDisableCustomالتشغيلForIOS10Plus(disable) خالٍ من النتائج

تُحدّد ما إذا كنت تريد إيقاف التشغيل المخصّص على متصفّحات iOS 10 والإصدارات الأحدث. إذا كانت القيمة "true"، سيتم تشغيل الإعلانات بشكل مضمّن إذا كان الفيديو على شبكة المحتوى مضمّنًا. يؤدي هذا إلى تفعيل إعلانات TrueView القابلة للتخطي. ومع ذلك، سيبقى الإعلان مضمّنًا ولن يتوافق مع ملء الشاشة لنظام التشغيل iOS الأصلي. وفي حال اختيار القيمة "false"، سيتم تشغيل الإعلانات في المشغّل نفسه الذي يشغّله المحتوى. يتم استخدام القيمة التي تم ضبطها هنا عند إنشاء AdDisplayContainer طوال الفترة منذ إنشاء الحاوية. القيمة الافتراضية هي false.

المعلمة
إيقاف	منطقي لتحديد ما إذا كان سيتم تعطيل التشغيل المخصص أم لا.

المرتجعات

void 

علامات الميزات

setFeatureFlags(featureFlags) returns void

عيّن قيمة لأي علامات ميزات. ويجب ضبطها في أقرب وقت ممكن قبل طلب الإعلانات. ستظل الإعدادات ثابتة حتى طلب الإعلان التالي. سيؤدي استدعاء هذه الطريقة مرة أخرى إلى إعادة ضبط أي علامات ميزات لطلب الإعلان التالي.

المعلمة
علامات الميزات	عنصر مع أي نوع من الخصائص يجب ألا تكون القيمة فارغة.

المرتجعات

void 

الإعدادات المحلية

تُرجع الدالة setLocale(locale) إبطال

لتعيين اللغة التي يوفرها الناشر. يجب طلبه قبل إنشاء AdsLoader أو AdDisplayContainer. تحدد اللغة اللغة التي سيتم عرض عناصر واجهة المستخدم بها. ويمكن العثور على الرموز المتاحة في الترجمة إلى اللغة والموقع الجغرافي.

المعلمة
locale	سلسلة اللغة التي يوفرها الناشر.

المرتجعات

void 

setNumRedirects

setNumRedirects(numRedirects) returns void

تحدّد هذه السياسة الحد الأقصى لعدد عمليات إعادة التوجيه قبل أن يتم رفض عمليات إعادة التوجيه التالية، ويتم إيقاف تحميل الإعلان. يؤثر عدد عمليات إعادة التوجيه بشكل مباشر في وقت الاستجابة، وبالتالي على تجربة المستخدم. وينطبق هذا على جميع إعلانات تضمين VAST.

المعلمة
numRedirects	number الحد الأقصى لعدد عمليات إعادة التوجيه.

المرتجعات

void 

setPlayerType

تُرجع قيمة setseterType(playerType) قيمة خالية

لتعيين نوع المشغل الذي يوفره الشريك. ويجب استخدام هذا الإعداد لتحديد اسم المشغّل المُدمج مع حزمة تطوير البرامج (SDK). سيتم اقتطاع نوع اللاعب الذي يزيد عن 20 حرفًا. يجب أن يكون نوع المشغّل المحدّد فريدًا ومختصرًا. هذا إعداد اختياري يُستخدَم لتحسين سهولة استخدام حزمة تطوير البرامج (SDK) من خلال تتبُّع أنواع المشغّلات.

مثال:

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

المعلمة
نوع اللاعب	سلسلة نوع مشغّل الشريك.

المرتجعات

void 

setPlayerVersion

setPlayerVersion(playerVersion) يعرض باطل

لتعيين إصدار المشغل الذي قدمه الشريك. ويجب استخدام هذا الإعداد لتحديد إصدار مشغّل الشريك الذي يتم دمجه مع حزمة تطوير البرامج (SDK). سيتم اقتطاع إصدارات المشغّل التي تزيد عن 20 حرفًا. وهذا إعداد اختياري يُستخدَم لتحسين قابلية استخدام حِزمة تطوير البرامج (SDK) من خلال تتبُّع إصدار المشغّل.

مثال:

settings.setPlayerVersion('1.0.0');

المعلمة
إصدار المشغّل	سلسلة إصدار مشغّل الشريك.

المرتجعات

void 

ضبط Ppy

setPpid(ppid) returns void

لضبط المعرّف الذي قدّمه الناشر.

المعلمة
ppid	سلسلة الذي قدمه الناشر.

المرتجعات

void 

معرّف جلسة العمل

setsetId(sessionId) returns void

رقم تعريف الجلسة هو رقم تعريف عشوائي مؤقت. ويتم استخدامه حصريًا لتحديد عدد مرات الظهور. يجب أن يكون معرّف الجلسة معرّف مستخدم فريدًا (UUID).

المعلمة
رقم تعريف الجلسة	سلسلة معرّف مستخدم فريد (UUID) مستخدَم لتحديد عدد مرات الظهور.

المرتجعات

void 

setVpaidAllowed

المرتجعات setVpaidAllowed(allowVpaid) لاغية

تمّ الإيقاف. استخدام setVpaidMode لتحديد ما إذا كان يُسمح بتصميمات VPAID الإبداعية أم لا.

المعلمة
سماح	منطقي لتحديد ما إذا كان سيتم السماح بتصميمات VPAID الإبداعية أم لا.

المرتجعات

void 

setVpaidMode

setVpaidMode(vpaidMode) تُعرض فارغة

لضبط وضع تشغيل VPAID.

المعلمة
وضع vpaid	وضع الدفع المدفوع تحدّد طريقة عرض إعلانات VPAID. الوضع التلقائي هو الوضع الآمن. يجب ألا تكون القيمة فارغة.

المرتجعات

void