מרחב שמות: ima

google.ima

namespace   static

מרחב השמות google.ima מספק גישה לכיתות, לממשקים, לספירות ולמאפיינים של ה-SDK.

שיעורים

מודעה

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

AdCuePoints

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

מאגר מודעות לרשת המדיה

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

כשמכונה של כיתה זו נוצרת, היא יוצרת IFRAME ב-ContainerElement וטוענת את ליבת ה-SDK. חובה לשמור את ה-IFRAME הזה כדי שה-SDK יפעל באופן תקין. אחרי שמפעילים את כל המודעות ואין יותר צורך ב-SDK, צריך להשתמש בשיטה destroy() כדי להסיר את ה-SDK.

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

הערה: תמיד צריך להפעיל את השיטה initialize() בקוד שמופעל ישירות על ידי פעולת משתמש (כמו קליק או הקשה).

שגיאת מודעה

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

AdErrorEvent

האירוע הזה נוצר כשמתרחשת שגיאה בטעינת מודעה מהשרתים של Google או DoubleClick. סוגי האירועים שאפשר לרשום לאירוע הם AdsLoader ו-AdsManager.

AdEvent

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

AdMetadataEvent

הכיתה הזו הוצאה משימוש. שימוש ב-AdsManager.getCuePoints() API. אירוע ספציפי במודעה שכולל מטא-נתונים.

AdPodInfo

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

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

AdProgressData

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

AdsLoader

AdsLoader מאפשרת ללקוחות לבקש מודעות משרתי מודעות. כדי לעשות זאת, המשתמשים צריכים להירשם לאירוע AdsManagerLoadedEvent ואז לבקש מודעות.

AdsManager

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

AdsManagerLoadedEvent

האירוע הזה עולה כשהמודעות נטענות בהצלחה משרתי המודעות של Google או DoubleClick באמצעות AdsLoader. אפשר להירשם לאירוע הזה ב-AdsLoader.

הגדרות עיבוד מודעות

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

AdsRequest

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

מודעה נלווית

מייצג מודעה נלווית.

הגדרות CompanionAdSelection

אובייקט CompanionAdSelectionSettings משמש להגדרת הקריטריונים של הבחירה בזמן הקריאה לפונקציה ima.Ad.getCompanionAds.

ImaSdkSettings

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

UniversalAdIdInfo

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

מספור

מצב OmidAccessMode

קבוע   סטטי

מחרוזת

מצבי גישה זמינים ל-OMID for Web, שקובעים את רמת הגישה של סקריפט האימות לסקריפט.

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

ספק אימות Omid

קבוע   סטטי

מספר

מזהה ספק אימות OMID. הספקים מסודרים לפי סדר אלפביתי.

ערך
קווסט
אימות כפול
Google
INTEGRAL_AD_SCIENCE
אלקטרוניקה
MOAT
נילסן
פיקסי
אחר	ספק ברירת המחדל שבו יש להשתמש כשכתובת ה-URL של הסקריפט לא תואמת לאף ספק אחר.

רכיבים

קבוע   סטטי

מחרוזת

Enum מציין אלמנטים שונים של ממשק משתמש שאפשר להגדיר להצגה או להסתרה. המערכת עשויה להתעלם מהגדרות אלה למודעות AdSense ו-ADX.

ערך
AD_ATTRIBUTION	הצגת הטקסט "מודעה" בממשק המשתמש של המודעות. צריך להיות נוכח כדי להציג את הטיימר של הספירה לאחור.
COUNTDOWN	כדי להציג טיימר לספירה לאחור נדרש שיוך למודעה. גם google.ima.UiElements.COUNTDOWN וגם google.ima.UiElements.AD_ATTRIBUTION צריכים להיכלל ב-AdsRenderingSettings.uiElements.

מצב תצוגה

קבוע   סטטי

מחרוזת

טיפוסים בני מנייה (enum) מציינים מצבים שונים של הצגת VPAID למודעות.

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

הוצא משימוש

נכסים

מצב OmidAccessMode

קבוע   סטטי

מחרוזת

מצבי גישה זמינים ל-OMID for Web, שקובעים את רמת הגישה של סקריפט האימות לסקריפט.

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

ספק אימות Omid

קבוע   סטטי

מספר

מזהה ספק אימות OMID. הספקים מסודרים לפי סדר אלפביתי.

ערך
קווסט
אימות כפול
Google
INTEGRAL_AD_SCIENCE
אלקטרוניקה
MOAT
נילסן
פיקסי
אחר	ספק ברירת המחדל שבו יש להשתמש כשכתובת ה-URL של הסקריפט לא תואמת לאף ספק אחר.

רכיבים

קבוע   סטטי

מחרוזת

Enum מציין אלמנטים שונים של ממשק משתמש שאפשר להגדיר להצגה או להסתרה. המערכת עשויה להתעלם מהגדרות אלה למודעות AdSense ו-ADX.

ערך
AD_ATTRIBUTION	הצגת הטקסט "מודעה" בממשק המשתמש של המודעות. צריך להיות נוכח כדי להציג את הטיימר של הספירה לאחור.
COUNTDOWN	כדי להציג טיימר לספירה לאחור נדרש שיוך למודעה. גם google.ima.UiElements.COUNTDOWN וגם google.ima.UiElements.AD_ATTRIBUTION צריכים להיכלל ב-AdsRenderingSettings.uiElements.

מצב תצוגה

קבוע   סטטי

מחרוזת

טיפוסים בני מנייה (enum) מציינים מצבים שונים של הצגת VPAID למודעות.

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

הוצא משימוש

הגדרות

קבוע   סטטי

InoSdkSettings שאינו אפס

מופע ההגדרות הגלובליות היחיד.