מחלקה: מודעה

google.ima.מודעה

class   static

רמת מודעות שמתרחבת באמצעות כיתות שמייצגות סוגים שונים של מודעות.

שיטות

getAdId

מחרוזת של getAdId()

מזהה המודעה משמש לסנכרון מודעות ראשיות ומודעות נלוות.

החזרות

string מזהה המודעה, או המחרוזת ריקה אם המידע הזה לא זמין.

getAdPodInfo

getAdPodInfo() מחזיר AdPodInfo

מחזירה את פרטי ה-pod של המודעה.

החזרות

non-null AdPodInfo מידע על Pod של המודעה.

getAdSystem

מחרוזת של getAdSystem()

פרטי שרת המודעות המקורי הכלולים בתגובה למודעה.

החזרות

string שרת מודעות המקור של המודעה, או המחרוזת הריקה אם המידע הזה לא זמין.

getAdvertiserName

מחרוזת של getAdvertiserName()

שם המפרסם כפי שמוגדר על ידי הצד הממלא.

החזרות

string שם המפרסם, או המחרוזת הריקה אם המידע הזה לא זמין.

getApiFramework

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

מזהה את ממשק ה-API הדרוש להפעלת המודעה. היא תואמת ל-apiFramework שצוין ב-VAST.

החזרות

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

getCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, settings) החזרה מערך של CompanionAd שאינו אפס

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

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

החזרות

non-null Array of non-null CompanionAd מערך של מודעות נלוות התואמות את ההגדרות ואת גודל המיקום.

getContentType

מחרוזת של getContentType()

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

החזרות

string סוג התוכן, מחרוזת ריקה אם אין.

getCreativeAdId

מחרוזת של getCreativeAdId()

מחזירה את קוד ISCI (Industry Standard Commercial Identifier) של מודעה, או מחרוזת ריקה אם הקוד אינו זמין. זהו מזהה המודעה של הקריאייטיב בתגובת ה-VAST.

החזרות

string 

getCreativeId

GetCreativeId() return string

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

החזרות

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

getDealId

מחרוזת של getDealId()

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

החזרות

string 

getDescription

getDescription() מחרוזת החזרות

מחזירה את התיאור של המודעה הזו מתגובת ה-VAST.

החזרות

string התיאור, ריק אם לא יצוין.

getDuration

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

מחזירה את משך הזמן של הקריאייטיב שנבחר, או 1- עבור קריאייטיבים שאינם ליניאריים.

החזרות

number משך הקריאייטיב שנבחר בשניות, -1 אם אינו לינארי.

getHeight

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

מחזירה את הגובה של הקריאייטיב הלא-לינארי שנבחר.

החזרות

number הגובה של הקריאייטיב הלא לינארי שנבחר, או 0 של קריאייטיב לינארי.

getMediaUrl

getMediaUrl()

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

החזרות

nullable string 

getMinSuggestedDuration

מספר החזרות של minMinSuggestedDuration()

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

החזרות

number משך הזמן המינימלי המומלץ שניות אחרי הצגת הקריאייטיב.

getSkipTimeOffset

מספר מדיניות מדיניות הדילוג

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

החזרות

number הקיזוז בשניות, או -1.

getSurveyUrl

מחרוזת של ReturnSurveyUrl()

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

החזרות

nullable string 

getTitle

מחרוזת של getTitle()

מחזירה את הכותרת של המודעה הזו מתגובת ה-VAST.

החזרות

string הכותרת, ריקה אם לא צוינה.

getTraffickingParameters

getTraffickingParameters() מחזיר אובייקט עם מאפייני מחרוזת

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

החזרות

non-null Object with string properties מיפוי של מפתחות ניהול טראפיק לערכים שלהם, או אובייקט ריק אם המידע הזה לא זמין.

getTraffickingParametersString

מחרוזת של getTraffickingParametersString()

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

החזרות

string פרמטרים לניהול טראפיק, או המחרוזת ריקה אם המידע הזה לא זמין.

getUiElements

getUiElements() מחזיר מערך של מחרוזת

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

החזרות

non-null Array of string הרכיבים של ממשק המשתמש שמוצגים.

getUniversalAdIdRegistry

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

המרשם שמשויך לקטלוג ה-UniversalAdId של הקריאייטיב שנבחר עבור המודעה.

הוצא משימוש

יש להשתמש ב-ad.getUniversalAdIds()

החזרות

string מחזירה את ערך הרישום או את הערך "לא ידוע" אם הוא לא זמין.

getUniversalAdIdValue

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

ה-UniversalAdId של הקריאייטיב שנבחר עבור המודעה.

הוצא משימוש

יש להשתמש ב-ad.getUniversalAdIds()

החזרות

string מחזירה את ערך המזהה או את הערך "לא ידוע" אם הוא לא זמין.

getUniversalAdIds

getUniversalAdIds() החזרה מערך של UniversalAdIdInfo שאינו אפס

רשימת UniversalIdIds של הקריאייטיב שנבחר עבור המודעה.

החזרות

non-null Array of non-null UniversalAdIdInfo מחזיר רשימה של פרטי מזהה המודעה האוניברסליים שחלים על המודעה הזו.

getVastMediaBitrate

getVastMediaBitrate() החזרה

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

החזרות

number קצב העברת הנתונים של קובץ המדיה שנבחר או 0.

getVastMediaHeight

מספר החזרות של getVastMediaHeight()

מחזירה את גובה מדיית VAST של הקריאייטיב שנבחר.

החזרות

number גובה המדיה ב-VAST של הקריאייטיב שנבחר או 0 אם לא נבחר.

getVastMediaWidth

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

מחזירה את רוחב המדיה מסוג VAST של הקריאייטיב שנבחר.

החזרות

number רוחב המדיה ב-VAST של הקריאייטיב שנבחר או 0 אם לא נבחר.

getWidth

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

מחזירה את רוחב הקריאייטיב שנבחר.

החזרות

number הרוחב של הקריאייטיב הלא לינארי שנבחר או 0 של קריאייטיב לינארי.

getWrapperAdIds

getWrapperAdIds() החזרה של מערך מחרוזת

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

החזרות

non-null Array of string המזהים של המודעות, החל מהמודעה המוטבעת או ממערך ריק אם אין מודעות wrapper.

getWrapperAdSystems

getWrapperAdSystems() מחזיר מערך של מחרוזת

מערכות מודעות שמשמשות למודעות wrapper. מערכות המודעות שמוחזרות מתחילות במודעה המוטבעת ועוברים למודעת ה-wrapper החיצונית ביותר. מערך שאין בו תוכן מוחזר, אם אין מודעות wrapper.

החזרות

non-null Array of string מערכות המודעות של המודעות, החל מהמודעה המוטבעת או ממערך ריק אם אין מודעות wrapper.

getWrapperCreativeIds

getWrapperCreativeIds() החזרה של מערך מחרוזת

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

החזרות

non-null Array of string המזהים של הקריאייטיבים של המודעות, החל מהמודעה המוטבעת או ממערך ריק אם אין מודעות wrapper.

לינארית

isLinear() מחזירה ערך בוליאני

מציין אם מצב הפעולה הנוכחי של המודעה הוא לינארי או לא לינארי. אם הערך הוא True, הוא מציין שהמודעה נמצאת במצב הפעלה לינארית. אם הערך הוא False, היא מציינת מצב לא לינארי. הנגן בודק את הנכס הליניארי ומעדכן את המצב שלו לפי הפרטים של מיקום המודעה. במצב לינארי, הנגן משהה את סרטון התוכן. אם הערך הלינארי נכון בהתחלה, והמודעה מוצגת לפני סרטון (שמוגדרת באופן חיצוני), הנגן עשוי לדחות את הטעינה של סרטון התוכן עד שהיא עומדת להסתיים.

החזרות

boolean True אם המודעה היא לינארית, אחרת אחרת.