فضای نام: ima، فضای نام: ima

گوگل ایما

فضای نام ایستا

فضای نام google.ima دسترسی به کلاس‌ها، رابط‌ها، شمارش‌ها و ویژگی‌های SDK را فراهم می‌کند.

کلاس ها

آگهی

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

AdCuePoints

لیست نقطه نشانه یک برنامه زمانی وقفه های تبلیغاتی را نشان می دهد. توجه داشته باشید که تبلیغات تکی در وقفه تبلیغاتی در جدول زمانی گنجانده نشده است.

AdDisplayContainer

این کلاس نشان دهنده یک ظرف برای نمایش تبلیغات است. SDK به طور خودکار ساختارهایی را در داخل پارامتر containerElement ایجاد می کند تا تبلیغات ویدیویی و همپوشانی را در خود جای دهد.

هنگامی که نمونه ای از این کلاس ایجاد می شود، یک IFRAME در containerElement ایجاد می کند و هسته SDK را بارگذاری می کند. این IFRAME باید حفظ شود تا SDK به درستی کار کند. هنگامی که همه تبلیغات پخش شدند و دیگر نیازی به SDK نیست، از متد destroy() struct برای تخلیه SDK استفاده کنید.

پارامتر containerElement باید عنصری باشد که بخشی از DOM است. برای اینکه تبلیغات به درستی نمایش داده شوند لازم است که containerElement به درستی قرار گیرد. توصیه می شود آن را در بالای پخش کننده ویدیوی محتوا قرار دهید و اندازه آن را به گونه ای تنظیم کنید که کل پخش کننده ویدیو را پوشش دهد. برای جزئیات در مورد پیاده سازی های توصیه شده به مستندات SDK مراجعه کنید.

توجه: همیشه لازم است که متد initialize() را در کدی که مستقیماً توسط یک عمل کاربر فراخوانی شده است (مانند کلیک یا ضربه) فراخوانی کنید.

AdError

AdError اطلاعاتی را در مورد اینکه آیا در حین بارگیری یا پخش تبلیغ رخ داده است یا خیر، به کاربر ارائه می دهد. ابزار دسترسی errorType اطلاعاتی در مورد اینکه آیا خطا در حین بارگیری یا پخش آگهی رخ داده است ارائه می دهد.

AdErrorEvent

این رویداد زمانی مطرح می شود که هنگام بارگیری آگهی از سرورهای Google یا DoubleClick خطایی رخ دهد. انواعی که می توانید برای رویداد ثبت نام کنید AdsLoader و AdsManager هستند.

AdEvent

این نوع رویداد توسط آگهی به عنوان یک اعلان در هنگام تغییر وضعیت آگهی و زمانی که کاربران با آگهی تعامل می کنند، مطرح می شود. به عنوان مثال، هنگامی که تبلیغ شروع به پخش می کند، روی آن کلیک می شود و موارد دیگر. می توانید برای رویدادهای مختلف تغییر وضعیت در AdsManager ثبت نام کنید.

AdMetadataEvent

این کلاس منسوخ شده است. از API AdsManager.getCuePoints() استفاده کنید. یک رویداد تبلیغاتی خاص که دارای ابرداده است.

AdPodInfo

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

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

AdProgressData

این شیء اطلاعاتی را در مورد پیشرفت فعلی در حین پخش آگهی نمایش می دهد.

AdsLoader

AdsLoader به مشتریان این امکان را می دهد که از سرورهای تبلیغاتی درخواست تبلیغات کنند. برای انجام این کار، کاربران باید برای رویداد AdsManagerLoadedEvent ثبت نام کنند و سپس درخواست تبلیغات کنند.

Ads Manager

API عمومی بیرونی را در اختیار ناشر قرار می دهد و با نمونه داخلی مدیر تبلیغات ارتباط برقرار می کند.

AdsManagerLoadedEvent

این رویداد زمانی مطرح می شود که تبلیغات با موفقیت از سرورهای تبلیغاتی Google یا DoubleClick از طریق AdsLoader بارگیری شوند. می توانید برای این رویداد در AdsLoader ثبت نام کنید.

AdsRenderingSettings

پارامترهایی را تعریف می کند که رندر تبلیغات را کنترل می کنند.

AdsRequest

کلاسی برای مشخص کردن ویژگی های درخواست تبلیغ.

CompanionAd

نشان دهنده یک تبلیغ همراه است.

CompanionAdSelectionSettings

شی CompanionAdSelectionSettings برای تعریف معیارهای انتخاب هنگام فراخوانی تابع ima.Ad.getCompanionAds استفاده می شود.

ImaSdkSettings

این کلاس شامل تنظیمات گسترده SDK است.

UniversalAdIdInfo

این شی اطلاعات مربوط به شناسه آگهی جهانی مرتبط با خلاقیت، از جمله مقدار شناسه آگهی و ثبت شناسه آگهی را نشان می دهد.

شمارش ها

OmidAccess Mode

ثابت ثابت

رشته

حالت‌های دسترسی موجود برای OMID برای وب، که میزان دسترسی اسکریپت تأیید را کنترل می‌کند.

ارزش
محدود	اسکریپت تأیید در جعبه ایمنی است و نمی‌تواند به صفحه خلاق یا ناشر دسترسی پیدا کند و نمی‌تواند مستقیماً تأیید کند که در کدام دامنه ناشر قرار دارد.
دامنه	اسکریپت تأیید در جعبه ایمنی است و نمی‌تواند به صفحه خلاق یا ناشر دسترسی پیدا کند. با این حال، اسکریپت به گونه ای بارگذاری می شود که می تواند مستقیماً تأیید کند که در کدام دامنه ناشر قرار دارد.
پر شده	اسکریپت تأیید دسترسی مستقیم به صفحه خلاق و ناشر دارد.

OmidVerificationVendor

ثابت ثابت

عدد

یک فروشنده تأییدیه OMID را شناسایی می کند. فروشندگان به ترتیب حروف الفبا فهرست شده اند.

ارزش
COMSCORE
دوبرابر کردن
GOOGLE
INTEGRAL_AD_SCIENCE
متریک
خندق
نیلسن
PIXELATE
دیگر	فروشنده پیش‌فرض برای استفاده زمانی که URL اسکریپت با هیچ فروشنده دیگری مطابقت ندارد.

UiElements

ثابت ثابت

رشته

Enum عناصر مختلف UI را مشخص می کند که می توانند برای نمایش یا پنهان کردن پیکربندی شوند. این تنظیمات ممکن است برای تبلیغات AdSense و ADX نادیده گرفته شود.

ارزش
AD_ATTRIBUTION	متن "تبلیغ" را در رابط کاربری تبلیغات نمایش می دهد. برای نمایش تایمر شمارش معکوس باید حضور داشته باشد.
شمارش معکوس	برای نمایش تایمر شمارش معکوس، ذکر آگهی لازم است. هر دو google.ima.UiElements.COUNTDOWN و google.ima.UiElements.AD_ATTRIBUTION باید در AdsRenderingSettings.uiElements وجود داشته باشند.

حالت نمایش

ثابت ثابت

رشته

Enum حالت های مختلف مشاهده VPAID را برای تبلیغات مشخص می کند.

ارزش
طبیعی	حالت مشاهده آگهی معمولی
تمام صفحه	حالت نمایش تبلیغات تمام صفحه به مدیر تبلیغات نشان می دهد که ناشر ترتیب فعلی AdDisplayContainer را به عنوان تمام صفحه (به عنوان مثال، تمام صفحه شبیه سازی شده) در نظر می گیرد. این باعث نمی شود که مدیر تبلیغات وارد تمام صفحه شود.

منسوخ

خواص

OmidAccess Mode

ثابت ثابت

رشته

حالت‌های دسترسی موجود برای OMID برای وب، که میزان دسترسی اسکریپت تأیید را کنترل می‌کند.

ارزش
محدود	اسکریپت تأیید در جعبه ایمنی است و نمی‌تواند به صفحه خلاق یا ناشر دسترسی پیدا کند و نمی‌تواند مستقیماً تأیید کند که در کدام دامنه ناشر قرار دارد.
دامنه	اسکریپت تأیید در جعبه ایمنی است و نمی‌تواند به صفحه خلاق یا ناشر دسترسی پیدا کند. با این حال، اسکریپت به گونه ای بارگذاری می شود که می تواند مستقیماً تأیید کند که در کدام دامنه ناشر قرار دارد.
پر شده	اسکریپت تأیید دسترسی مستقیم به صفحه خلاق و ناشر دارد.

OmidVerificationVendor

ثابت ثابت

عدد

یک فروشنده تأییدیه OMID را شناسایی می کند. فروشندگان به ترتیب حروف الفبا فهرست شده اند.

ارزش
COMSCORE
دوبرابر کردن
GOOGLE
INTEGRAL_AD_SCIENCE
متریک
خندق
نیلسن
PIXELATE
دیگر	فروشنده پیش‌فرض برای استفاده زمانی که URL اسکریپت با هیچ فروشنده دیگری مطابقت ندارد.

UiElements

ثابت ثابت

رشته

Enum عناصر مختلف UI را مشخص می کند که می توانند برای نمایش یا پنهان کردن پیکربندی شوند. این تنظیمات ممکن است برای تبلیغات AdSense و ADX نادیده گرفته شود.

ارزش
AD_ATTRIBUTION	متن "تبلیغ" را در رابط کاربری تبلیغات نمایش می دهد. برای نمایش تایمر شمارش معکوس باید حضور داشته باشد.
شمارش معکوس	برای نمایش تایمر شمارش معکوس، ذکر آگهی لازم است. هر دو google.ima.UiElements.COUNTDOWN و google.ima.UiElements.AD_ATTRIBUTION باید در AdsRenderingSettings.uiElements وجود داشته باشند.

حالت نمایش

ثابت ثابت

رشته

Enum حالت های مختلف مشاهده VPAID را برای تبلیغات مشخص می کند.

ارزش
طبیعی	حالت مشاهده آگهی معمولی
تمام صفحه	حالت نمایش تبلیغات تمام صفحه به مدیر تبلیغات نشان می دهد که ناشر ترتیب فعلی AdDisplayContainer را به عنوان تمام صفحه (به عنوان مثال، تمام صفحه شبیه سازی شده) در نظر می گیرد. این باعث نمی شود که مدیر تبلیغات وارد تمام صفحه شود.

منسوخ

تنظیمات

ثابت ثابت

تنظیمات غیر تهی ImaSdk

نمونه تنظیمات جهانی singleton.