adConfig

הקריאה adConfig() מעבירה את ההגדרה הנוכחית של המשחק אל Ad Placement API. ה-API של מיקום המודעה יכול להשתמש בנתונים האלה כדי לשפר את האופן שבו הוא טוען מראש מודעות, ולסנן את סוגי המודעות שהוא מבקש כדי שהן יתאימו (למשל, מודעות וידאו שנדרש בהן אודיו).

חתימת הפונקציה:

adConfig({
   preloadAdBreaks: 'on|auto',  // Ad preloading strategy
   sound: 'on|off'              // This game has sound
   onReady: () => {},           // Called when API has initialised and adBreak() is ready
});

פרמטרים של adConfig

שם סוג תיאור
sound מחרוזת (אופציונלי) אם המשחק משמיע כרגע צליל. ערכים:
- on (ברירת מחדל)
- off
הקריאה הזו מציינת אם המשחק יכול להשמיע צלילים, ואם הצלילים הופעלו (כלומר, ההשתקה בוטלה) לפני הקריאה אל adBreak(). הפונקציה הזו עוזרת ל-Ad Placement API לבחור את סוג המודעה המתאים למשחק.
צריך להפעיל את הפונקציה הזו ברגע שמצב הסאונד של המשחק משתנה, כי יכול להיות ש-Ad Placement API יצטרך לבקש קריאייטיבים חדשים, והפעלת הפונקציה מוקדם ככל האפשר תיתן לו את הזמן המקסימלי לעשות זאת.

ערך ברירת המחדל הוא 'סאונד מופעל'. לכן, רוב המשחקים יצטרכו לבצע קריאה אל adConfig() כשהם מתחילים להצהיר שהם מפעילים את האודיו.
preloadAdBreaks מחרוזת (אופציונלי) האם המודעות צריכות להיטען מראש תמיד לפני הקריאה הראשונה אל adBreak(). ערכים:
- on
- auto (ברירת מחדל)

ערך ברירת המחדל auto מאפשר ל-Ad Placement API לקבוע את ההחלטה. אפשר להגדיר את preloadAdBreaks רק פעם אחת עם adConfig(), וערכים נוספים שמועברים אל preloadAdBreaks לא משפיעים.
להגדרה של preloadAdBreaks אחרי הקריאה הראשונה אל adBreak() אין השפעה.
onReady מחרוזת (אופציונלי) מופעל כשה-API מאותחל וסיים את הטעינה מראש של המודעות (אם ביקשתם טעינה מראש באמצעות preloadAdBreaks למעלה).