Google Mobile Ads React Native API

واحد @google/mobile-ads میاناهای اصلی TypeScript، کلاس‌ها، و توابع سطح بالا را برای یکپارچه‌سازی Google Mobile Ads در برنامه‌های React Native ارائه می‌دهد.

نمای کلی

نام‌های مستعار نوع
AdapterState
نشان‌دهنده وضعیت‌های ممکن مقداردهی اولیه میانجی‌گری آداپتور است.
AdChoicesPlacement
مکان‌های نماد AdChoices در نمای آگهی.
AdFormat
قالب آگهی درخواستی.
AdInspectorError
اطلاعات خطا درباره اینکه چرا بازرس آگهی ناموفق بوده است.
AdInspectorErrorCode
خطاهایی که بر باز کردن یا عملکرد بازرس آگهی تأثیر می‌گذارند.
AdOrientation
گزینه‌های جهت‌گیری برای آگهی‌های برنمای تطبیقی به‌خط و بزرگ لنگرشده تطبیقی.
AdSize
ابعاد آگهی را نشان می‌دهد.
AgeRestrictedTreatment
گزینه‌های پردازش محدودشده براساس سن را برای درخواست‌های آگهی تعریف می‌کند.
ConsentStatus
مقادیر وضعیت موافقت.
DebugGeography
مقادیر اشکال‌زدایی برای آزمایش جغرافیا.
FormErrorCode
نشان‌دهنده کدهای خطا برای خرابی‌های عملکرد فرم «پلاتفرم پیام‌رسانی کاربر» (UMP) است.
FullScreenContentErrorCode
LoadAdErrorCode
نشان‌دهنده کدهای خطا برای خطاهای عملیات بار کردن آگهی است.
MaxAdContentRating
حداکثر رده‌بندی محتوای آگهی را برای برنامه تعریف می‌کند و انواع آگهی‌هایی را که می‌توان نمایش داد طبقه‌بندی می‌کند.
NativeAdAssetNames
نام‌های استفاده‌شده برای شناسایی دارایی‌های آگهی بومی استاندارد.
NativeAdType
قالب آگهی بومی بارشده را شناسایی می‌کند.
NativeMediaAspectRatio
اولویت‌های نسبت ابعادی رسانه آگهی بومی برگشتی.
OnAdInspectorClosedListener
تعریف میانای کاربری برای یک تماس برگشتی که وقتی میانای کاربری بازرس آگهی بسته می‌شود فراخوانی می‌شود.
PrecisionType
دقت مقدار آگهی گزارش‌شده.
PrivacyOptionsRequirementStatus
وضعیت الزامات گزینه‌های حریم خصوصی.
PublisherPrivacyPersonalizationState
وضعیت شخصی‌سازی رفتار حریم خصوصی «ناشر» را نشان می‌دهد.
ResizeMode
گزینه‌های سفارشی‌سازی حالت تغییر اندازه محتوای تصویر در NativeAdMediaView.
ResolvedAdSize
نشان‌دهنده وضعیت نهایی حل‌وفصل‌شده اندازه آگهی پس‌از بار شدن آگهی است.
SwipeGestureDirection
دستورالعمل‌های اشاره‌های تند کشیدن کلیک سفارشی.
متغیر
AdSize
اندازه‌های آگهی ازپیش‌تعریف‌شده و روش‌های کمکی برای ایجاد اندازه‌های تطبیقی و سفارشی.
توابع
canRequestAds
بررسی می‌کند که آیا وضعیت موافقت فعلی به شما اجازه می‌دهد آگهی درخواست کنید یا نه.
getConsentStatus
وضعیت موافقت فعلی کاربر را دریافت می‌کند.
getInitializationStatus
وضعیت مقداردهی اولیه کیت توسعه نرم‌افزار را دریافت می‌کند.
getPrivacyOptionsRequirementStatus
بررسی می‌کند که آیا نقطه ورودی گزینه‌های حریم خصوصی برای برنامه شما الزامی است یا نه.
getRequestConfiguration
پیکربندی درخواست سراسری را دریافت می‌کند.
initialize
«کیت توسعه نرم‌افزار تبلیغات تلفن همراه Google» را مقداردهی اولیه می‌کند.
isConsentFormAvailable
بررسی می‌کند که آیا فرم موافقت دردسترس است یا نه.
loadAndShowConsentFormIfRequired
اگر وضعیت موافقت فعلی کاربر ایجاب کند (برای نمونه، وضعیت «الزامی» باشد)، فرم موافقتی را بار می‌کند و به کاربر ارائه می‌دهد.
openAdInspector
روپوش «بازرس آگهی کیت توسعه نرم‌افزار تبلیغات تلفن همراه Google» را باز می‌کند.
openDebugMenu
منو اشکال‌زدایی را باز می‌کند.
parseLoadAdError
خطای بومی پرتاب‌شده درطول بار کردن آگهی را تجزیه می‌کند و آن را در LoadAdError می‌پیچد.
requestConsentInfoUpdate
درخواست به‌روزرسانی اطلاعات موافقت می‌کند.
reset
همه وضعیت‌های موافقت را از فضای ذخیره‌سازی ماندگار پاک می‌کند.
setPublisherFirstPartyIdEnabled
کنترل می‌کند که آیا شناسه طرف اول ناشر فعال است یا خیر.
setRequestConfiguration
پیکربندی درخواست سراسری را برای رعایت استانداردها و هدف‌یابی تنظیم می‌کند.
setUserControlledAppVolume
میزان صدای برنامه تحت کنترل کاربر را تنظیم می‌کند.
setUserMutedApp
مشخص می‌کند که برنامه صامت است یا نه.
showPrivacyOptionsForm
فرم گزینه‌های حریم خصوصی را نشان می‌دهد.

نام‌های مستعار نوع

AdapterState

AdapterState: typeof AdapterState[keyof typeof AdapterState]
نشان‌دهنده وضعیت‌های ممکن مقداردهی اولیه یک میانجی‌گر واسطه است.
مشخصات
NOT_READY
نشان می‌دهد که میانجی‌گر میانجی‌گری هنوز راه‌اندازی نشده است یا راه‌اندازی آن ناموفق بوده است.
READY
نشان می‌دهد که آداپتور واسطه‌گری باموفقیت مقداردهی اولیه شده است و آماده ارائه آگهی است.

AdChoicesPlacement

AdChoicesPlacement: typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
مکان‌های نماد AdChoices در نمای آگهی.
مشخصات
BOTTOM_LEFT
گوشه پایین سمت چپ آگهی.
BOTTOM_RIGHT
گوشه پایین سمت راست آگهی.
TOP_LEFT
گوشه بالا سمت راست آگهی.
TOP_RIGHT
گوشه بالا سمت راست آگهی.

AdFormat

AdFormat: typeof AdFormat[keyof typeof AdFormat]
قالب آگهی درخواستی.
مشخصات
APP_OPEN
قالب آگهی «باز کردن برنامه».
BANNER
قالب آگهی برنمایی.
INTERSTITIAL
قالب آگهی بینابینی.
NATIVE
قالب آگهی بومی.
REWARDED
قالب آگهی پاداش‌دار.
REWARDED_INTERSTITIAL
قالب آگهی بینابینی پاداش‌دار.

AdInspectorError

AdInspectorError: BaseError<AdInspectorErrorCode>
اطلاعات خطا درباره اینکه چرا بازرس آگهی ناموفق بوده است.

AdInspectorErrorCode

AdInspectorErrorCode: typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
خطاهایی که بر باز کردن یا عملکرد بازرس آگهی تأثیر می‌گذارند.
مشخصات
ALREADY_OPEN
«بازرس آگهی» باز نشد زیرا قبلاً باز بوده است.
FAILED_TO_LOAD
«بازرس آگهی» بار نشد.
INTERNAL_ERROR
«بازرس آگهی» خطای داخلی داشت.
NOT_IN_TEST_MODE
«بازرس آگهی» باز نمی‌شود زیرا دستگاه در حالت آزمایش نیست.

AdOrientation

AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
گزینه‌های گرایش برای آگهی‌های برنمای تطبیقی به‌خط و تطبیقی لنگرشده بزرگ.
مشخصات
CURRENT
LANDSCAPE
PORTRAIT

AdSize

ابعاد آگهی را نشان می‌دهد.

ممکن است یکی از مجموعه‌های ازپیش‌تعریف‌شده اندازه‌ها (برای نمونه، AdSize.LARGE_BANNER)، یا اندازه تطبیقی باشد.

AgeRestrictedTreatment

AgeRestrictedTreatment: typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
گزینه‌های پردازش محدودشده براساس سن را برای درخواست‌های آگهی تعریف می‌کند.
مشخصات
CHILD
نشان می‌دهد که درخواست‌های آگهی باید «رفتار کودکانه» دریافت کنند.
TEEN
نشان می‌دهد که درخواست‌های آگهی باید رفتار «نوجوان» را دریافت کنند.
UNSPECIFIED
نشان می‌دهد که هیچ سیگنال درمان محدودشده سنی خاصی برای درخواست آگهی اعمال نمی‌شود.

ConsentStatus

ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
مقادیر وضعیت موافقت.
مشخصات
NOT_REQUIRED
رضایت لازم نیست.
OBTAINED
رضایت کاربر دریافت شد، شخصی‌سازی‌شده دربرابر غیرشخصی‌سازی‌شده تعریف‌نشده.
REQUIRED
رضایت کاربر لازم است اما هنوز کسب نشده است.
UNKNOWN
وضعیت رضایت نامشخص است.

DebugGeography

DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
مقادیر اشکال‌زدایی برای آزمایش جغرافیا.
مشخصات
DISABLED
مکان جغرافیایی اشکال‌زدایی برای دستگاه‌های اشکال‌زدایی غیرفعال شد.
EEA
جغرافیا برای دستگاه‌های اشکال‌زدایی همانند منطقه اقتصادی اروپا نمایش داده می‌شود.
OTHER
جغرافیا به‌صورت منطقه‌ای بدون مقررات اجرایی برای دستگاه اشکال‌زدایی نمایش داده می‌شود.
REGULATED_US_STATE
جغرافیا برای دستگاه‌های اشکال‌زدایی همان‌گونه که در «ایالت‌های تحت نظارت امریکا» نشان داده می‌شود، نمایش داده می‌شود.

FormErrorCode

FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
نشان‌دهنده کدهای خطا برای عملیات ناموفق فرم «پلاتفرم پیام‌رسانی کاربر» (UMP) است.
مشخصات
ALREADY_USED
قبلاً از فرم موافقت استفاده شده است.
INTERNAL_ERROR
مشکلی در داخل کیت توسعه نرم‌افزار پیش آمد.
INVALID_OPERATION
عملیات نامعتبر بود.
NETWORK_ERROR
عملیات فرم به‌دلیل اتصال‌پذیری شبکه ناموفق بود.
TIMEOUT
مهلت عملیات فرم تمام شد.
UNAVAILABLE
فرم موافقتی دردسترس نیست.
UNKNOWN
کد خطا به کد خطای شناخته‌شده‌ای نگاشت نشد.

FullScreenContentErrorCode

FullScreenContentErrorCode: typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
مشخصات
AD_ALREADY_USED
آگهی قبلاً نشان داده شده است.
AD_NOT_READY
آگهی برای نمایش آماده نیست.
AD_TOO_LARGE
آگهی برای صحنه خیلی بزرگ است (فقط iOS).
APP_NOT_FOREGROUND
برنامه در پیش‌زمینه نیست.
INTERNAL_ERROR
اتفاقی در داخل رخ داد؛ برای مثال، هنگام آماده‌سازی برای نمایش محتوای آگهی، استثنایی رخ داد.
MEDIATION_ERROR
آداپتور واسطه‌گری نتوانست آگهی را نشان دهد. برای علت اصلی، FullScreenContentError.mediationAdError را ببینید.
UNKNOWN
کد خطا به کد خطای شناخته‌شده‌ای نگاشت نشد.

LoadAdErrorCode

LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
نشان‌دهنده کدهای خطا برای خطاهای عملیات بار کردن آگهی است.
مشخصات
AD_ALREADY_USED
از پاسخ آگهی قبلاً برای بار کردن آگهی استفاده شده است.
APP_ID_MISSING
درخواست آگهی انجام نشد زیرا «شناسه برنامه» وجود ندارد.
CANCELLED
درخواست آگهی لغو شد (فقط Android).
INTERNAL_ERROR
مشکلی در داخل کیت توسعه نرم‌افزار پیش آمد.
INVALID_REQUEST
درخواست آگهی نامعتبر بود؛ برای نمونه، شناسه واحد آگهی نادرست بود.
INVALID_RESPONSE
پاسخ آگهی سرور به سرور نامعتبر است. برای مثال، شناسه درخواست در پاسخ آگهی وجود ندارد.
MEDIATION_ERROR
میانجی‌گر میانجی‌گری پیدا نشد یا نتوانست درخواست آگهی را اجرا کند.
NETWORK_ERROR
درخواست آگهی به‌دلیل اتصال‌پذیری شبکه ناموفق بود.
NO_FILL
درخواست آگهی موفق بود، اما به‌دلیل نبود فضای آگهی، آگهی‌ای برگردانده نشد.
TIMEOUT
مهلت زمانی درخواست آگهی تمام شد.
UNKNOWN
کد خطا به کد خطای شناخته‌شده‌ای نگاشت نشد.

MaxAdContentRating

MaxAdContentRating: typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
حداکثر رده‌بندی محتوای آگهی را برای برنامه تعریف می‌کند و انواع آگهی‌هایی را که می‌توانند نمایش داده شوند طبقه‌بندی می‌کند.
مشخصات
G
محتوای مناسب برای مخاطبان عام، ازجمله خانواده‌ها و کودکان.
MA
محتوایی که فقط برای مخاطبان بزرگسال مناسب است.
PG
محتوای مناسب برای اکثر مخاطبان با راهنمایی والدین.
T
محتوای مناسب برای مخاطبان نوجوان و بزرگسال.
UNSPECIFIED
رده‌بندی محتوای مشخصی وجود ندارد.

NativeAdAssetNames

NativeAdAssetNames: typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
نام‌های استفاده‌شده برای شناسایی دارایی‌های آگهی بومی استاندارد.
مشخصات
ADCHOICES_CONTAINER_VIEW
ظرفی برای رونهاد AdChoices.
ADVERTISER
نام تبلیغ‌کننده.
BODY
نوشتار اصلی آگهی.
CALL_TO_ACTION
نوشتار دعوت به اقدام برای آگهی (برای نمونه، «نصب» یا «بیشتر بدانید»).
HEADLINE
عنوان یا عنوان آگهی.
ICON
تصویر نماد آگهی.
MEDIA_CONTENT
محتوای رسانه‌ای اصلی آگهی (تصویر یا ویدیو).
PRICE
قیمت برنامه یا محصول تبلیغ‌شده.
STAR_RATING
رده‌بندی ستاره‌ای برای برنامه یا محصول تبلیغ‌شده.
STORE
نام فروشگاه.

NativeAdType

NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
قالب آگهی بومی بارشده را شناسایی می‌کند.
مشخصات
BANNER
آگهی برنمایی.
CUSTOM_NATIVE
آگهی قالب بومی سفارشی.
NATIVE
آگهی بومی.

NativeMediaAspectRatio

NativeMediaAspectRatio: typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
اولویت‌های نسبت ابعادی رسانه آگهی بومی برگشتی.
مشخصات
ANY
اولویت خاصی برای نسبت ابعادی رسانه آگهی بومی برگشتی وجود ندارد.
LANDSCAPE
نسبت ابعادی افقی را برای رسانه آگهی بومی برگشتی درخواست کنید.
PORTRAIT
نسبت ابعادی عمودی برای رسانه آگهی بومی برگشتی درخواست کنید.
SQUARE
نسبت ابعادی مربعی را برای رسانه آگهی بومی برگشتی درخواست کنید.
UNKNOWN
نسبت ابعادی نامشخص است.

OnAdInspectorClosedListener

OnAdInspectorClosedListener: ((error?) => void)
تعریف میانای کاربری برای یک تماس برگشتی که وقتی میانای کاربری بازرس آگهی بسته می‌شود فراخوانی شود.

PrecisionType

PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
دقت مقدار آگهی گزارش‌شده.
مشخصات
ESTIMATED
مقدار آگهی تخمینی از داده‌های تجمیعی.
PRECISE
مقدار دقیق پرداخت‌شده برای این آگهی.
PUBLISHER_PROVIDED
مقدار آگهی ارائه‌شده توسط ناشر، مانند «هزارظهوربهای» دستی در گروه واسطه‌گری.
UNKNOWN
مقدار آگهی با دقت نامشخص.

PrivacyOptionsRequirementStatus

PrivacyOptionsRequirementStatus: typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
وضعیت الزامات گزینه‌های حریم خصوصی.
مشخصات
NOT_REQUIRED
نقطه ورودی گزینه‌های حریم خصوصی الزامی نیست.
REQUIRED
نقطه ورودی گزینه‌های حریم خصوصی الزامی است.
UNKNOWN
وضعیت الزامی بودن گزینه‌های حریم خصوصی نامشخص است.

PublisherPrivacyPersonalizationState

PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
وضعیت‌های شخصی‌سازی رفتار حریم خصوصی «ناشر» را نشان می‌دهد.
مشخصات
DEFAULT
نشان می‌دهد که درخواست آگهی باید رفتار حریم خصوصی ناشر پیش‌فرض را دریافت کند.
DISABLED
نشان می‌دهد که درخواست آگهی باید رفتار حریم خصوصی ناشر غیرشخصی‌سازی‌شده را دریافت کند.
ENABLED
نشان می‌دهد که درخواست آگهی باید پردازش حریم خصوصی ناشر شخصی‌سازی‌شده را دریافت کند.

ResizeMode

ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
گزینه‌های سفارشی‌سازی حالت تغییر اندازه محتوای تصویر در NativeAdMediaView.
مشخصات
CONTAIN
به‌طور یکنواخت مقیاس‌بندی می‌شود تا در نما جا بگیرد.

ارتفاع و عرض تصویر با هم مقیاس‌بندی می‌شوند تا هر بعد کمتر از یا برابر با بعد متناظر نما باشد. تصویر مقیاس‌بندی می‌شود تا بدون اعوجاج در نسبت ابعادی یا برش خوردن، در نمای جا شود.
COVER
به‌طور یکنواخت مقیاس‌بندی می‌شود تا نما را پوشش دهد.

ارتفاع تصویر و عرض با هم مقیاس‌بندی می‌شوند تا هر بُعد برابر با بُعد متناظر نما یا بزرگ‌تر از آن باشد. تصویر برش داده می‌شود تا بدون تحریف نسبت ابعادی در نما جا شود.
STRETCH
عرض و ارتفاع به‌طور مستقل مقیاس‌بندی می‌شوند تا نما را پر کنند.

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

ResolvedAdSize

ResolvedAdSize: FixedAdSize | FluidAdSize
نشان‌دهنده وضعیت نهایی وضوح اندازه آگهی پس‌از بار شدن آگهی است.

برای اکثر آگهی‌ها، این وضعیت به FixedAdSize با ابعاد دقیق width و height تبدیل می‌شود. برای آگهی‌های بنری با اندازه پویا، این به FluidAdSize تبدیل می‌شود که در آن ابعاد توسط سلسله‌مراتب نمای مدیریت می‌شود.

SwipeGestureDirection

SwipeGestureDirection: typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
دستورالعمل‌های اشاره‌های تند کشیدن کلیک سفارشی.
مشخصات
DOWN
تند روی صفحه به‌پایین بکشید.
LEFT
تند به‌چپ بکشید.
RIGHT
انگشتتان را تند به‌چپ بکشید.
UP
تند به‌سمت بالا بکشید؛

متغیر

AdSize

AdSize: {
  BANNER: FixedAdSize;
  custom: ((width, height) => FixedAdSize);
  FLUID: FluidAdSize;
  FULL_BANNER: FixedAdSize;
  getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getInlineAdaptiveBannerAdSize: ((width, maxHeight) => InlineAdaptiveAdSize);
  getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
  getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
  LARGE_BANNER: FixedAdSize;
  LEADERBOARD: FixedAdSize;
  MEDIUM_RECTANGLE: FixedAdSize;
}
اندازه‌های آگهی ازپیش‌تعریف‌شده و روش‌های کمکی برای ایجاد اندازه‌های تطبیقی و سفارشی.

توابع

canRequestAds

canRequestAds(): boolean
بررسی می‌کند که آیا وضعیت موافقت فعلی به شما اجازه می‌دهد آگهی درخواست کنید یا نه.
بازگشتی‌ها
boolean true اگر بتوانید درخواست آگهی کنید، false درغیراین‌صورت.

getConsentStatus

getConsentStatus(): ConsentStatus
وضعیت موافقت فعلی کاربر را دریافت می‌کند.
بازگشتی‌ها
ConsentStatus وضعیت رضایت فعلی.

getInitializationStatus

getInitializationStatus(): InitializationStatus
وضعیت مقداردهی اولیه کیت توسعه نرم‌افزار را دریافت می‌کند.

از این روش برای بررسی اینکه آیا مقداردهی اولیه کیت توسعه نرم‌افزار به‌پایان رسیده است یا نه و برای بازرسی وضعیت هریک از آداپتورهای واسطه‌گری استفاده کنید.
بازگشتی‌ها
InitializationStatus وضعیت فعلی مقداردهی اولیه.

getPrivacyOptionsRequirementStatus

getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
بررسی می‌کند که آیا نقطه ورودی گزینه‌های حریم خصوصی برای برنامه شما الزامی است یا نه.

اگر نقطه ورودی الزامی است، عنصر رابط کاربری قابل‌مشاهده و تعاملی به برنامه‌تان اضافه کنید که showPrivacyOptionsForm را برای نمایش فرم گزینه‌های حریم خصوصی فراخوانی کند. اگر نقطه ورودی لازم نیست، عنصر رابط کاربری خود را به‌گونه‌ای پیکربندی کنید که نمایان و تعاملی نباشد.
بازگشتی‌ها
PrivacyOptionsRequirementStatus وضعیت الزامات گزینه‌های حریم خصوصی.

getRequestConfiguration

getRequestConfiguration(): RequestConfiguration
پیکربندی درخواست سراسری را دریافت می‌کند.

از این روش برای بازیابی پیکربندی درخواست کنونی که به‌صورت سراسری اعمال شده است استفاده کنید.
بازگشتی‌ها
RequestConfiguration پیکربندی درخواست سراسری فعلی.

initialize

initialize(config, onInitializationComplete?): void
«کیت توسعه نرم‌افزار تبلیغات تلفن همراه Google» را مقداردهی اولیه می‌کند.

این روش را قبل‌از بار کردن آگهی و قبل‌از تعامل با بقیه «کیت توسعه نرم‌افزار تبلیغات تلفن همراه Google» فراخوانی کنید.
پارامترها
config: InitializationConfig گزینه‌هایی برای کنترل مقداردهی اولیه کیت توسعه نرم‌افزار.
Optional onInitializationComplete: ((status) => void) تابعی که وقتی کیت توسعه نرم‌افزار مقداردهی اولیه را به‌پایان می‌رساند اجرا می‌شود.

isConsentFormAvailable

isConsentFormAvailable(): boolean
بررسی می‌کند که آیا فرم موافقت دردسترس است یا نه.
بازگشتی‌ها
boolean true اگر فرم موافقت دردسترس باشد، false درغیراین‌صورت.

loadAndShowConsentFormIfRequired

loadAndShowConsentFormIfRequired(onDismissed?): void
اگر وضعیت فعلی رضایت کاربر ایجاب کند (برای نمونه، وضعیت «الزامی» باشد)، فرم موافقت را بار می‌کند و به کاربر ارائه می‌دهد.
پارامترها
Optional onDismissed: ((error?) => void) وقتی فرم بسته می‌شود یا اگر فرمی لازم نباشد، تابع برگشتی فراخوانی می‌شود، با FormError اختیاری اگر ارائه ناموفق باشد.

openAdInspector

openAdInspector(_listener): void
رونهاد «بازرس آگهی کیت توسعه نرم‌افزار تبلیغات تلفن همراه Google» را باز می‌کند.

از این روش برای اشکال‌زدایی تنظیمات میانجی‌گری و منابع آگهی استفاده کنید.
پارامترها
_listener: OnAdInspectorClosedListener

openDebugMenu

openDebugMenu(adUnitId): void
منو اشکال‌زدایی را باز می‌کند.

از این روش برای باز کردن منو اشکال‌زدایی واحد آگهی خاصی استفاده کنید تا در آزمایش و عیب‌یابی پیکربندی‌های آگهی کمک کند.
پارامترها
adUnitId: string شناسه واحد آگهی برای باز کردن منو اشکال‌زدایی.

parseLoadAdError

parseLoadAdError(error): LoadAdError
خطای بومی پرتاب‌شده درطول بار کردن آگهی را تجزیه می‌کند و آن را در LoadAdError می‌پیچد.
پارامترها
error: unknown شیء خطای پرتاب‌شده توسط واحد بومی.
بازگشتی‌ها
LoadAdError شیء LoadAdError تجزیه‌شده.

requestConsentInfoUpdate

requestConsentInfoUpdate(params?, onComplete?): void
درخواست به‌روزرسانی اطلاعات موافقت می‌کند.

این API باید در هر جلسه برنامه قبل‌از فراخواندن getConsentStatus فراخوانده شود.

پس‌از فراخوانده شدن این API، getConsentStatus مقدار برگشتی به‌صورت هم‌زمان به‌روزرسانی می‌شود تا وضعیت موافقت از جلسه برنامه قبلی را دربرگیرد، درصورتی‌که وجود داشته باشد.

getConsentStatus پس‌از فراخوانده شدن onComplete بازمانی می‌تواند دوباره به وضعیت به‌روزرسانی‌شده به‌روز شود.
پارامترها
Optional params: ConsentRequestParameters پیکربندی‌های اختیاری برای اشکال‌زدایی و هدف‌یابی.
Optional onComplete: ((error?) => void) وقتی به‌روزرسانی اطلاعات موافقت به‌پایان می‌رسد، تابع برگشت تماس با یک FormError اختیاری فراخوانی می‌شود، اگر درخواست ناموفق باشد.

بازنشانی

reset(): void
همه وضعیت‌های موافقت را از فضای ذخیره‌سازی ماندگار پاک می‌کند.

فقط برای اهداف اشکال‌زدایی استفاده کنید.

setPublisherFirstPartyIdEnabled

setPublisherFirstPartyIdEnabled(enabled): void
کنترل می‌کند که شناسه طرف اول ناشر فعال باشد یا نه.

شناسه طرف اول ناشر «کیت توسعه نرم‌افزار آگهی‌های دستگاه همراه Google» را که قبلاً به‌عنوان کلید برنامه یکسان شناخته می‌شد فعال یا غیرفعال می‌کند.
همچنین مراجعه کنید به
پارامترها
enabled: boolean برای فعال کردن شناسه شخص اول ناشر درست است؛ برای غیرفعال کردن نادرست است. پیش‌فرض true است.

setRequestConfiguration

setRequestConfiguration(_config): void
پیکربندی درخواست جهانی را برای رعایت استانداردها و هدف‌یابی تنظیم می‌کند.

از این روش برای مشخص کردن جزئیات هدف‌یابی، مثل حداکثر رده‌بندی محتوای آگهی، تنظیمات رعایت استانداردها، مثل برچسب رفتار با سن، و شناسه‌های دستگاه آزمایشی استفاده کنید.
پارامترها
_config: RequestConfiguration

setUserControlledAppVolume

setUserControlledAppVolume(volume): void
میزان صدای برنامه کنترل‌شده توسط کاربر را تنظیم می‌کند.

از این روش برای تنظیم میزان صدای همه آگهی‌ها نسبت به دیگر بروندادهای صوتی در دستگاه استفاده کنید.
پارامترها
volume: number سطح صدا، بین ۰٫۰ (بی‌صدا) و ۱٫۰ (حداکثر). هر مقدار ممیز شناور در این محدوده معتبر است (برای مثال، ۰٫۰۰۱ یا ۰٫۳۳۳۳۳). مقدار به افزایش‌های اندازه گام خاصی، مانند ۰٫۱، محدود نمی‌شود.

setUserMutedApp

setUserMutedApp(muted): void
تعیین می‌کند که آیا برنامه بی‌صدا است یا نه.

از این روش برای کنترل وضعیت بی‌صدا بودن اولیه صدای آگهی‌های بعدی استفاده کنید.
پارامترها
muted: boolean آیا صدای برنامه باید بی‌صدا شود. به‌طور پیش‌فرض false است.

showPrivacyOptionsForm

showPrivacyOptionsForm(onDismissed?): void
فرم گزینه‌های حریم خصوصی را نشان می‌دهد.

اگر getPrivacyOptionsRequirementStatus REQUIRED باشد، فرم گزینه‌های حریم خصوصی را ارائه می‌کند.

این روش فقط باید در پاسخ به ورودی کاربر برای درخواست نمایش فرم گزینه‌های حریم خصوصی فراخوانی شود.

وقتی فرمی دردسترس قرار می‌گیرد، کیت توسعه نرم‌افزار به‌طور خودکار فرم گزینه‌های حریم خصوصی را ازقبل بار می‌کند. اگر هیچ فرمی ازقبل بار نشده باشد، کیت توسعه نرم‌افزار سعی می‌کند فرمی را به‌صورت ناهمزمان بار کند.

پس‌از اینکه فرم به کاربر ارائه شد، کاربر گزینه‌ای را انتخاب کرد، و فرم را بست، با onDismissed پس‌تماس گرفته می‌شود. همچنین می‌تواند با FormError برگردد اگر:
  • فرم دردسترس نیست.
  • فرم نمایش داده نمی‌شود.
  • فرم هنوز درحال پیش‌بارگذاری است.
پارامترها
Optional onDismissed: ((error?) => void) وقتی فرم بسته می‌شود، تابع برگشتی با FormError اختیاری فراخوانی می‌شود اگر ارائه ناموفق باشد.