گوگل ایما . Ads Manager
API عمومی بیرونی را در اختیار ناشر قرار می دهد و با نمونه داخلی مدیر تبلیغات ارتباط برقرار می کند.
مواد و روش ها
سقوط - فروپاشی
سقوط - فروپاشی()
آگهی فعلی را جمع کنید. این بدون عملیات برای HTML5 SDK است.
configureAdsManager
configureAdsManager (محتوا، adsRenderingSettings)
پارامترهای لازم را برای دریافت ارجاع به این AdManager از رویداد AdsManagerLoaded تنظیم می کند.
پارامتر | |
|---|---|
محتوا | هدف - شی شیئی که محتوای ناشر را پخش می کند. مقدار نباید صفر باشد. |
adsRenderingSettings | اختیاری AdsRenderingSettings تنظیمات اختیاری برای کنترل رندر تبلیغات. مقدار ممکن است صفر باشد. |
از بین رفتن
از بین رفتن()
دارایی های تبلیغاتی بارگذاری شده در زمان اجرا را که باید در زمان تکمیل آگهی به درستی حذف شوند حذف می کند و تبلیغات و همه ردیابی ها را متوقف می کند.
discardAdBreak
DiscardAdBreak()
اگر در حال حاضر یک وقفه تبلیغاتی در حال پخش است، آن را دور بیندازید و محتوا را از سر بگیرید. در غیر این صورت، وقفه تبلیغاتی برنامه ریزی شده بعدی را نادیده بگیرید. برای مثال، بلافاصله پس از بارگیری مدیر تبلیغات، می‌توان آن را فراخوانی کرد تا یک پیش‌پرول را بدون از دست دادن میان‌دول‌ها یا پس‌ترول‌های آینده نادیده بگیرد. این غیرفعال است مگر اینکه درخواست آگهی یک لیست پخش یا پاسخ VMAP را برگرداند.
بسط دادن
بسط دادن()
تبلیغ فعلی را گسترش دهید. این بدون عملیات برای HTML5 SDK است.
تمرکز
تمرکز()
در صورت وجود، روی دکمه پرش تمرکز می کند. اگر وجود نداشته باشد، تمرکز بر عناصر تعاملی، از جمله نمادها یا خلاقیت های تعاملی است.
getAdSkippableState
getAdSkippableState() بولی را برمی گرداند
اگر در حال حاضر بتوان تبلیغ را نادیده گرفت، درست است. وقتی این مقدار تغییر می‌کند، AdsManager یک رویداد AdEvent.SKIPPABLE_STATE_CHANGED را اجرا می‌کند.
- برمی گرداند
booleanدرست است اگر در حال حاضر بتوان تبلیغ را نادیده گرفت، در غیر این صورت نادرست است.
getCuePoints
getCuePoints() آرایه اعداد را برمی گرداند
آرایه‌ای از افست‌ها را در چند ثانیه برمی‌گرداند که نشان می‌دهد چه زمانی یک استراحت تبلیغاتی برنامه‌ریزی‌شده پخش می‌شود. یک preroll با 0 و یک postroll با -1 نشان داده می شود. یک آرایه خالی نشان می‌دهد که آگهی یا غلاف آگهی هیچ برنامه زمانی ندارد و می‌تواند در هر زمانی پخش شود.
- برمی گرداند
non-null Array of numberفهرستی از انحراف زمانی بر حسب ثانیه.
getRemainingTime
getRemainingTime() عدد را برمی گرداند
زمان باقیمانده آگهی فعلی که در حال پخش است را دریافت کنید. اگر تبلیغ هنوز بارگیری نشده باشد یا پخش آن تمام شده باشد، API -1 برمی گردد.
- برمی گرداند
numberزمان باقی مانده برای تبلیغ فعلی را برمی گرداند. اگر زمان باقیمانده برای تبلیغ فعلی (مثلاً تبلیغات سفارشی) تعریف نشده باشد، مقدار -1 برمی گردد.
دریافت حجم
getVolume() عدد را برمی گرداند
حجم آگهی فعلی را دریافت کنید.
- برمی گرداند
numberحجم آگهی فعلی، از 0 (بی صدا) تا 1 (بلندترین).
init
init (عرض، ارتفاع، حالت نمایش، عنصر ویدئو)
با init تماس بگیرید تا تجربه تبلیغات را در مدیر تبلیغات راه اندازی کنید.
پارامتر | |
|---|---|
عرض | عدد عرض انتخاب شده آگهی. |
ارتفاع | عدد ارتفاع انتخاب شده آگهی. |
حالت دید | حالت نمایش حالت نمایش انتخاب شده مقدار نباید صفر باشد. |
عنصر ویدئو | اختیاری HTMLVideoElement عنصر ویدیو برای پخش سفارشی. این عنصر ویدیویی، عنصر ارائه شده در سازنده AdDisplayContainer را لغو می کند. فقط در صورت لزوم از این ویژگی استفاده کنید - در غیر این صورت توصیه می کنیم هنگام ایجاد AdDisplayContainer، این عنصر ویدیو را مشخص کنید. مقدار ممکن است صفر باشد. |
isCustomClickTrackingUsed
isCustomClickTrackingUsed() بولی را برمی گرداند
اگر یک عنصر ردیابی کلیک سفارشی برای ردیابی کلیک در تبلیغ فعلی استفاده شود، درست برمی گردد. ردیابی کلیک سفارشی تنها زمانی استفاده می‌شود که یک عنصر ردیابی کلیک اختیاری در AdDisplayContainer ارائه شود، از پخش سفارشی استفاده شود و تبلیغ فعلی یک تبلیغ AdSense/AdX نباشد.
- برمی گرداند
booleanآیا از ردیابی کلیک سفارشی استفاده می شود.
isCustomPlaybackUsed است
isCustomPlaybackUsed() بولی را برمی گرداند
اگر از یک عنصر ویدیوی سفارشی برای پخش آگهی فعلی استفاده شود، درست برمی‌گردد. پخش سفارشی زمانی اتفاق می‌افتد که یک عنصر ویدیوی اختیاری به AdDisplayContainer در پلت‌فرم‌هایی ارائه می‌شود که یک عنصر ویدیوی سفارشی تجربه تماشای آگهی بدون درز تری را ارائه می‌دهد.
- برمی گرداند
booleanآیا از پخش سفارشی استفاده می شود.
مکث
مکث()
تبلیغ فعلی را که در حال پخش است متوقف می کند. هنگامی که یک پوشش ثابت نشان داده می شود یا اگر تبلیغ هنوز بارگیری نشده باشد یا پخش آن تمام شده باشد، این تابع بدون عملیات خواهد بود.
تغییر اندازه
تغییر اندازه (عرض، ارتفاع، حالت نمایش)
اندازه آگهی فعلی را تغییر می دهد.
پارامتر | |
|---|---|
عرض | عدد عرض جایگاه آگهی جدید. |
ارتفاع | عدد ارتفاع جایگاه آگهی جدید. |
حالت دید | حالت نمایش حالت نمایش جدید مقدار نباید صفر باشد. |
از سرگیری
از سرگیری()
آگهی فعلی را که بارگیری و متوقف شده است از سر می گیرد. هنگامی که یک پوشش ثابت نشان داده می شود یا اگر تبلیغ هنوز بارگیری نشده باشد یا پخش آن تمام شده باشد، این تابع بدون عملیات خواهد بود.
تنظیم حجم
تنظیم حجم (حجم)
حجم آگهی فعلی را تنظیم کنید.
پارامتر | |
|---|---|
جلد | عدد میزان صدا برای تنظیم، از 0 (بی صدا) تا 1 (بلندترین). |
جست و خیز کردن
پرش ()
زمانی که AdsManager.getAdSkippableState() true باشد از تبلیغ فعلی رد می شود. هنگامی که تحت شرایط دیگر فراخوانی می شود، پرش تاثیری ندارد. پس از تکمیل پرش، AdsManager یک رویداد AdEvent.SKIPPED را اجرا می کند.
شروع کنید
شروع ()
شروع به پخش تبلیغات کنید.
توسعه دهندگان باید ابتدا AdDisplayContainer.initialize() را فراخوانی کنند.
متوقف کردن
متوقف کردن()
پخش تبلیغات را متوقف کنید تماس با این، ناشر را به محتوا باز می گرداند.
updateAdsRenderingSettings
updateAdsRenderingSettings(adsRenderingSettings)
تنظیمات رندر تبلیغات را به روز می کند. این باید به طور خاص برای موارد استفاده از VMAP بین وقفه های تبلیغاتی استفاده شود، زمانی که تنظیمات رندر تبلیغات مانند نرخ بیت باید به روز شوند.
پارامتر | |
|---|---|
adsRenderingSettings | AdsRenderingSettings تنظیمات رندر تبلیغات به روز شده مقدار نباید صفر باشد. |