מחלקה: ImaSdkSettings

google.ima.ImaSdkSettings

class ציבורי סטטי

לכיתה הזו יש הגדרות לכלל ה-SDK.

מיספרים

מצב CompanionBackfillMode

קבוע סטטי

מחרוזת

מגדירה קבוצה של קבועים עבור ההגדרה של מילוי חוזר נלווה. ההגדרה הזו מציינת אם צריך למלא מודעות נלוות בתרחישים שונים.

אם הערך הוא ALWAYS, יתבצע ניסיון חוזר למילוי חוסרים בכל המצבים, גם אם לא מוחזרת מודעה ראשית.

אם הערך הוא ON_MASTER_AD, המערכת תנסה למלא חוסרים של מודעות נלוות אם יש מודעה ראשית עם פחות מודעות נלוות, מאשר מיקומים של מודעות נלוות. המערכת תמלא את הפריטים הנלווים האלה.

ערך ברירת המחדל הוא ALWAYS.

לתשומת ליבכם: מילוי חוזר נלווה בצד הלקוח מחייב תיוג נלווה באמצעות תג Google Publisher (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

מצב Vpaid

קבוע סטטי

number

קבוצה של קבועים להפעלת פונקציונליות של VPAID.

ערך
מושבת	מודעות VPAID לא יוצגו ותוחזר שגיאה.
מופעלת	מודעות VPAID מופעלות באמצעות iframe חוצה-דומיינים. מודעת VPAID לא יכולה לגשת לאתר. מודעות VPAID שתלויות בגישה הידידותית ל-iframe עלולות להיתקל בשגיאות. זוהי ברירת המחדל.
לא מאובטח	מודעות VPAID מופעלות באמצעות iframe ידידותי. כך מתאפשרת למודעה גישה לאתר דרך JavaScript.

נכסים

מצב CompanionBackfillMode

קבוע סטטי

מחרוזת

מגדירה קבוצה של קבועים עבור ההגדרה של מילוי חוזר נלווה. ההגדרה הזו מציינת אם צריך למלא מודעות נלוות בתרחישים שונים.

אם הערך הוא ALWAYS, יתבצע ניסיון חוזר למילוי חוסרים בכל המצבים, גם אם לא מוחזרת מודעה ראשית.

אם הערך הוא ON_MASTER_AD, המערכת תנסה למלא חוסרים של מודעות נלוות אם יש מודעה ראשית עם פחות מודעות נלוות, מאשר מיקומים של מודעות נלוות. המערכת תמלא את הפריטים הנלווים האלה.

ערך ברירת המחדל הוא ALWAYS.

לתשומת ליבכם: מילוי חוזר נלווה בצד הלקוח מחייב תיוג נלווה באמצעות תג Google Publisher (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

מצב Vpaid

קבוע סטטי

number

קבוצה של קבועים להפעלת פונקציונליות של VPAID.

ערך
מושבת	מודעות VPAID לא יוצגו ותוחזר שגיאה.
מופעלת	מודעות VPAID מופעלות באמצעות iframe חוצה-דומיינים. מודעת VPAID לא יכולה לגשת לאתר. מודעות VPAID שתלויות בגישה הידידותית ל-iframe עלולות להיתקל בשגיאות. זוהי ברירת המחדל.
לא מאובטח	מודעות VPAID מופעלות באמצעות iframe ידידותי. כך מתאפשרת למודעה גישה לאתר דרך JavaScript.

שיטות

getCompanionBackfill

getCompanionBackfill() מחזיר CompanionBackfillMode

פונקציה זו מחזירה את מצב המילוי החוזר הנלווה.

החזרות

non-null CompanionBackfillMode הערך הנוכחי.

getDisabledCustomActivationForIOS10Plus

getDisableCustomPlayForIOS10Plus() החזרות בוליאני

ההגדרה קובעת אם להשבית הפעלה מותאמת אישית בדפדפנים עם iOS 10+. ערך ברירת המחדל הוא False.

החזרות

boolean 

getFeatureFlags

getFeatureFlags() מחזיר אובייקט עם מאפייני סוג כלשהם

מחזירה אובייקט עם מפתחות כסימונים ותכונות בתור המצב הנוכחי שלהם.

החזרות

non-null Object with any type properties 

getLocale

מחרוזת getLocale() חוזרת

פונקציה זו מחזירה את הלוקאל שצוין על ידי בעל התוכן הדיגיטלי.

החזרות

string המוציא לאור שסופק על ידי בעל התוכן הדיגיטלי.

getNumRedirects

getNumRedirects() מספר החזרות

מחזירה את המספר המקסימלי של הפניות אוטומטיות לכתובות אחרות שהמערכת תדחה.

החזרות

number המספר המקסימלי של הפניות אוטומטיות.

getPlayerType

getReturnerType() מחזירה מחרוזת

מחזירה את סוג הנגן שסופק על ידי השותף.

החזרות

string סוג הנגן השותף.

getPlayerVersion

המחרוזת של getPlayerVersion() שחוזרת

מחזירה את גרסת הנגן שסופקה על ידי השותף.

החזרות

string גרסת נגן השותף.

getPpid

getPpid() return (null או מחרוזת)

מחזירה את המזהה שסופק על ידי בעל האפליקציה.

החזרות

מזהה (null or string) שסופק על ידי בעל התוכן הדיגיטלי.

קובצי Cookie מופעלים

IscookiesEnabled() חוזר בוליאני

החזרות

boolean אם בעל האתר מאפשר שימוש בקובצי cookie.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) החזרות ללא ערך

הגדרה זו קובעת אם ההפסקות למודעות ב-VMAP ובכללי המודעות יופעלו באופן אוטומטי

פרמטר
autoPlayAdBreaks	boolean האם להפעיל אוטומטית את ההפסקות למודעות?

החזרות

void 

setCompanionBackfill

setCompanionBackfill(mode) מחזיר ריק

מגדיר את מצב המילוי החוזר הנלווה. ניתן להציג את המצבים השונים ב-ImaSdkSettings.CompanionBackfillMode.

מצב ברירת המחדל הוא ImaSdkSettings.CompanionBackfillMode.ALWAYS.

פרמטר
אמצעי תחבורה	מצב CompanionBackfillMode מצב המילוי החוזר הנלווה שנבחר. הערך לא יכול להיות ריק.

החזרות

void 

setcookiesEnabled

setCookieEnabled(cookiesEnabled) מחזיר מקום

האם על ה-SDK לאחסן קובץ cookie של Google Ad Manager (GFP) בדומיין של בעל התוכן הדיגיטלי, כקובץ cookie של הדומיין. כך אפשר לשמור על עקביות בביקורים מרובים באותו דומיין בלי להשתמש בקובצי cookie של צד שלישי. ברירת המחדל היא TRUE.

ההגדרה הזו לא תשפיע על קובצי cookie אחרים שהוגדרו על ידי גורמים אחרים או למטרות אחרות. ההסכמה או ביטול ההסכמה של המשתמשים יכולים גם להשבית את השימוש בקובצי cookie של הדומיין. ההגבלות האלה ישמשו את השימוש של בעל התוכן הדיגיטלי בספק לניהול אישורי הסכמה בהתאם ל-IAB, אם הוא באותה מסגרת.

פרמטר
קובצי Cookie מופעלים	boolean

החזרות

void 

setDisabledCustomActivationForIOS10Plus

setDisableCustomActivationForIOS10Plus(disable) return null

הגדרה זו קובעת אם להשבית הפעלה מותאמת אישית בדפדפנים עם iOS 10+. אם היא מקבלת את הערך True, המודעות יוצגו באופן רציף אם הסרטון התוכן מוצב בשורה. כך ניתן להפעיל מודעות TrueView שניתן לדלג עליהן. עם זאת, המודעה תישאר בשורה ולא תתמוך במסך מלא מקורי של iOS. כשהאפשרות מוגדרת כ-FALSE, המודעות מופעלות בנגן עם התוכן הזה. המערכת מגדירה את הערך שמוגדר כאן בזמן היצירה של מאגר AdDisplayContainer לכל משך החיים של מאגר התגים. ערך ברירת המחדל הוא False.

פרמטר
disable	boolean האם להשבית את ההפעלה המותאמת אישית.

החזרות

void 

setFeatureFlags

setFeatureFlags(featureFlags) מחזיר ריק

מגדירים את הערך של תכונות ניסיוניות. יש להגדיר זאת מוקדם ככל האפשר לפני בקשת מודעות. ההגדרות יישארו קבועות עד הבקשה הבאה להצגת מודעה. קריאה נוספת לשיטה הזו תאפס את כל הסימונים של התכונות בבקשה למודעה הבאה.

פרמטר
תכונה	אובייקט עם מאפייני סוג כלשהם הערך לא יכול להיות ריק.

החזרות

void 

setLocale

setLocale(locale) מוחזר

מגדיר את הלוקאל שסופק על ידי בעל האפליקציה. חובה לבצע קריאה לפני שיוצרים AdsLoader או AdDisplayContainer. הלוקאל מציין את השפה שבה יוצגו הרכיבים של ממשק המשתמש. אפשר למצוא את הקודים הנתמכים בהתאמה לשוק המקומי בשפה ובלוקאל.

פרמטר
לוקאל	מחרוזת לוקאל שסופק על-ידי בעל האפליקציה.

החזרות

void 

setNumRedirects

setNumRedirects(numRedirects) החזרות ללא תוכן

המדיניות מציינת את המספר המקסימלי של הפניות אוטומטיות לפני שההפניות הבאות יידחו, וטעינת המודעה תבוטל. מספר ההפניות האוטומטיות משפיע ישירות על זמן האחזור, ולכן על חוויית המשתמש. ההגדרה הזו חלה על כל המודעות מסוג VAST wrapper.

פרמטר
הפניה למספרים	number את המספר המקסימלי של הפניות אוטומטיות.

החזרות

void 

setPlayerType

setPlayerType(playerType) מחזיר ריק

מגדיר את סוג הנגן שסופק על ידי שותף. יש להשתמש בהגדרה הזו כדי לציין את שם הנגן המשולב עם ה-SDK. סוג הנגן ארוך מ-20 תווים. סוג הנגן שצוין צריך להיות קצר וייחודי. זוהי הגדרה אופציונלית המשמשת לשיפור השימוש ב-SDK על ידי מעקב אחר סוגי שחקנים.

דוגמה:

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

פרמטר
סוג נגן	מחרוזת סוג הנגן של השותף.

החזרות

void 

setPlayerVersion

setPlayerVersion(playerVersion) מחזירה ערכים ריקים

מגדיר את גרסת הנגן שסופקה על ידי השותף. יש להשתמש בהגדרה הזו כדי לציין את גרסת הנגן של השותף המשולב עם ה-SDK. גרסאות נגן באורך של יותר מ-20 תווים יקוצרו. זוהי הגדרה אופציונלית המשמשת לשיפור השימוש ב-SDK על ידי מעקב אחר גרסת הנגן.

דוגמה:

settings.setPlayerVersion('1.0.0');

פרמטר
גרסה של Player	מחרוזת הגרסה של נגן השותף.

החזרות

void 

setPidid

setPpid(ppid) מחזיר ריק

מגדיר את המזהה שסופק על ידי בעל האפליקציה.

פרמטר
ppi	מחרוזת המזהה שסופק על ידי בעל התוכן הדיגיטלי.

החזרות

void 

setSessionId

setSessionId(sessionId) מוחזר ללא ערך

מזהה סשן הוא מזהה אקראי זמני. הוא משמש אך ורק להגדרת מכסת תדירות. מזהה סשן חייב להיות UUID.

פרמטר
סשן – מזהה	מחרוזת UUID זמני המשמש למכסת תדירות.

החזרות

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) החזרות ללא ערך

הוּצא משימוש. שימוש ב-setVpaidMode. ההגדרה הזאת קובעת אם מותר להשתמש בקריאייטיבים מסוג VPAID.

פרמטר
allowVpaid	boolean האם לאפשר קריאייטיבים של VPAID.

החזרות

void 

setVpaidMode

setVpaidMode(vpaidMode) מחזיר ריק

הגדרת מצב הפעלה של VPAID.

פרמטר
vpaidMode	מצב Vpaid הגדרה של אופן ההפעלה של מודעות VPAID. ברירת המחדל היא מצב מאובטח. הערך לא יכול להיות ריק.

החזרות

void