تبلیغات موبایلی

کاتلین | جاوا

public class MobileAds

---

این کلاس شامل منطقی است که به طور کلی به SDK تبلیغات موبایلی گوگل اعمال می‌شود. در حال حاضر، تنها متدهای موجود در آن برای مقداردهی اولیه استفاده می‌شوند.

خلاصه

ثابت‌ها
static final String	ERROR_DOMAIN = "com.google.android.gms.ads" نام دامنه‌ی پیش‌فرض خطا برای SDK تبلیغات موبایلی گوگل.

روش‌های عمومی
static void	disableMediationAdapterInitialization ( Context context) قبل از initialize یا اولین درخواست تبلیغ، برای غیرفعال کردن مقداردهی اولیه آداپتور میانجیگری، فراخوانی کنید.
static @ Nullable InitializationStatus	getInitializationStatus () وضعیت مقداردهی اولیه SDK را دریافت می‌کند.
static @ NonNull RequestConfiguration	getRequestConfiguration () RequestConfiguration سراسری را دریافت می‌کند.
static VersionInfo	getVersion () نسخه خارجی (برای مثال، 20.6.0) از SDK تبلیغات موبایلی گوگل را دریافت می‌کند.
static void	@ RequiresPermission (value = Manifest.permission.INTERNET ) initialize ( Context context) SDK تبلیغات موبایلی گوگل را مقداردهی اولیه می‌کند.
static void	initialize ( Context context, OnInitializationCompleteListener listener) SDK تبلیغات موبایلی گوگل را مقداردهی اولیه می‌کند.
static void	openAdInspector ( Context context, OnAdInspectorClosedListener listener) رابط کاربری بازرس تبلیغات را باز می‌کند.
static void	openDebugMenu ( Context context, String adUnitId) منوی اشکال‌زدایی را باز می‌کند.
static boolean	putPublisherFirstPartyIdEnabled (boolean enabled) کنترل می‌کند که آیا شناسه شخص ثالث ناشر SDK تبلیغات موبایل گوگل، که قبلاً با نام همان کلید برنامه شناخته می‌شد، فعال باشد یا خیر.
static @ Nullable CustomTabsSession	registerCustomTabsSession ( @ NonNull Context context, @ NonNull CustomTabsClient client, @ NonNull String origin, @ Nullable CustomTabsCallback callback ) یک CustomTabsClient را با SDK تبلیغات موبایلی گوگل ثبت می‌کند تا کسب درآمد از تبلیغات درون برنامه‌ای را در این CustomTabsSession بهبود بخشد.
static void	registerWebView (@ NonNull WebView webview) یک WebView را با SDK تبلیغات موبایلی گوگل ثبت می‌کند تا کسب درآمد از تبلیغات درون برنامه‌ای را در این WebView بهبود بخشد.
static void	setAppMuted (boolean muted) نشان می‌دهد که آیا صدای برنامه قطع شده است یا خیر.
static void	setAppVolume (float volume) میزان صدای برنامه را تنظیم می‌کند.
static void	setRequestConfiguration ( @ NonNull RequestConfiguration requestConfiguration ) RequestConfiguration سراسری را که برای هر AdRequest در طول جلسه برنامه استفاده خواهد شد، تنظیم می‌کند.
static void	startPreload ( @ NonNull Context context, @ NonNull List < PreloadConfiguration > preloadConfigurations, @ NonNull PreloadCallback preloadCallback ) این روش منسوخ شده است. به جای آن start یا start استفاده کنید.

ثابت‌ها

خطای دامنه

public static final String ERROR_DOMAIN = "com.google.android.gms.ads"

نام دامنه‌ی پیش‌فرض خطا برای SDK تبلیغات موبایلی گوگل.

روش‌های عمومی

غیرفعال‌سازی مقداردهی اولیه آداپتور میانجی

public static void disableMediationAdapterInitialization(Context context)

قبل از initialize یا اولین درخواست تبلیغ، برای غیرفعال کردن مقداردهی اولیه آداپتور میانجیگری، فراخوانی می‌شود. این روش پس از initialize یا اولین درخواست تبلیغ، غیرفعال می‌شود.

هشدار: فراخوانی این متد ممکن است بر عملکرد میانجیگری شما تأثیر منفی بگذارد. این متد فقط در صورتی باید فراخوانی شود که آداپتورهای میانجیگری را در برنامه خود گنجانده باشید، اما قصد ندارید در طول این جلسه برنامه از میانجیگری گوگل استفاده کنید (برای مثال، در حال اجرای یک تست A/B هستید).

دریافت وضعیت مقداردهی اولیه

public static @Nullable InitializationStatus getInitializationStatus()

وضعیت مقداردهی اولیه SDK را دریافت می‌کند.

پیکربندی getRequest

public static @NonNull RequestConfiguration getRequestConfiguration()

RequestConfiguration سراسری را دریافت می‌کند.

دریافت نسخه

public static VersionInfo getVersion()

نسخه خارجی (برای مثال، 20.6.0) از SDK تبلیغات موبایلی گوگل را دریافت می‌کند.

لازم نیست initialize قبل از این تابع فراخوانی شود.

مقداردهی اولیه

@RequiresPermission(value = Manifest.permission.INTERNET)
public static void initialize(Context context)

SDK تبلیغات موبایلی گوگل را مقداردهی اولیه می‌کند.

این متد را در اسرع وقت پس از راه‌اندازی برنامه فراخوانی کنید تا تأخیر در اولین درخواست تبلیغ در جلسه کاهش یابد.

اگر این متد فراخوانی نشود، اولین درخواست تبلیغ به طور خودکار SDK تبلیغات موبایلی گوگل را مقداردهی اولیه می‌کند.

پارامترها
Context context	Context SDK در آن اجرا می‌شود.

مقداردهی اولیه

public static void initialize(Context context, OnInitializationCompleteListener listener)

SDK تبلیغات موبایلی گوگل را مقداردهی اولیه می‌کند.

این متد را در اسرع وقت پس از راه‌اندازی برنامه فراخوانی کنید تا تأخیر در اولین درخواست تبلیغ در جلسه کاهش یابد.

اگر این متد فراخوانی نشود، اولین درخواست تبلیغ به طور خودکار SDK تبلیغات موبایلی گوگل را مقداردهی اولیه می‌کند.

پارامترها
Context context	Context فعالیتی که SDK در آن اجرا می‌شود.
OnInitializationCompleteListener listener	یک فراخوانی برگشتی که پس از اتمام مقداردهی اولیه فراخوانی می‌شود.

بازرس تبلیغات باز

public static void openAdInspector(Context context, OnAdInspectorClosedListener listener)

رابط کاربری بازرس تبلیغات را باز می‌کند.

منوی اشکال‌زدایی باز

public static void openDebugMenu(Context context, String adUnitId)

منوی اشکال‌زدایی را باز می‌کند. initialize باید قبل از این تابع فراخوانی شود.

پارامترها
Context context	Context فعالیتی که SDK در آن اجرا می‌شود.
String adUnitId	هر شناسه واحد تبلیغاتی مدیر تبلیغات مرتبط با برنامه شما.

putPublisherFirstPartyIdEnabled

public static boolean putPublisherFirstPartyIdEnabled(boolean enabled)

کنترل می‌کند که آیا شناسه شخص ثالث ناشر SDK تبلیغات موبایل گوگل، که قبلاً با نام همان کلید برنامه شناخته می‌شد، فعال باشد یا خیر.

شناسه به طور پیش‌فرض فعال است. وقتی غیرفعال شود، این تنظیم در تمام جلسات برنامه حفظ می‌شود و شناسه پاک می‌شود.

initialize باید قبل از این تابع فراخوانی شود.

پارامترها
boolean enabled	اگر شناسه‌ی شخص اول ناشر فعال باشد، مقدار بولی true و در غیر این صورت false خواهد بود.

بازگشت‌ها
boolean	اگر تصمیم با موفقیت حفظ شود، مقدار true و اگر حفظ نشود، مقدار false برمی‌گرداند.

جلسه‌ی ثبت برگه‌های سفارشی

public static @Nullable CustomTabsSession registerCustomTabsSession(
    @NonNull Context context,
    @NonNull CustomTabsClient client,
    @NonNull String origin,
    @Nullable CustomTabsCallback callback
)

یک CustomTabsClient را با SDK تبلیغات موبایلی گوگل ثبت می‌کند تا کسب درآمد از تبلیغات درون برنامه‌ای را در این CustomTabsSession بهبود بخشد. این کار فقط یک نمونه از CustomTabsSession ایجاد می‌کند و اجرای مجدد آن، session موجود را لغو می‌کند.

پارامترها
@ NonNull Context context	Context SDK در آن اجرا می‌شود.
@ NonNull CustomTabsClient client	CustomTabsClient برای ایجاد نمونه CustomTabsSession استفاده می‌شود.
@ NonNull String origin	رشته‌ای که به عنوان مبدا در پیوند دارایی دیجیتال برای تأیید استفاده می‌شود.
@ Nullable CustomTabsCallback callback	CustomTabsCallback اختیاری برای دریافت فراخوانی‌های مجدد از CustomTabsSession .

بازگشت‌ها
@ Nullable CustomTabsSession	نمونه‌ای از CustomTabsSession که برای نمایش تب‌های سفارشی هنگام باز کردن یک صفحه تب‌های سفارشی استفاده می‌شود.

ثبت ناموب ویو

public static void registerWebView(@NonNull WebView webview)

یک WebView را با SDK تبلیغات موبایلی گوگل ثبت می‌کند تا کسب درآمد از تبلیغات درون برنامه‌ای را در این WebView بهبود بخشد.

تنظیم‌شده

public static void setAppMuted(boolean muted)

نشان می‌دهد که آیا صدای برنامه بی‌صدا است یا خیر. روی حالت بی‌صدای اولیه برای همه تبلیغات تأثیر می‌گذارد.

هشدار: بی‌صدا کردن برنامه، واجد شرایط بودن تبلیغات ویدیویی را کاهش می‌دهد و ممکن است درآمد تبلیغاتی برنامه شما را کم کند. شما فقط باید در صورتی از این API استفاده کنید که برنامه شما کنترل بی‌صدا کردن سفارشی را در اختیار کاربر قرار دهد و شما باید تصمیم بی‌صدا کردن کاربر را در این API منعکس کنید.

پارامترها
boolean muted	اگر برنامه بی‌صدا باشد، مقدار true و در غیر این صورت false است. مقدار پیش‌فرض false است.

تنظیم حجم برنامه

public static void setAppVolume(float volume)

میزان صدای برنامه را تنظیم می‌کند. بر میزان صدای همه تبلیغات نسبت به سایر خروجی‌های صوتی تأثیر می‌گذارد.

هشدار: کاهش حجم صدای برنامه شما، واجد شرایط بودن تبلیغات ویدیویی را کاهش می‌دهد و ممکن است درآمد تبلیغاتی برنامه شما را نیز کم کند. شما فقط در صورتی باید از این API استفاده کنید که برنامه شما کنترل‌های حجم صدای سفارشی را در اختیار کاربر قرار دهد و شما باید انتخاب حجم صدای کاربر را در این API منعکس کنید.

پارامترها
float volume	میزان صدا را به صورت اعشاری از ۰ (بی‌صدا) تا ۱.۰ (میزان صدای کامل رسانه) تنظیم می‌کند. پیش‌فرض ۱.۰ است.

پرتاب‌ها
java.lang.IllegalArgumentException	اگر حجم خارج از محدوده معتبر باشد

پیکربندی درخواست تنظیم‌شده

public static void setRequestConfiguration(
    @NonNull RequestConfiguration requestConfiguration
)

RequestConfiguration سراسری را که برای هر AdRequest در طول جلسه برنامه استفاده خواهد شد، تنظیم می‌کند.

شروع پیش بارگذاری

public static void startPreload(
    @NonNull Context context,
    @NonNull List<PreloadConfiguration> preloadConfigurations,
    @NonNull PreloadCallback preloadCallback
)

این روش منسوخ شده است.

به جای آن start یا start استفاده کنید.

شروع به پیش بارگذاری تبلیغات برای پیکربندی‌های داده شده می‌کند.

APIهای پیش‌بارگذاری تبلیغات در نسخه آلفای محدود هستند. لطفاً برای اطلاعات بیشتر با مدیر حساب خود تماس بگیرید.

پارامترها
@ NonNull Context context	Context SDK در آن اجرا می‌شود.
@ NonNull List < PreloadConfiguration > preloadConfigurations	تنظیمات مربوط به پیش‌بارگذاری تبلیغات.
@ NonNull PreloadCallback preloadCallback	یک فراخوانی برگشتی که هنگام تغییر در دسترس بودن تبلیغات برای هر پیکربندی پیش‌بارگذاری، فراخوانی می‌شود.