کلاس: آگهی

گوگل ایما . آگهی

کلاس ایستا

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

مواد و روش ها

getAdId

getAdId() رشته را برمی گرداند

شناسه آگهی برای همگام سازی تبلیغات اصلی و تبلیغات همراه استفاده می شود.

برمی گرداند

string شناسه آگهی یا رشته خالی اگر این اطلاعات در دسترس نباشد.

getAdPodInfo

getAdPodInfo() AdPodInfo را برمی گرداند

اطلاعات غلاف آگهی را برمی گرداند.

برمی گرداند

non-null AdPodInfo اطلاعات غلاف آگهی.

getAdSystem

getAdSystem() رشته را برمی گرداند

منبع اطلاعات سرور آگهی موجود در پاسخ آگهی.

برمی گرداند

string سرور آگهی منبع آگهی یا رشته خالی اگر این اطلاعات در دسترس نباشد.

getAdvertiserName

getAdvertiserName() رشته را برمی گرداند

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

برمی گرداند

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

getApiFramework

getApiFramework() رشته را برمی گرداند

API مورد نیاز برای اجرای تبلیغ را شناسایی می کند. این با apiFramework مشخص شده در vast مطابقت دارد.

برمی گرداند

nullable string چارچوب API باید تبلیغ را اجرا کند، یا اگر این اطلاعات در دسترس نباشد، null شود.

getCompanionAds

getCompanionAds (adSlotWidth، adSlotHeight، تنظیمات) آرایه CompanionAd غیر تهی را برمی‌گرداند

آگهی‌های همراه برای این آگهی را بر اساس اندازه جایگاه آگهی همراه دریافت می‌کند. به صورت اختیاری، تنظیمات انتخاب پیشرفته پذیرفته می شود. توجه داشته باشید که این روش تنها آرایه‌های غیر خالی را برای نمونه‌های تبلیغاتی که در رویداد STARTED یا پس از آن به دست آمده‌اند، برمی‌گرداند. به طور خاص، تبلیغات از رویداد LOADED یک آرایه خالی را برمی گرداند.

پارامتر
adSlotWidth	عدد عرض جایگاه آگهی همراه.
adSlotHeight	عدد ارتفاع جایگاه آگهی همراه.
تنظیمات	اختیاری CompanionAdSelectionSettings تنظیمات انتخاب برای تبلیغات همراه. مقدار نباید صفر باشد.

برمی گرداند

non-null Array of non-null CompanionAd آرایه ای از تبلیغات همراه که با تنظیمات و اندازه اسلات مطابقت دارد.

getContentType

getContentType() رشته را برمی گرداند

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

برمی گرداند

string نوع محتوا، رشته خالی اگر در دسترس نباشد.

getCreativeAdId

getCreativeAdId() رشته را برمی گرداند

کد ISCI (شناسه تجاری استاندارد صنعتی) را برای یک تبلیغ برمی‌گرداند، یا اگر کد در دسترس نباشد، رشته خالی را برمی‌گرداند. این شناسه آگهی خلاق در پاسخ VAST است.

برمی گرداند

string

getCreativeId

getCreativeId() رشته را برمی گرداند

شناسه خلاقیت انتخاب شده برای آگهی را بازیابی می کند.

برمی گرداند

string شناسه خلاقیت انتخاب شده برای تبلیغ، یا رشته خالی اگر این اطلاعات در دسترس نباشد.

getDealId

getDealId() رشته را برمی گرداند

اولین شناسه معامله موجود در زنجیره بسته بندی آگهی فعلی را از بالا شروع می کند. اگر در دسترس نباشد رشته خالی را برمی گرداند.

برمی گرداند

string

getDescription

getDescription() رشته را برمی گرداند

شرح این آگهی را از پاسخ VAST برمی‌گرداند.

برمی گرداند

string توضیحات، اگر مشخص نشده باشد خالی است.

دریافت مدت

getDuration() عدد را برمی گرداند

مدت زمان خلاقیت انتخاب شده یا -1 را برای خلاقیت های غیرخطی برمی گرداند.

برمی گرداند

number مدت زمان خلاقیت انتخاب شده بر حسب ثانیه، -1 اگر غیرخطی باشد.

دریافت قد

getHeight() عدد را برمی گرداند

ارتفاع خلاقیت غیرخطی انتخاب شده را برمی‌گرداند.

برمی گرداند

number ارتفاع خلاقیت غیرخطی انتخاب شده یا 0 برای یک خلاقیت خطی.

getMediaUrl

getMediaUrl() رشته را برمی گرداند

URL فایل رسانه انتخاب شده از آگهی را بر اساس تنظیمات انتخاب رسانه در حال حاضر در حال استفاده برمی گرداند. اگر این اطلاعات در دسترس نباشد، پوچ برمی‌گرداند. در رویداد STARTED موجود است.

برمی گرداند

nullable string

getMinSuggestedDuration

getMinSuggestedDuration() عدد را برمی گرداند

حداقل مدت زمان پیشنهادی را بر حسب ثانیه برمی‌گرداند که خلاقیت غیرخطی باید نمایش داده شود. اگر حداقل مدت زمان پیشنهادی ناشناخته باشد -2 را برمی گرداند. برای خلاقیت خطی، کل مدت زمان تبلیغ را برمی گرداند.

برمی گرداند

number حداقل مدت زمان پیشنهادی بر حسب ثانیه که یک خلاقیت باید نمایش داده شود.

getSkipTimeOffset

getSkipTimeOffset() عدد را برمی گرداند

تعداد ثانیه های پخش قبل از اینکه تبلیغ قابل رد شدن باشد. -1 برای تبلیغات غیرقابل رد شدن یا در دسترس نبودن بازگردانده می شود.

برمی گرداند

number افست در ثانیه یا -1.

getSurveyUrl

getSurveyUrl() رشته را برمی گرداند

نشانی اینترنتی مرتبط با نظرسنجی آگهی داده شده را برمی گرداند. اگر در دسترس نباشد، پوچ برمی‌گرداند.

برمی گرداند

nullable string

getTitle

getTitle() رشته را برمی گرداند

عنوان این آگهی را از پاسخ VAST برمی گرداند.

برمی گرداند

string عنوان، اگر مشخص نشده باشد خالی است.

getTraffickingParameters

getTraffickingParameters() Object را با ویژگی های رشته برمی گرداند

پارامترهای سفارشی مرتبط با آگهی را در زمان قاچاق آگهی دریافت می کند.

برمی گرداند

non-null Object with string properties نقشه برداری از کلیدهای قاچاق به مقادیر آنها، یا اگر این اطلاعات در دسترس نباشد، شی خالی.

getTraffickingParametersString

getTraffickingParametersString() رشته را برمی گرداند

پارامترهای سفارشی مرتبط با آگهی را در زمان قاچاق آگهی دریافت می کند. یک نسخه رشته خام از پارامترهای تجزیه شده را از getTraffickingParameters برمی گرداند.

برمی گرداند

پارامترهای Trafficking string یا رشته خالی اگر این اطلاعات در دسترس نباشد.

getUiElements

getUiElements() آرایه رشته را برمی گرداند

عناصر رابط کاربری را که هنگام پخش این تبلیغ نمایش داده می شوند، برمی گرداند. برای عناصر احتمالی آرایه برگشتی به UiElements مراجعه کنید.

برمی گرداند

non-null Array of string عناصر رابط کاربری در حال نمایش.

getUniversalAdIdRegistry

getUniversalAdIdRegistry() رشته را برمی گرداند

رجیستری مرتبط با فهرست نویسی UniversalAdId خلاقیت انتخاب شده برای آگهی.

منسوخ

به جای آن از ad.getUniversalAdIds() استفاده کنید

برمی گرداند

string مقدار رجیستری یا "ناشناخته" را در صورت در دسترس نبودن برمی گرداند.

getUniversalAdIdValue

getUniversalAdIdValue() رشته را برمی گرداند

UniversalAdId خلاقیت انتخاب شده برای آگهی.

منسوخ

به جای آن از ad.getUniversalAdIds() استفاده کنید

برمی گرداند

string مقدار id یا "ناشناخته" را در صورت در دسترس نبودن برمی گرداند.

getUniversalAdIds

getUniversalAdIds() آرایه ای از UniversalAdIdInfo غیر تهی را برمی گرداند

فهرست UniversalAdIds خلاقیت انتخاب شده برای آگهی.

برمی گرداند

non-null Array of non-null UniversalAdIdInfo فهرستی از اطلاعات شناسه آگهی جهانی را که برای این آگهی اعمال می شود، برمی گرداند.

getVastMediaBitrate

getVastMediaBitrate() عدد را برمی گرداند

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

برمی گرداند

number میزان بیت برای فایل رسانه انتخاب شده یا 0.

getVastMediaHeight

getVastMediaHeight() عدد را برمی گرداند

ارتفاع رسانه VAST خلاقیت انتخاب شده را برمی‌گرداند.

برمی گرداند

number ارتفاع رسانه VAST خلاقیت انتخاب شده یا 0 اگر هیچ کدام انتخاب نشده باشد.

getVastMediaWidth

getVastMediaWidth() عدد را برمی گرداند

عرض رسانه VAST خلاقیت انتخاب شده را برمی گرداند.

برمی گرداند

number عرض رسانه VAST خلاقیت انتخاب شده یا 0 اگر هیچ کدام انتخاب نشده باشد.

getWidth

getWidth() عدد را برمی گرداند

عرض خلاقیت انتخاب شده را برمی گرداند.

برمی گرداند

number عرض خلاقیت غیر خطی انتخاب شده یا 0 برای یک خلاقیت خطی.

getWrapperAdIds

getWrapperAdIds() آرایه رشته را برمی گرداند

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

برمی گرداند

non-null Array of string شناسه‌های تبلیغات، که از آگهی درون خطی شروع می‌شوند، یا یک آرایه خالی در صورت عدم وجود آگهی‌های بسته‌بندی.

getWrapperAdSystems

getWrapperAdSystems() آرایه رشته را برمی گرداند

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

برمی گرداند

non-null Array of string سیستم های تبلیغاتی تبلیغات، که از آگهی درون خطی شروع می شوند، یا یک آرایه خالی در صورت عدم وجود تبلیغات پوششی.

getWrapperCreativeIds

getWrapperCreativeIds() آرایه رشته را برمی گرداند

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

برمی گرداند

non-null Array of string شناسه‌های خلاقیت‌های تبلیغات، که از آگهی درون خطی شروع می‌شوند، یا یک آرایه خالی در صورت عدم وجود آگهی‌های بسته‌بندی.

خطی است

isLinear() بولی را برمی گرداند

خطی یا غیرخطی بودن حالت فعلی تبلیغ را نشان می دهد. اگر مقدار درست باشد، نشان می دهد که تبلیغ در حالت پخش خطی است. اگر نادرست باشد، حالت غیر خطی را نشان می دهد. بازیکن ویژگی خطی را بررسی می کند و وضعیت آن را با توجه به جزئیات قرار دادن آگهی به روز می کند. در حالی که تبلیغ در حالت خطی است، پخش کننده ویدیوی محتوا را متوقف می کند. اگر خطی در ابتدا درست باشد، و تبلیغ یک پیش نمایش باشد (تعریف شده خارجی)، پخش کننده ممکن است بارگیری محتوای ویدیو را تا پایان پخش آگهی به تاخیر بیندازد.

برمی گرداند

اگر boolean خطی باشد درست است، در غیر این صورت نادرست است.