MobileAds

Kotlin |Java

class MobileAds

המחלקות מכילות לוגיקה שרלוונטית ל-Google Mobile Ads SDK בכללותו. בשלב הזה, השיטות היחידות שכלולות בו משמשות לאתחול.

סיכום

קבועים
`const String!`	`ERROR_DOMAIN = "com.google.android.gms.ads"` שם דומיין שגיאה שמוגדר כברירת מחדל ב-Google Mobile Ads SDK.

פונקציות ציבוריות
`java-static Unit`	`disableMediationAdapterInitialization(context: Context!)` מתקשרים לפני `initialize` או בקשת המודעה הראשונה כדי להשבית את האתחול של מתאם בחירת הרשת.
`java-static InitializationStatus?`	`getInitializationStatus()` קבלת סטטוס ההפעלה של ה-SDK.
`java-static RequestConfiguration`	`getRequestConfiguration()` הפונקציה מחזירה את ה-`RequestConfiguration` הכללי.
`java-static VersionInfo!`	`getVersion()` מקבל את הגרסה החיצונית (לדוגמה, 20.6.0) של Google Mobile Ads SDK.
`java-static Unit`	`@RequiresPermission(value = Manifest.permission.INTERNET) initialize(context: Context!)` הפונקציה מאתחלת את Google Mobile Ads SDK.
`java-static Unit`	`initialize(context: Context!, listener: OnInitializationCompleteListener!)` הפונקציה מאתחלת את Google Mobile Ads SDK.
`java-static Unit`	`openAdInspector(context: Context!, listener: OnAdInspectorClosedListener!)` ממשק המשתמש של הכלי לבדיקת מודעות נפתח.
`java-static Unit`	`openDebugMenu(context: Context!, adUnitId: String!)` תפריט הניפוי באגים ייפתח.
`java-static Boolean`	`putPublisherFirstPartyIdEnabled(enabled: Boolean)` ההגדרה הזו קובעת אם מופעל מזהה מאינטראקציה ישירה של בעל האפליקציה ב-Google Mobile Ads SDK, שנקרא בעבר מפתח אפליקציה זהה.
`java-static CustomTabsSession?`	`registerCustomTabsSession( context: Context, client: CustomTabsClient, origin: String, callback: CustomTabsCallback? )` הפונקציה רושמת `CustomTabsClient` ב-Google Mobile Ads SDK כדי לשפר את המונטיזציה של מודעות באפליקציה בתוך `CustomTabsSession` הזה.
`java-static Unit`	`registerWebView(webview: WebView)` הפונקציה רושמת `WebView` ב-Google Mobile Ads SDK כדי לשפר את המונטיזציה של מודעות באפליקציה בתוך `WebView` הזה.
`java-static Unit`	`setAppMuted(muted: Boolean)` מציין אם האודיו של האפליקציה מושתק.
`java-static Unit`	`setAppVolume(volume: Float)` הגדרת עוצמת הקול של האודיו באפליקציה.
`java-static Unit`	`setRequestConfiguration(requestConfiguration: RequestConfiguration)` מגדיר את `RequestConfiguration` הגלובלי שישמש לכל `AdRequest` במהלך הסשן של האפליקציה.
`java-static Unit`	`startPreload( context: Context, preloadConfigurations: (Mutable)List<PreloadConfiguration!>, preloadCallback: PreloadCallback )` הפונקציה הזו הוצאה משימוש. במקומה, צריך להשתמש ב-`start` או ב-`start`.

קבועים

ERROR_DOMAIN

const val ERROR_DOMAIN = "com.google.android.gms.ads": String!

שם דומיין שגיאה שמוגדר כברירת מחדל ב-Google Mobile Ads SDK.

פונקציות ציבוריות

disableMediationAdapterInitialization

java-static fun disableMediationAdapterInitialization(context: Context!): Unit

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

אזהרה: קריאה לשיטה הזו עלולה להשפיע לרעה על הביצועים של תהליך הגישור. צריך להפעיל את השיטה הזו רק אם כוללים באפליקציה מתאמי תהליך בחירת רשת, אבל לא מתכננים להשתמש בתהליך בחירת הרשת של Google במהלך סשן האפליקציה (לדוגמה, אם מריצים בדיקת A/B).

getInitializationStatus

java-static fun getInitializationStatus(): InitializationStatus?

קבלת סטטוס ההפעלה של ה-SDK.

getRequestConfiguration

java-static fun getRequestConfiguration(): RequestConfiguration

הפונקציה מחזירה את ה-RequestConfiguration הכללי.

getVersion

java-static fun getVersion(): VersionInfo!

מקבל את הגרסה החיצונית (לדוגמה, 20.6.0) של Google Mobile Ads SDK.

אין צורך לקרוא לפונקציה initialize לפני הפונקציה הזו.

אתחול

@RequiresPermission(value = Manifest.permission.INTERNET)
java-static fun initialize(context: Context!): Unit

הפונקציה מאתחלת את Google Mobile Ads SDK.

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

אם לא קוראים לשיטה הזו, בקשת המודעה הראשונה מאתחלת באופן אוטומטי את Google Mobile Ads SDK.

פרמטרים
`context: Context!`	הסביבה שבה פועל ה-SDK‏ `Context`.

אתחול

java-static fun initialize(context: Context!, listener: OnInitializationCompleteListener!): Unit

הפונקציה מאתחלת את Google Mobile Ads SDK.

אם לא קוראים לשיטה הזו, בקשת המודעה הראשונה מאתחלת באופן אוטומטי את Google Mobile Ads SDK.

פרמטרים
`context: Context!`	הפעילות `Context` שבה ה-SDK פועל.
`listener: OnInitializationCompleteListener!`	קריאה חוזרת (callback) שתופעל בסיום האתחול.

openAdInspector

java-static fun openAdInspector(context: Context!, listener: OnAdInspectorClosedListener!): Unit

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

openDebugMenu

java-static fun openDebugMenu(context: Context!, adUnitId: String!): Unit

תפריט הניפוי באגים ייפתח. צריך לקרוא לפונקציה initialize לפני הפונקציה הזו.

פרמטרים
`context: Context!`	הפעילות `Context` שבה ה-SDK פועל.
`adUnitId: String!`	כל מזהה של יחידת מודעות ב-Ad Manager שמשויך לאפליקציה שלכם.

putPublisherFirstPartyIdEnabled

java-static fun putPublisherFirstPartyIdEnabled(enabled: Boolean): Boolean

ההגדרה הזו קובעת אם מופעל מזהה מאינטראקציה ישירה של בעל האפליקציה ב-Google Mobile Ads SDK, שנקרא בעבר מפתח אפליקציה זהה.

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

צריך לקרוא לפונקציה initialize לפני הפונקציה הזו.

פרמטרים
`enabled: Boolean`	ערך בוליאני true אם המזהה מאינטראקציה ישירה (First-Party) של בעל האפליקציה מופעל, אחרת false.

החזרות
`Boolean`	‫true אם ההחלטה נשמרה בהצלחה. ‫False אם לא ניתן לשמור את הערך.

registerCustomTabsSession

java-static fun registerCustomTabsSession(
    context: Context,
    client: CustomTabsClient,
    origin: String,
    callback: CustomTabsCallback?
): CustomTabsSession?

הפונקציה רושמת CustomTabsClient ב-Google Mobile Ads SDK כדי לשפר את המונטיזציה של מודעות באפליקציה בתוך CustomTabsSession הזה. הפעולה הזו תיצור רק מופע אחד של CustomTabsSession, והרצה חוזרת של הפקודה הזו תבטל את הסשן הקיים.

פרמטרים
`context: Context`	הסביבה שבה פועל ה-SDK‏ `Context`.
`client: CustomTabsClient`	השתמשתם ב-`CustomTabsClient` כדי ליצור את מופע `CustomTabsSession`.
`origin: String`	מחרוזת שמשמשת כמקור ב-Digital Asset Link לצורך אימות.
`callback: CustomTabsCallback?`	אופציונלי: `CustomTabsCallback` כדי לקבל שיחות חוזרות מ-`CustomTabsSession`.

החזרות
`CustomTabsSession?`	מופע `CustomTabsSession` לשימוש ב-Custom Tabs Intent כשפותחים דף של כרטיסיות מותאמות אישית.

registerWebView

java-static fun registerWebView(webview: WebView): Unit

הפונקציה רושמת WebView ב-Google Mobile Ads SDK כדי לשפר את המונטיזציה של מודעות באפליקציה בתוך WebView הזה.

setAppMuted

java-static fun setAppMuted(muted: Boolean): Unit

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

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

פרמטרים
`muted: Boolean`	הערך true אם האפליקציה מושתקת, אחרת הערך false. ברירת המחדל היא False.

setAppVolume

java-static fun setAppVolume(volume: Float): Unit

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

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

פרמטרים
`volume: Float`	עוצמת הקול כמספר עשרוני מ-0 (השתקה) עד 1.0 (עוצמת הקול המלאה של המדיה). ברירת המחדל היא 1.0.

מקפיצה את הודעות השגיאה (Throws)
`java.lang.IllegalArgumentException`	אם עוצמת הקול חורגת מהטווח התקין

setRequestConfiguration

java-static fun setRequestConfiguration(requestConfiguration: RequestConfiguration): Unit

מגדיר את RequestConfiguration הגלובלי שישמש לכל AdRequest במהלך הסשן של האפליקציה.

startPreload

java-static fun startPreload(
    context: Context,
    preloadConfigurations: (Mutable)List<PreloadConfiguration!>,
    preloadCallback: PreloadCallback
): Unit

מתחילים לטעון מראש מודעות להגדרות הנתונות.

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

פרמטרים
`context: Context`	הסביבה שבה פועל ה-SDK‏ `Context`.
`preloadConfigurations: (Mutable)List<PreloadConfiguration!>`	ההגדרות לטעינה מראש של מודעות.
`preloadCallback: PreloadCallback`	קריאה חוזרת להפעלה כשזמינות המודעות משתנה בכל הגדרה של טעינה מראש.