מחלקה: AdsManager

google.ima.AdsManager

class סטטי

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

שיטות

כיווץ

כיווץ()

כיווץ המודעה הנוכחית. זו לא פעולה מכוונת ב-HTML5 SDK.

הגדרת AdsManager

configAdsManager(content, adsRenderingSettings)

מגדיר את הפרמטרים הנדרשים לקבלת הפניה ל-Ad Manager הזה מהאירוע AdsManagerLoaded.

פרמטר
content	אובייקט אובייקט שמפעיל את התוכן של בעל האתר. הערך לא יכול להיות ריק.
מודעותRenderingSettings	אופציונלי הגדרות לעיבוד מודעות הגדרות אופציונליות לשליטה ברינדור המודעות. הערך עשוי להיות null.

כיבוי סופי

מחיקה סופית(

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

DeleteAdBreak

deleteAdBreak()

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

הרחבה

הרחבה()

מרחיבים את המודעה הנוכחית. זו לא פעולה מכוונת ב-HTML5 SDK.

מיקוד

Focus()

התמקדות בלחצן הדילוג, אם קיים. אם לא מוצגים, התמקדות היא ברכיבים אינטראקטיביים, כולל סמלים או קריאייטיבים אינטראקטיביים.

getAdSkippableState

getAdSkippableState() מחזיר בוליאני

פונקציה זו מחזירה את הערך true אם ניתן לדלג על המודעה כעת. כשהערך הזה משתנה, AdsManager מפעיל אירוע AdEvent.SKIPPABLE_STATE_CHANGED.

החזרות

boolean True אם לא ניתן כרגע לדלג על המודעה, אז הערך False.

getCuePoints

getCuePoints() מחזירה מערך של

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

החזרות

non-null Array of number קו זמן בשניות.

get{/2}Time

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

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

החזרות

number מחזיר את הזמן שנותר למודעה הנוכחית. אם הזמן שנותר לא מוגדר למודעה הנוכחית (למשל, מודעות מותאמות אישית), הערך יחזיר 1-.

getVolume

getVolume() מחזירה מספר

להורדת עוצמת הקול של המודעה הנוכחית.

החזרות

number הנפח של המודעה הנוכחית, מ-0 (מושתקת) עד 1 (גבוהה).

Init

init(width, height, viewMode, videoElement)

הפעל אותו כדי להפעיל את חוויית הצופה במודעה במנהל המודעות.

פרמטר
רוחב	number הרוחב שנבחר של המודעה.
גובה	number הגובה שנבחר למודעה.
מצב תצוגה	מצב תצוגה מצב התצוגה שנבחר. הערך לא יכול להיות ריק.
רכיב וידאו	אופציונלי רכיב HTMLVideo רכיב וידאו להפעלה מותאמת אישית. רכיב הווידאו הזה מבטל את הרכיב שסופק בבנאי AdDisplayContainer. מומלץ להשתמש בנכס הזה רק אם זה ממש חובה. אחרת, מומלץ לציין את רכיב הווידאו הזה במהלך היצירה של ה-AdDisplayContainer. הערך עשוי להיות null.

נעשה שימוש ב-isCustomClickTracking

IscustomClickTrackingUsed() מחזירה בוליאני

פונקציה זו מחזירה את הערך true אם רכיב מעקב מותאם אישית של מעקב משמש למעקב אחר קליקים על המודעה הנוכחית. מעקב קליקים מותאם אישית משמש רק כאשר מסופק רכיב אופציונלי של מעקב אחר קליקים ל-AdDisplayContainer, נעשה שימוש בהפעלה מותאמת אישית והמודעה הנוכחית אינה מודעת AdSense/JavaScript.

החזרות

boolean אם נעשה שימוש במעקב אחר קליקים מותאמים אישית.

נמצא בשימוש בהתאמה אישית

IscustomplayUsed() return boolean

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

החזרות

boolean אם נעשה שימוש בהפעלה מותאמת אישית.

השהיה

pause()

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

שינוי גודל

שינוי גודל(רוחב, גובה, viewMode)

משנה את גודל המודעה הנוכחית.

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

resume

קורות חיים()

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

setVolume (הגדרת עוצמת קול)

setVolume(volume)

יש להגדיר את הנפח של המודעה הנוכחית.

פרמטר
עוצמת קול	number עוצמת הקול שהוגדרה, מ-0 (מושתקת) עד 1 (גבוהה).

דילוג

דילוג()

המערכת תדלג על המודעה הנוכחית כשAdsManager.getAdSkippableState() יהיה נכון. כשהמדיניות הזו מופעלת בנסיבות אחרות, אין דילוג. בסיום הדילוג, AdsManager יפעיל אירוע AdEvent.SKIPPED.

התחלה

start()

מתחילים להציג את המודעות.

המפתחים צריכים להתקשר קודם אל AdDisplayContainer.initialize().

עצירה

stop()

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

עדכוןAdsRenderingSettings

updateAdsRenderingSettings(adsRenderingSettings)

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

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