Google Mobile Ads React Native API

يوفّر الوحدة @google/mobile-ads واجهات وفئات ووظائف أساسية من المستوى الأعلى بلغة TypeScript لدمج "إعلانات Google على الأجهزة الجوّالة" في تطبيقات React Native.

نظرة عامة

الأسماء المستعارة للأنواع
AdapterState
تمثّل هذه السمة حالات الإعداد المحتملة لأحد محوّلات التوسّط.
AdChoicesPlacement
مواضع رمز "خيارات الإعلان" في مشاهدة الإعلان
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
تعرض هذه الطريقة حالة إعداد حزمة تطوير البرامج (SDK).
getPrivacyOptionsRequirementStatus
تتحقّق هذه السمة مما إذا كانت نقطة دخول خيارات الخصوصية مطلوبة لتطبيقك.
getRequestConfiguration
تعرض هذه السمة إعدادات الطلب العامة.
initialize
تُستخدَم لضبط حزمة "SDK لإعلانات Google على الأجهزة الجوّالة".
isConsentFormAvailable
تتحقّق هذه السمة مما إذا كان نموذج الموافقة متاحًا.
loadAndShowConsentFormIfRequired
تحميل نموذج موافقة وعرضه للمستخدم إذا كانت حالة الموافقة الحالية تتطلّب ذلك (مثل الحالة REQUIRED).
openAdInspector
يفتح تراكب "فاحص الإعلانات" في حزمة "SDK لإعلانات 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]
مواضع رمز "خيارات الإعلان" في مشاهدة الإعلان
الخصائص
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]
تمثّل هذه السمة رموز الخطأ التي تحدث عند تعذُّر تنفيذ عمليات نماذج &quot;منصة رسائل المستخدم&quot; (UMP).
الخصائص
ALREADY_USED
سبق أن تم استخدام نموذج الموافقة.
INTERNAL_ERROR
حدث خطأ داخلي في حزمة تطوير البرامج (SDK).
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
حدث خطأ داخلي في حزمة تطوير البرامج (SDK).
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
حاوية تراكب "خيارات الإعلان"
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
تعرض هذه الطريقة حالة إعداد حزمة SDK.

استخدِم هذه الطريقة للتحقّق مما إذا تم الانتهاء من إعداد حزمة SDK، وللاطّلاع على حالة كل محوّل من محوّلات التوسّط.
المرتجعات
InitializationStatus حالة الإعداد الحالية

getPrivacyOptionsRequirementStatus

getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
تتحقّق هذه الدالة ممّا إذا كانت نقطة دخول خيارات الخصوصية مطلوبة لتطبيقك.

في حال كانت نقطة الدخول مطلوبة، أضِف عنصرًا مرئيًا وتفاعليًا في واجهة المستخدم إلى تطبيقك يستدعي الدالة showPrivacyOptionsForm لعرض نموذج خيارات الخصوصية. إذا لم تكن نقطة الدخول مطلوبة، اضبط عنصر في واجهة المستخدم على ألّا يكون مرئيًا وقابلاً للتفاعل.
المرتجعات
PrivacyOptionsRequirementStatus حالة متطلبات خيارات الخصوصية

getRequestConfiguration

getRequestConfiguration(): RequestConfiguration
تعرض هذه الدالة إعدادات الطلب العامة.

استخدِم هذه الطريقة لاسترداد إعدادات الطلب الحالية التي تم تطبيقها على مستوى العالم.
المرتجعات
RequestConfiguration إعدادات الطلب العالمي الحالية

initialize

initialize(config, onInitializationComplete?): void
تُستخدَم هذه الطريقة لإعداد حزمة "SDK لإعلانات Google على الأجهزة الجوّالة"،

ويجب استدعاؤها قبل تحميل أي إعلان وقبل التفاعل مع بقية حزمة "SDK لإعلانات Google على الأجهزة الجوّالة".
المعلمات
config: InitializationConfig خيارات التحكّم في عملية إعداد حزمة SDK
Optional onInitializationComplete: ((status) => void) دالة ردّ اتصال سيتم تنفيذها عند انتهاء حزمة SDK من عملية الإعداد.

isConsentFormAvailable

isConsentFormAvailable(): boolean
تتحقّق هذه السمة مما إذا كان نموذج الموافقة متاحًا.
المرتجعات
boolean true إذا كان نموذج الموافقة متاحًا، false في الحالات الأخرى.

loadAndShowConsentFormIfRequired

loadAndShowConsentFormIfRequired(onDismissed?): void
تحميل نموذج موافقة وعرضه للمستخدم إذا كانت حالة الموافقة الحالية تتطلّب ذلك (مثلاً، الحالة هي REQUIRED).
المعلمات
Optional onDismissed: ((error?) => void) دالة ردّ الاتصال التي يتم استدعاؤها عند إغلاق النموذج أو إذا لم يكن النموذج مطلوبًا، مع FormError اختياري في حال تعذّر العرض

openAdInspector

openAdInspector(_listener): void
يفتح هذا الإجراء تراكب &quot;أداة فحص الإعلانات&quot; في حزمة تطوير البرامج &quot;SDK لإعلانات Google على الأجهزة الجوّالة&quot;.

استخدِم هذه الطريقة لتصحيح أخطاء إعدادات التوسّط ومصادر الإعلانات.
المعلمات
_listener: OnAdInspectorClosedListener

openDebugMenu

openDebugMenu(adUnitId): void
يفتح قائمة تصحيح الأخطاء.

استخدِم هذه الطريقة لفتح قائمة تصحيح الأخطاء الخاصة بوحدة إعلانية معيّنة للمساعدة في اختبار إعدادات الإعلانات وتحديد المشاكل وحلّها.
المعلمات
adUnitId: string رقم تعريف الوحدة الإعلانية التي سيتم فتح قائمة تصحيح الأخطاء لها.

parseLoadAdError

parseLoadAdError(error): LoadAdError
تحلّل هذه الدالة خطأ أصليًا تم طرحه أثناء تحميل الإعلان، وتغلّفه في LoadAdError.
المعلمات
error: unknown عنصر الخطأ الذي تم طرحه بواسطة الوحدة الأصلية.
المرتجعات
LoadAdError كائن LoadAdError تم تحليله

requestConsentInfoUpdate

requestConsentInfoUpdate(params?, onComplete?): void
يطلب هذا الإجراء تعديل معلومات الموافقة.

يجب استدعاء واجهة برمجة التطبيقات هذه في كل جلسة تطبيق قبل استدعاء getConsentStatus.

بعد استدعاء واجهة برمجة التطبيقات هذه، يتم تعديل قيمة الإرجاع getConsentStatus بشكل متزامن لتضمين حالة الموافقة من جلسة التطبيق السابقة، إذا كانت هناك جلسة سابقة.

يمكن تعديل getConsentStatus مرة أخرى إلى الحالة الحديثة بعد استدعاء معاودة الاتصال onComplete.
المعلمات
Optional params: ConsentRequestParameters إعدادات اختيارية لتصحيح الأخطاء والاستهداف
Optional onComplete: ((error?) => void) دالة ردّ الاتصال التي يتم استدعاؤها عند انتهاء عملية تعديل معلومات الموافقة، مع FormError اختياري في حال تعذّر تنفيذ الطلب.

إعادة الضبط

reset(): void
محو جميع حالات الموافقة من مساحة التخزين الدائمة

يجب استخدامها لأغراض تصحيح الأخطاء فقط.

setPublisherFirstPartyIdEnabled

setPublisherFirstPartyIdEnabled(enabled): void
تتحكّم هذه السمة في ما إذا كان معرّف الطرف الأول الخاص بالناشر مفعَّلاً.

تفعّل هذه السمة أو توقف SDK لإعلانات Google على الأجهزة الجوّالة معرّف الطرف الأول الخاص بالناشر، المعروف سابقًا باسم مفتاح التطبيق نفسه.
انظر أيضًا
المعلمات
enabled: boolean يتم ضبط القيمة على "صحيح" لتفعيل معرّف الطرف الأول الخاص بالناشر، وعلى "خطأ" لإيقافه. القيمة التلقائية هي true.

setRequestConfiguration

setRequestConfiguration(_config): void
تضبط هذه السمة إعدادات الطلب العامة المتعلقة بالامتثال والاستهداف.

استخدِم هذه الطريقة لتحديد تفاصيل الاستهداف، مثل التقييم الأقصى للمحتوى الإعلاني وإعدادات الامتثال، مثل "علامة معالجة الطلبات حسب العمر"، ومعرّفات الأجهزة الاختبارية.
المعلمات
_config: RequestConfiguration

setUserControlledAppVolume

setUserControlledAppVolume(volume): void
تضبط هذه السمة مستوى صوت التطبيق الذي يتحكّم فيه المستخدم.

استخدِم هذه الطريقة لضبط مستوى صوت جميع الإعلانات مقارنةً بمخرجات الصوت الأخرى على الجهاز.
المعلمات
volume: number مستوى الصوت، بين 0.0 (صامت) و1.0 (الحد الأقصى) أي قيمة نقطة عائمة ضمن هذا النطاق تكون صالحة (على سبيل المثال، 0.001 أو 0.33333). ولا تقتصر القيمة على زيادات محدّدة في حجم الخطوة، مثل 0.1.

setUserMutedApp

setUserMutedApp(muted): void
تضبط هذه السمة ما إذا كان التطبيق مكتومًا.

استخدِم هذه الطريقة للتحكّم في حالة كتم الصوت الأولية للإعلانات اللاحقة.
المعلمات
muted: boolean تُستخدَم لتحديد ما إذا كان يجب كتم صوت التطبيق. القيمة التلقائية هي false.

showPrivacyOptionsForm

showPrivacyOptionsForm(onDismissed?): void
تعرض هذه الدالة نموذج خيارات الخصوصية.

تعرض هذه الدالة نموذج خيارات الخصوصية إذا كانت قيمة getPrivacyOptionsRequirementStatus هي REQUIRED.

يجب عدم استدعاء هذه الدالة إلا استجابةً لبيانات أدخلها المستخدم لطلب عرض نموذج خيارات الخصوصية.

يتم تحميل نموذج خيارات الخصوصية مسبقًا تلقائيًا من خلال حزمة تطوير البرامج (SDK) عندما يصبح النموذج متاحًا. في حال عدم التحميل المُسبَق لأي نموذج، ستحاول حزمة SDK تحميل نموذج بشكل غير متزامن.

يتم استدعاء معاودة الاتصال onDismissed بعد أن يتم عرض النموذج للمستخدم، ويختار أحد الخيارات، ثم يغلق النموذج. يمكن أن تعرض أيضًا FormError في الحالات التالية:
  • النموذج غير متوفّر.
  • يتعذّر عرض النموذج.
  • لا يزال النموذج قيد التحميل المُسبَق.
المعلمات
Optional onDismissed: ((error?) => void) يتم استدعاء دالة رد الاتصال عند إغلاق النموذج، مع FormError اختياري إذا تعذّر العرض.