این مرجع از نماد TypeScript برای توصیف انواع استفاده می کند. جدول زیر با مثال توضیح مختصری ارائه می دهد.
عبارت را تایپ کنید | |
---|---|
string | نوع رشته ابتدایی. |
string[] | یک نوع آرایه، که در آن مقادیر فقط ممکن است رشته باشند. |
number | string | یک نوع اتحادیه، که در آن مقدار ممکن است یک عدد یا یک رشته باشد. |
Array<number | string> | یک نوع آرایه، که در آن مقادیر یک نوع پیچیده (اتحادیه) هستند. |
[number, string] | یک نوع تاپل، که در آن مقدار یک آرایه دو عنصری است که باید یک عدد و یک رشته به ترتیب داشته باشد. |
Slot | یک نوع شی، که در آن مقدار یک نمونه از googletag.Slot است. |
() => void | یک نوع تابع بدون آرگومان تعریف شده و بدون مقدار بازگشتی. |
برای اطلاعات بیشتر در مورد انواع پشتیبانی شده و عبارات نوع، به راهنمای TypeScript مراجعه کنید.
حاشیه نویسی را تایپ کنید
دو نقطه بعد از یک متغیر، نام پارامتر، نام ویژگی یا امضای تابع نشان دهنده یک نوع حاشیه نویسی است. حاشیه نویسی نوع، انواعی را که عنصر در سمت چپ کولون می تواند بپذیرد یا برگرداند، توصیف می کند. جدول زیر نمونه هایی از حاشیه نویسی نوع را نشان می دهد که ممکن است در این مرجع مشاهده کنید.
حاشیه نویسی را تایپ کنید | |
---|---|
param: string | نشان می دهد که param یک مقدار رشته را می پذیرد یا برمی گرداند. این نحو برای متغیرها، پارامترها، خصوصیات و انواع برگشتی استفاده می شود. |
param?: number | string | نشان می دهد که param اختیاری است، اما در صورت مشخص شدن یک عدد یا یک رشته را می پذیرد. این نحو برای پارامترها و خصوصیات استفاده می شود. |
...params: Array<() => void> | نشان می دهد که params یک پارامتر استراحت است که توابع را می پذیرد. پارامترهای Rest تعداد نامحدودی از مقادیر از نوع مشخص شده را می پذیرند. |
googletag
فضاهای نام | |
---|---|
config | رابط پیکربندی اصلی برای تنظیمات سطح صفحه. |
enums | این فضای نامی است که GPT برای انواع enum استفاده می کند. |
events | این فضای نامی است که GPT برای رویدادها استفاده می کند. |
secure Signals | این فضای نامی است که GPT برای مدیریت سیگنال های امن استفاده می کند. |
رابط ها | |
---|---|
Command Array | آرایه فرمان دنباله ای از توابع را می پذیرد و آنها را به ترتیب فراخوانی می کند. |
Companion Ads Service | سرویس تبلیغات همراه. |
Privacy Settings Config | شی پیکربندی برای تنظیمات حریم خصوصی. |
Pub Ads Service | سرویس تبلیغات ناشر. |
Response Information | شیئی که نشان دهنده یک پاسخ آگهی واحد است. |
Rewarded Payload | یک شی که نشان دهنده پاداش مرتبط با یک تبلیغ پاداش است. |
Safe Frame Config | شیء پیکربندی برای ظروف SafeFrame . |
Service | کلاس سرویس پایه که شامل متدهای مشترک برای همه سرویس ها است. |
Size Mapping Builder | سازنده برای اشیاء مشخصات نقشه برداری اندازه. |
Slot | Slot یک شی است که نشان دهنده یک جایگاه آگهی در یک صفحه است. |
نام مستعار را تایپ کنید | |
---|---|
General Size | یک پیکربندی اندازه معتبر برای یک اسلات، که می تواند یک یا چند اندازه باشد. |
Multi Size | لیستی از اندازه های معتبر تکی. |
Named Size | اندازه های نامگذاری شده ای که یک اسلات می تواند داشته باشد. |
Single Size | یک اندازه معتبر برای یک اسلات. |
Single Size Array | آرایه ای از دو عدد که نشان دهنده [عرض، ارتفاع] است. |
Size Mapping | نگاشت اندازه نمایش به اندازه تبلیغات. |
Size Mapping Array | لیستی از نگاشت اندازه |
متغیرها | |
---|---|
api Ready | پرچمی که نشان می دهد GPT API بارگیری شده و آماده فراخوانی است. |
cmd | ارجاع به صف فرمان جهانی برای اجرای ناهمزمان تماس های مربوط به GPT. |
pubads Ready | پرچمی که نشان می دهد PubAdsService فعال، بارگیری شده و کاملاً عملیاتی است. |
secure Signal Providers | ارجاع به آرایه ارائه دهندگان سیگنال امن. |
توابع | |
---|---|
companion Ads | مرجعی را به CompanionAdsService برمی گرداند. |
define Out Of Page Slot | با مسیر واحد آگهی داده شده، یک جایگاه تبلیغاتی خارج از صفحه ایجاد می کند. |
define Slot | یک جایگاه تبلیغاتی با یک مسیر و اندازه واحد تبلیغاتی معین می سازد و آن را با شناسه یک عنصر div در صفحه ای که حاوی آگهی است مرتبط می کند. |
destroy Slots | اسلات های داده شده را از بین می برد و تمام اشیاء مرتبط و مراجع آن اسلات ها را از GPT حذف می کند. |
disable Publisher Console | کنسول Google Publisher را غیرفعال می کند. |
display | به خدمات اسلات دستور می دهد تا اسلات را ارائه دهند. |
enable Services | همه سرویسهای GPT را که برای اسلات تبلیغاتی در صفحه تعریف شدهاند، فعال میکند. |
get Version | نسخه فعلی GPT را برمیگرداند. |
open Console | Google Publisher Console را باز می کند. |
pubads | مرجعی را به PubAdsService برمی گرداند. |
set Ad Iframe Title | عنوان را برای همه iframe های کانتینر آگهی ایجاد شده توسط PubAdsService از این مرحله به بعد تنظیم می کند. |
set Config | گزینه های پیکربندی کلی صفحه را تنظیم می کند. |
size Mapping | یک SizeMappingBuilder جدید ایجاد می کند. |
نام مستعار را تایپ کنید
جنرال سایز
GeneralSize : SingleSize | MultiSize
چند سایز
MultiSize : SingleSize []
NamedSize
NamedSize : "fluid" | [ "fluid" ]
- مایع : ظرف تبلیغات 100% عرض div والد را می گیرد و سپس ارتفاع آن را تغییر می دهد تا متناسب با محتوای خلاقانه باشد. مشابه رفتار عناصر بلوک معمولی در یک صفحه. برای تبلیغات بومی استفاده می شود ( مقاله مرتبط را ببینید). توجه داشته باشید که هم
fluid
و هم['fluid']
اشکال قابل قبولی برای اعلام اندازه شکاف به عنوان سیال هستند.
تک سایز
SingleSize : SingleSizeArray | NamedSize
SingleSizeArray
SingleSizeArray : [ number , number ]
SizeMapping
SizeMapping : [ SingleSizeArray , GeneralSize ]
SizeMappingArray
SizeMappingArray : SizeMapping []
متغیرها
Const
apiReady
apiReady : boolean | undefined
undefined
است.توجه داشته باشید که روش توصیه شده برای مدیریت async این است که از googletag.cmd برای قرار دادن تماسها در صف برای زمانی که GPT آماده است استفاده کنید. این تماسهای برگشتی نیازی به بررسی googletag.apiReady ندارند، زیرا اجرای آنها پس از راهاندازی API تضمین میشود.
cmd را Const
cmd : ( ( this : typeof globalThis ) => void ) [] | CommandArray
متغیر
googletag.cmd
به یک آرایه خالی جاوا اسکریپت توسط نحو تگ GPT در صفحه مقداردهی اولیه می شود و cmd.push
روش استاندارد Array.push
است که یک عنصر را به انتهای آرایه اضافه می کند. هنگامی که جاوا اسکریپت GPT بارگذاری می شود، از طریق آرایه نگاه می کند و همه توابع را به ترتیب اجرا می کند. سپس اسکریپت cmd
با یک شی CommandArray جایگزین می کند که متد فشار آن برای اجرای آرگومان تابع ارسال شده به آن تعریف شده است. این مکانیسم به GPT اجازه میدهد تا تأخیر درک شده را با واکشی ناهمزمان جاوا اسکریپت کاهش دهد و در عین حال به مرورگر اجازه میدهد به رندر صفحه ادامه دهد.- مثال
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
Const
pubadsReady
pubadsReady : boolean | undefined
undefined
است. SecuritySignalProviders
secureSignalProviders : SecureSignalProvider [] | SecureSignalProvidersArray | undefined
آرایه ارائه دهندگان سیگنال امن، دنباله ای از توابع تولید کننده سیگنال را می پذیرد و آنها را به ترتیب فراخوانی می کند. در نظر گرفته شده است که جایگزین آرایه استانداردی شود که برای قرار دادن توابع مولد سیگنال برای فراخوانی پس از بارگیری GPT استفاده می شود.
- مثال
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- همچنین ببینید
توابع
companionAds
companionAds ( ) : CompanionAdsService
برمی گرداند | |
---|---|
CompanionAdsService | سرویس تبلیغات همراه. |
تعریف OutOfPageSlot
defineOutOfPageSlot ( adUnitPath : string , div ?: string | OutOfPageFormat ) : Slot | null
برای تبلیغات سفارشی خارج از صفحه،
div
شناسه عنصر div است که حاوی آگهی است. برای جزئیات بیشتر به مقاله در مورد خلاقیت های خارج از صفحه مراجعه کنید.برای تبلیغات خارج از صفحه مدیریت شده GPT،
div
یک OutOfPageFormat پشتیبانی شده است.- مثال
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- همچنین ببینید
پارامترها | |
---|---|
adUnitPath : string | مسیر کامل واحد تبلیغات با کد شبکه و کد واحد تبلیغات. |
| شناسه div که حاوی این واحد تبلیغات یا OutOfPageFormat است. |
برمی گرداند | |
---|---|
Slot | null | اسلات تازه ایجاد شده، یا اگر شکافی ایجاد نشود، null . |
تعریف اسلات
defineSlot ( adUnitPath : string , size : GeneralSize , div ?: string ) : Slot | null
- مثال
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- همچنین ببینید
پارامترها | |
---|---|
adUnitPath : string | مسیر کامل واحد تبلیغات با کد شبکه و کد واحد. |
size : GeneralSize | عرض و ارتفاع شکاف اضافه شده. این اندازه ای است که در درخواست تبلیغ استفاده می شود اگر نگاشت اندازه واکنشگرا ارائه نشده باشد یا اندازه نمای درگاه کوچکتر از کوچکترین اندازه ارائه شده در نقشه باشد. |
| شناسه div که حاوی این واحد تبلیغاتی است. |
برمی گرداند | |
---|---|
Slot | null | اسلات تازه ایجاد شده، یا اگر شکافی ایجاد نشود، null . |
اسلات ها را نابود می کند
destroySlots ( slots ?: Slot [] ) : boolean
فراخوانی این API در یک اسلات، آگهی را پاک می کند و شی شکاف را از حالت داخلی که توسط GPT حفظ می شود، حذف می کند. فراخوانی هر تابع دیگری در شیء شکاف منجر به رفتار نامشخص می شود. توجه داشته باشید که اگر صفحه ناشر به آن اشاره ای داشته باشد، ممکن است مرورگر همچنان حافظه مرتبط با آن اسلات را آزاد نکند. فراخوانی این API باعث می شود که div مرتبط با آن اسلات برای استفاده مجدد در دسترس باشد.
به ویژه، از بین بردن یک اسلات، آگهی را از نمای صفحه طولانی مدت GPT حذف میکند، بنابراین درخواستهای آینده تحت تأثیر موانع یا استثناهای رقابتی مربوط به این آگهی قرار نمیگیرند. عدم فراخوانی این تابع قبل از حذف div شکاف از صفحه منجر به رفتار نامشخص می شود.
- مثال
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
پارامترها | |
---|---|
| آرایه ای از اسلات برای از بین بردن. آرایه اختیاری است. تمام اسلات ها در صورت نامشخص بودن از بین می روند. |
برمی گرداند | |
---|---|
boolean | true اگر شکاف ها از بین رفته باشند، در غیر این صورت false . |
disablePublisherConsole
disablePublisherConsole ( ) : void
- همچنین ببینید
نمایش داده شود
display ( divOrSlot : string | Element | Slot ) : void
اگر از معماری تک درخواست (SRA) استفاده شود، تمام اسلات های تبلیغاتی واکشی نشده در زمانی که این روش فراخوانی می شود، به یکباره واکشی می شوند. برای اینکه یک شکاف آگهی نمایش داده نشود، کل div باید حذف شود.
- همچنین ببینید
پارامترها | |
---|---|
divOrSlot : string | Element | Slot | شناسه عنصر div حاوی شکاف آگهی یا عنصر div یا شی شکاف. اگر یک عنصر div ارائه شده باشد، باید یک ویژگی 'id' داشته باشد که با شناسه ارسال شده به defineSlot مطابقت داشته باشد. |
enableServices
enableServices ( ) : void
getVersion
getVersion ( ) : string
- همچنین ببینید
برمی گرداند | |
---|---|
string | رشته نسخه GPT در حال اجرا. |
openConsole
openConsole ( div ?: string ) : void
- مثال
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- همچنین ببینید
پارامترها | |
---|---|
| شناسه div اسلات آگهی. این مقدار اختیاری است. هنگامی که ارائه شد، کنسول ناشر تلاش می کند تا با جزئیات فضای تبلیغاتی مشخص شده باز شود. |
pubads
pubads ( ) : PubAdsService
برمی گرداند | |
---|---|
PubAdsService | سرویس تبلیغات ناشر. |
setAdIframeTitle
setAdIframeTitle ( title : string ) : void
- مثال
googletag.setAdIframeTitle("title");
googletag.setAdIframeTitle("title");
googletag.setAdIframeTitle("title");
پارامترها | |
---|---|
title : string | عنوان جدید برای همه iframe های کانتینر تبلیغاتی. |
setConfig
setConfig ( config : PageSettingsConfig ) : void
پارامترها | |
---|---|
config : PageSettingsConfig |
اندازه نقشه برداری
sizeMapping ( ) : SizeMappingBuilder
- همچنین ببینید
برمی گرداند | |
---|---|
SizeMappingBuilder | یک سازنده جدید |
googletag.CommandArray
روش ها | |
---|---|
push | دنباله ای از توابع مشخص شده در آرگومان ها را به ترتیب اجرا می کند. |
روش ها
فشار دهید
push ( ... f : ( ( this : typeof globalThis ) => void ) [] ) : number
- مثال
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
پارامترها | |
---|---|
| یک تابع جاوا اسکریپت که باید اجرا شود. اتصال زمان اجرا همیشه globalThis خواهد بود. در نظر بگیرید که یک تابع فلش را برای حفظ this مقدار از بافت واژگانی محصور در نظر بگیرید. |
برمی گرداند | |
---|---|
number | تعداد دستورات پردازش شده تاکنون این با مقدار برگشتی Array.push (طول فعلی آرایه) سازگار است. |
googletag.CompanionAdsService
Service
گسترش می دهدروش ها | |
---|---|
add Event Listener | شنوندهای را ثبت میکند که به شما امکان میدهد یک تابع جاوا اسکریپت را هنگامی که یک رویداد GPT خاص در صفحه اتفاق میافتد تنظیم و فراخوانی کنید. از |
get Slots | لیست اسلات های مرتبط با این سرویس را دریافت کنید. از |
remove Event Listener | شنونده قبلا ثبت نام شده را حذف می کند. از |
set Refresh Unfilled Slots | تعیین می کند که آیا اسلات های همراهی که پر نشده اند به طور خودکار پر شوند یا خیر. |
- همچنین ببینید
روش ها
setRefreshUnfilledSlots
setRefreshUnfilledSlots ( value : boolean ) : void
این روش را می توان چندین بار در طول عمر صفحه فراخوانی کرد تا Backfill را روشن و خاموش کند. فقط اسلات هایی که در PubAdsService نیز ثبت شده باشند پر می شوند. به دلیل محدودیتهای خطمشی، این روش برای پر کردن جایگاههای خالی همراه هنگام ارائه یک ویدیوی Ad Exchange طراحی نشده است.
- مثال
googletag.companionAds().setRefreshUnfilledSlots(true);
googletag.companionAds().setRefreshUnfilledSlots(true);
googletag.companionAds().setRefreshUnfilledSlots(true);
پارامترها | |
---|---|
value : boolean | true برای پر کردن خودکار اسلات های پر نشده، false تا بدون تغییر باقی بماند. |
googletag.PrivacySettingsConfig
خواص | |
---|---|
child Directed Treatment ? | نشان میدهد که آیا این صفحه باید بهعنوان کارگردانی کودک در نظر گرفته شود. |
limited Ads ? | برای کمک به نیازهای انطباق با مقررات ناشر، سرویس را در حالت تبلیغات محدود اجرا می کند. |
non Personalized Ads ? | برای کمک به نیازهای انطباق با مقررات ناشر، سرویس را در حالت تبلیغات غیرشخصی اجرا می کند. |
restrict Data Processing ? | برای کمک به نیازهای انطباق با مقررات ناشر، سرویس را برای اجرا در حالت پردازش محدود فعال میکند. |
traffic Source ? | نشان می دهد که آیا درخواست ها ترافیک خریداری شده یا ارگانیک را نشان می دهند. |
under Age Of Consent ? | نشان میدهد که آیا باید درخواستهای تبلیغات را بهعنوان کاربران زیر سن رضایت علامتگذاری کرد. |
- همچنین ببینید
خواص
Optional
childDirectedTreatment
childDirectedTreatment ?: null | boolean
null
تنظیم کنید. تبلیغات محدود Optional
limitedAds ?: boolean
میتوانید به GPT دستور دهید تا تبلیغات محدود را به دو روش درخواست کند:
- به طور خودکار، با استفاده از یک سیگنال از یک پلت فرم مدیریت رضایت IAB TCF v2.0 .
- به صورت دستی، با تنظیم مقدار این فیلد روی
true
.
توجه داشته باشید که هنگام استفاده از CMP، نیازی به فعال کردن تبلیغات محدود به صورت دستی نیست.
- مثال
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- همچنین ببینید
تبلیغات غیرشخصی Optional
nonPersonalizedAds ?: boolean
محدودیت Optional
پردازش داده
restrictDataProcessing ?: boolean
منبع ترافیک Optional
trafficSource ?: TrafficSource
undefined
.- مثال
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
Optional
underAgeOfConsent
underAgeOfConsent ?: null | boolean
null
تنظیم کنید. googletag.PubAdsService
Service
گسترش می دهدروش ها | |
---|---|
add Event Listener | شنوندهای را ثبت میکند که به شما امکان میدهد یک تابع جاوا اسکریپت را هنگامی که یک رویداد GPT خاص در صفحه اتفاق میافتد تنظیم و فراخوانی کنید. از |
clear | تبلیغات را از اسلات های داده شده حذف می کند و آنها را با محتوای خالی جایگزین می کند. |
clear Category Exclusions | همه برچسبهای حذف دسته تبلیغات در سطح صفحه را پاک میکند. |
clear Targeting | پارامترهای هدف گیری سفارشی را برای یک کلید خاص یا برای همه کلیدها پاک می کند. |
collapse Empty Divs | جمع کردن div های اسلات را فعال می کند تا زمانی که محتوای تبلیغاتی برای نمایش وجود ندارد، فضایی را در صفحه اشغال نکنند. |
disable Initial Load | درخواستهای تبلیغات را هنگام بارگیری صفحه غیرفعال میکند، اما اجازه میدهد تا تبلیغات با تماس PubAdsService.refresh درخواست شود. |
display | یک جایگاه تبلیغاتی با مسیر و اندازه واحد تبلیغاتی داده شده می سازد و نمایش می دهد. |
enable Lazy Load | بارگیری تنبل را در GPT همانطور که توسط شی پیکربندی تعریف شده است فعال می کند. |
enable Single Request | حالت درخواست تک را برای واکشی چند آگهی به طور همزمان فعال می کند. |
enable Video Ads | به GPT سیگنال می دهد که تبلیغات ویدیویی در صفحه وجود خواهد داشت. |
get | مقدار مشخصه AdSense مرتبط با کلید داده شده را برمی گرداند. |
get Attribute Keys | کلیدهای ویژگی تنظیم شده در این سرویس را برمی گرداند. |
get Slots | لیست اسلات های مرتبط با این سرویس را دریافت کنید. از |
get Targeting | یک پارامتر هدفیابی در سطح خدمات سفارشی را که تنظیم شده است، برمیگرداند. |
get Targeting Keys | فهرستی از تمام کلیدهای هدف گذاری در سطح سرویس سفارشی که تنظیم شده اند را برمی گرداند. |
is Initial Load Disabled | نشان میدهد که آیا درخواستهای اولیه برای تبلیغات با موفقیت در تماس قبلی PubAdsService.disableInitialLoad غیرفعال شده است یا خیر. |
refresh | تبلیغات جدید را برای خاص یا همه اسلات های موجود در صفحه واکشی و نمایش می دهد. |
remove Event Listener | شنونده قبلا ثبت نام شده را حذف می کند. از |
set | مقادیری را برای ویژگیهای AdSense تنظیم میکند که برای همه جایگاههای تبلیغاتی تحت سرویس Publisher Ads اعمال میشود. |
set Category Exclusion | یک استثناء طبقه بندی آگهی در سطح صفحه برای نام برچسب داده شده تنظیم می کند. |
set Centering | مرکز افقی تبلیغات را فعال و غیرفعال می کند. |
set Force Safe Frame | پیکربندی میکند که آیا همه آگهیهای موجود در صفحه باید با استفاده از ظرف SafeFrame ارائه شوند یا خیر. |
set Location | اطلاعات مکان را از وبسایتها ارسال میکند تا بتوانید موارد خط را به مکانهای خاص هدفگیری جغرافیایی کنید. |
set Privacy Settings | به پیکربندی تمام تنظیمات حریم خصوصی از یک API با استفاده از یک شیء پیکربندی اجازه میدهد. |
set Publisher Provided Id | مقدار شناسه ارائه شده توسط ناشر را تنظیم می کند. |
set Safe Frame Config | تنظیمات برگزیده سطح صفحه را برای پیکربندی SafeFrame تنظیم می کند. |
set Targeting | پارامترهای هدفیابی سفارشی را برای یک کلید مشخص تنظیم میکند که برای همه جایگاههای تبلیغاتی سرویس آگهیهای ناشر اعمال میشود. |
set Video Content | اطلاعات محتوای ویدیویی را برای ارسال به همراه درخواستهای آگهی برای اهداف هدفیابی و حذف محتوا تنظیم میکند. |
update Correlator | همبستگی که با درخواست های تبلیغاتی ارسال می شود را تغییر می دهد و عملاً یک نمای صفحه جدید را شروع می کند. |
روش ها
روشن
clear ( slots ?: Slot [] ) : boolean
به طور خاص، پاک کردن یک شکاف، آگهی را از نمای صفحه طولانی مدت GPT حذف میکند، بنابراین درخواستهای آینده تحت تأثیر موانع یا محرومیتهای رقابتی مربوط به این آگهی قرار نمیگیرند.
- مثال
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
پارامترها | |
---|---|
| آرایه ای از اسلات برای پاک کردن. آرایه اختیاری است. اگر نامشخص باشد تمام اسلات ها پاک خواهند شد. |
برمی گرداند | |
---|---|
boolean | اگر شکافها پاک شده باشند، true را برمیگرداند، در غیر این صورت false . |
clearCategoryExclusions
clearCategoryExclusions ( ) : PubAdsService
- مثال
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- همچنین ببینید
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
هدف گذاری روشن
clearTargeting ( key ?: string ) : PubAdsService
- مثال
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- همچنین ببینید
پارامترها | |
---|---|
| کلید پارامتر هدف. کلید اختیاری است. تمام پارامترهای هدف گیری در صورت نامشخص بودن پاک خواهند شد. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
collapseEmptyDivs
collapseEmptyDivs ( collapseBeforeAdFetch ?: boolean ) : boolean
- همچنین ببینید
پارامترها | |
---|---|
| حتی قبل از واکشی تبلیغات، شکافها جمع شوند یا خیر. این پارامتر اختیاری است. اگر ارائه نشود، false به عنوان مقدار پیش فرض استفاده می شود. |
برمی گرداند | |
---|---|
boolean | اگر حالت جمعکردن div فعال باشد، true برمیگرداند و اگر فعال کردن حالت جمعکردن غیرممکن باشد false برمیگرداند زیرا متد پس از فعال شدن سرویس فراخوانی شده است. |
disableInitialLoad
disableInitialLoad ( ) : void
refresh
غیرممکن خواهد بود.نمایش داده شود
display ( adUnitPath : string , size : GeneralSize , div ?: string | Element , clickUrl ?: string ) : void
توجه: هنگامی که این روش فراخوانی می شود، یک عکس فوری از وضعیت اسلات و صفحه ایجاد می شود تا هنگام ارسال درخواست تبلیغ و ارائه پاسخ از یکنواختی اطمینان حاصل شود. هر تغییری که پس از فراخوانی این روش در وضعیت اسلات یا صفحه ایجاد میشود (از جمله هدفگیری، تنظیمات حریم خصوصی، اجباری SafeFrame و غیره) فقط برای درخواستهای
display()
یا refresh()
بعدی اعمال میشود.- مثال
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- همچنین ببینید
پارامترها | |
---|---|
adUnitPath : string | مسیر واحد تبلیغاتی اسلات که باید ارائه شود. |
size : GeneralSize | عرض و ارتفاع شکاف. |
| یا شناسه div حاوی اسلات یا خود عنصر div. |
| نشانی وب کلیک کنید تا در این اسلات استفاده کنید. |
فعال کردن LazyLoad
enableLazyLoad ( config ?: {
fetchMarginPercent ?: number ;
mobileScaling ?: number ;
renderMarginPercent ?: number ;
} ) : void
توجه: واکشی تنبل در SRA فقط در صورتی کار میکند که همه اسلاتها خارج از حاشیه واکشی باشند.
- مثال
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
پارامترها | |
---|---|
| شیء پیکربندی امکان سفارشی سازی رفتار تنبل را فراهم می کند. هر پیکربندی حذف شده از یک مجموعه پیشفرض توسط Google استفاده میکند که به مرور زمان تنظیم میشود. برای غیرفعال کردن یک تنظیم خاص، مانند حاشیه واکشی، مقدار را روی -1 تنظیم کنید.
|
فعال کردن SingleRequest
enableSingleRequest ( ) : boolean
- همچنین ببینید
برمی گرداند | |
---|---|
boolean | در صورت فعال بودن حالت درخواست تکی، مقدار true و در صورتی که فعال کردن حالت درخواست تک غیرممکن باشد، false ، زیرا متد پس از فعال شدن سرویس فراخوانی شده است. |
فعال کردن VideoAds
enableVideoAds ( ) : void
دریافت کنید
get ( key : string ) : null | string
- مثال
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- همچنین ببینید
پارامترها | |
---|---|
key : string | نام ویژگی مورد نظر برای جستجو |
برمی گرداند | |
---|---|
null | string | مقدار فعلی برای کلید مشخصه، یا اگر کلید موجود نباشد، null . |
getAttributeKeys
getAttributeKeys ( ) : string []
- مثال
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
برمی گرداند | |
---|---|
string [] | مجموعه ای از کلیدهای ویژگی روی این سرویس تنظیم شده است. سفارش تعریف نشده است. |
getTargeting
getTargeting ( key : string ) : string []
- مثال
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
پارامترها | |
---|---|
key : string | کلید هدف گیری که باید جستجو کنید. |
برمی گرداند | |
---|---|
string [] | مقادیر مرتبط با این کلید، یا یک آرایه خالی اگر چنین کلیدی وجود نداشته باشد. |
getTargetingKeys
getTargetingKeys ( ) : string []
- مثال
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
برمی گرداند | |
---|---|
string [] | مجموعه ای از کلیدهای هدف گیری سفارش تعریف نشده است. |
isInitialLoadDisabled
isInitialLoadDisabled ( ) : boolean
برمی گرداند | |
---|---|
boolean | اگر تماس قبلی با PubAdsService.disableInitialLoad موفقیت آمیز بود، true است، در غیر این صورت false است. |
تازه کردن
refresh ( slots ?: null | Slot [] , options ?: {
changeCorrelator : boolean ;
} ) : void
برای رفتار مناسب در همه مرورگرها،
refresh
تماس باید قبل از یک تماس برای display
جایگاه آگهی باشد. اگر تماس برای display
حذف شود، ممکن است بازخوانی غیرمنتظره عمل کند. در صورت تمایل، از روش PubAdsService.disableInitialLoad می توان برای جلوگیری از واکشی یک آگهی display
استفاده کرد.بهروزرسانی یک اسلات، آگهی قدیمی را از نمای صفحه طولانی مدت GPT حذف میکند، بنابراین درخواستهای آینده تحت تأثیر موانع یا محرومیتهای رقابتی مربوط به آن آگهی قرار نمیگیرند.
- مثال
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
پارامترها | |
---|---|
| شکاف ها برای تازه کردن. آرایه اختیاری است. اگر نامشخص باشد، تمام اسلات ها به روز می شوند. |
| گزینه های پیکربندی مرتبط با این تماس تازه.
|
مجموعه
set ( key : string , value : string ) : PubAdsService
بیش از یک بار فراخوانی این کلید برای همان کلید، مقادیر تنظیم شده قبلی را برای آن کلید لغو می کند. همه مقادیر باید قبل از تماس
display
یا refresh
تنظیم شوند.- مثال
googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- همچنین ببینید
پارامترها | |
---|---|
key : string | نام صفت. |
value : string | ارزش صفت. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
setCategoryExclusion
setCategoryExclusion ( categoryExclusion : string ) : PubAdsService
- مثال
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- همچنین ببینید
پارامترها | |
---|---|
categoryExclusion : string | برچسب حذف دسته آگهی برای افزودن. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
setCentering
setCentering ( centerAds : boolean ) : void
این روش باید قبل از فراخوانی
display
یا refresh
فراخوانی شود زیرا فقط تبلیغاتی که پس از فراخوانی این روش درخواست می شوند در مرکز قرار می گیرند.- مثال
// Make ads centered. googletag.pubads().setCentering(true);
// Make ads centered. googletag.pubads().setCentering(true);
// Make ads centered. googletag.pubads().setCentering(true);
پارامترها | |
---|---|
centerAds : boolean | true در مرکز تبلیغات، false برای تراز چپ آنها. |
setForceSafeFrame
setForceSafeFrame ( forceSafeFrame : boolean ) : PubAdsService
لطفاً هنگام استفاده از این API موارد زیر را در نظر داشته باشید:
- این تنظیم فقط برای درخواستهای آگهی بعدی که برای اسلاتهای مربوطه انجام میشود، اعمال میشود.
- تنظیم سطح شکاف، اگر مشخص شود، همیشه تنظیمات سطح صفحه را لغو می کند.
- اگر روی
true
تنظیم شود (در سطح شکاف یا سطح صفحه)، تبلیغ همیشه با استفاده از یک محفظه SafeFrame مستقل از انتخاب انجام شده در رابط کاربری Google Ad Manager ارائه میشود. - با این حال، اگر روی
false
تنظیم شود یا نامشخص باقی بماند، بسته به نوع خلاقیت و انتخاب انجام شده در رابط کاربری Google Ad Manager، آگهی با استفاده از یک محفظه SafeFrame ارائه میشود. - این API باید با احتیاط مورد استفاده قرار گیرد، زیرا میتواند بر رفتار خلاقانی که تلاش میکنند از iFrame خود خارج شوند یا به نمایش مستقیم آنها در صفحه ناشران متکی هستند، تأثیر بگذارد.
- مثال
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- همچنین ببینید
پارامترها | |
---|---|
forceSafeFrame : boolean | true تا همه تبلیغات موجود در صفحه در SafeFrames ارائه شوند و false برای تغییر تنظیمات قبلی به false. تنظیم این روی false زمانی که قبلا مشخص نشده باشد، چیزی را تغییر نخواهد داد. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که تابع روی آن فراخوانی شده است. |
setLocation
setLocation ( address : string ) : PubAdsService
- مثال
// Postal code: googletag.pubads().setLocation("10001,US");
// Postal code: googletag.pubads().setLocation("10001,US");
// Postal code: googletag.pubads().setLocation("10001,US");
پارامترها | |
---|---|
address : string | آدرس فرم آزاد. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
setPrivacySettings
setPrivacySettings ( privacySettings : PrivacySettingsConfig ) : PubAdsService
- مثال
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- همچنین ببینید
پارامترها | |
---|---|
privacySettings : PrivacySettingsConfig | شیء حاوی تنظیمات حریم خصوصی. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که تابع روی آن فراخوانی شده است. |
setPublisherProvidedId
setPublisherProvidedId ( ppid : string ) : PubAdsService
- مثال
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- همچنین ببینید
پارامترها | |
---|---|
ppid : string | شناسه الفبایی که توسط ناشر ارائه شده است. باید بین 32 تا 150 کاراکتر باشد. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
setSafeFrameConfig
setSafeFrameConfig ( config : SafeFrameConfig ) : PubAdsService
این تنظیمات برگزیده در سطح صفحه، در صورت مشخص شدن، با اولویتهای سطح شکاف لغو میشوند.
- مثال
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- همچنین ببینید
پارامترها | |
---|---|
config : SafeFrameConfig | شی پیکربندی. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
setTargeting
setTargeting ( key : string , value : string | string [] ) : PubAdsService
- مثال
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- همچنین ببینید
پارامترها | |
---|---|
key : string | کلید پارامتر هدف. |
value : string | string [] | مقدار پارامتر هدف یا آرایه ای از مقادیر. |
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
setVideoContent
setVideoContent ( videoContentId : string , videoCmsId : string ) : void
videoContentId
و videoCmsId
، از مقادیری استفاده کنید که به سرویس جذب محتوای Google Ad Manager ارائه شده است.- همچنین ببینید
پارامترها | |
---|---|
videoContentId : string | شناسه محتوای ویدیویی |
videoCmsId : string | شناسه CMS ویدیو. |
updateCorrelator
updateCorrelator ( ) : PubAdsService
توجه: این هیچ تأثیری بر نمای طولانی مدت GPT ندارد، که به طور خودکار تبلیغات را در صفحه منعکس می کند و زمان انقضا ندارد.
- مثال
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
برمی گرداند | |
---|---|
PubAdsService | شیء سرویسی که تابع روی آن فراخوانی شده است. |
googletag.ResponseInformation
خواص | |
---|---|
advertiser Id | شناسه آگهی دهنده |
campaign Id | شناسه کمپین |
creative Id | شناسه خلاق. |
creative Template Id | شناسه قالب آگهی. |
line Item Id | شناسه مورد خط. |
- همچنین ببینید
خواص
شناسه تبلیغ
advertiserId : null | number
شناسه کمپین
campaignId : null | number
شناسه خلاق
creativeId : null | number
creativeTemplateId
creativeTemplateId : null | number
lineItemId
lineItemId : null | number
googletag.RewardedPayload
- همچنین ببینید
خواص
مقدار
amount : number
نوع
type : string
googletag.SafeFrameConfig
خواص | |
---|---|
allow Overlay Expansion ? | آیا SafeFrame باید به محتوای تبلیغات اجازه دهد تا با همپوشانی محتوای صفحه گسترش یابد یا خیر. |
allow Push Expansion ? | آیا SafeFrame باید به محتوای تبلیغات اجازه دهد تا با فشار دادن محتوای صفحه گسترش یابد یا خیر. |
sandbox ? | آیا SafeFrame باید از ویژگی HTML5 sandbox برای جلوگیری از ناوبری سطح بالا بدون تعامل کاربر استفاده کند یا خیر. |
use Unique Domain ? | منسوخ شده است. آیا SafeFrame باید از زیر دامنههای تصادفیسازی شده برای خلاقیتهای رزرو استفاده کند یا خیر. |
- همچنین ببینید
خواص
Optional
allowOverlayExpansion
allowOverlayExpansion ?: boolean
Optional
allowPushExpansion
allowPushExpansion ?: boolean
جعبه شنی Optional
sandbox ?: boolean
true
است (نمی توان آن را false
اجبار کرد). توجه داشته باشید که ویژگی sandbox پلاگین ها را غیرفعال می کند (مثلاً Flash). Optional
useUniqueDomain
useUniqueDomain ?: null | boolean
null
را پاس کنید.توجه: این ویژگی به طور پیش فرض فعال است.
- همچنین ببینید
googletag.Service
روش ها | |
---|---|
add Event Listener | شنوندهای را ثبت میکند که به شما امکان میدهد یک تابع جاوا اسکریپت را هنگامی که یک رویداد GPT خاص در صفحه اتفاق میافتد تنظیم و فراخوانی کنید. |
get Slots | لیست اسلات های مرتبط با این سرویس را دریافت کنید. |
remove Event Listener | شنونده قبلا ثبت نام شده را حذف می کند. |
روش ها
addEventListener
addEventListener < K extends keyof EventTypeMap > ( eventType : K , listener : ( ( arg : EventTypeMap [ K ] ) => void ) ) : Service
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- رویدادها.RewardedSlotClosedEvent
- رویدادها.RewardedSlotGrantedEvent
- رویدادها.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- رویدادها.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- مثال
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- همچنین ببینید
پارامترها | |
---|---|
eventType : K | رشته ای که نشان دهنده نوع رویداد تولید شده توسط GPT است. انواع رویداد به حروف بزرگ و کوچک حساس هستند. |
listener : ( ( arg : EventTypeMap [ K ] ) => void ) | تابعی که آرگومان شی رویداد واحد را می گیرد. |
برمی گرداند | |
---|---|
Service | شیء سرویسی که متد بر روی آن فراخوانی شده است. |
getSlots
removeEventListener
removeEventListener < K extends keyof EventTypeMap > ( eventType : K , listener : ( ( event : EventTypeMap [ K ] ) => void ) ) : void
- مثال
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
پارامترها | |
---|---|
eventType : K | رشته ای که نشان دهنده نوع رویداد ایجاد شده توسط GPT است. انواع رویداد حساس به مورد هستند. |
listener : ( ( event : EventTypeMap [ K ] ) => void ) | عملکردی که یک آرگومان شیء یک رویداد واحد را می گیرد. |
googletag.sizemappingBuilder
- همچنین ببینید
روش ها
اضافه کردن
addSize ( viewportSize : SingleSizeArray , slotSize : GeneralSize ) : SizeMappingBuilder
- مثال
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
پارامترها | |
---|---|
viewportSize : SingleSizeArray | اندازه نمای این ورودی نقشه برداری. |
slotSize : GeneralSize | اندازه شکاف برای این ورودی نقشه برداری. |
برمی گرداند | |
---|---|
SizeMappingBuilder | اشاره ای به این سازنده. |
ساختن
build ( ) : null | SizeMappingArray
در صورت تهیه هرگونه نقشه های نامعتبر ، این روش
null
باز می گردد. در غیر این صورت مشخصات خود را در قالب صحیح باز می گرداند تا به Slot.DefinesizEmapping منتقل شود.توجه: رفتار سازنده پس از فراخوانی این روش تعریف نشده است.
برمی گرداند | |
---|---|
null | SizeMappingArray | نتیجه ساخته شده توسط این سازنده. در صورت تهیه نقشه های اندازه نامعتبر ، می تواند تهی باشد. |
googletag.slot
روش ها | |
---|---|
add Service | خدماتی را به این شکاف اضافه می کند. |
clear Category Exclusions | تمام برچسب های محرومیت دسته AD در سطح اسلات را برای این شکاف پاک می کند. |
clear Targeting | پارامترهای هدفمند هدف خاص یا همه سطح سفارشی را برای این شکاف پاک می کند. |
define Size Mapping | مجموعه ای از نگاشتها را از حداقل اندازه منظره به اندازه شکاف برای این شکاف تنظیم می کند. |
get | مقدار را برای ویژگی AdSense مرتبط با کلید داده شده برای این شکاف برمی گرداند. |
get Ad Unit Path | مسیر کامل واحد AD را با کد شبکه و مسیر واحد AD برمی گرداند. |
get Attribute Keys | لیست کلیدهای ویژگی تنظیم شده در این شکاف را برمی گرداند. |
get Category Exclusions | برچسب های محرومیت دسته AD را برای این شکاف برمی گرداند. |
get Response Information | اطلاعات پاسخ آگهی را برمی گرداند. |
get Slot Element Id | شناسه div شکاف ارائه شده هنگام تعریف شکاف را برمی گرداند. |
get Targeting | یک پارامتر هدفمند سفارشی خاص را که در این شکاف تنظیم شده است ، برمی گرداند. |
get Targeting Keys | لیست کلیه کلیدهای هدفمند سفارشی را که روی این شکاف تنظیم شده است ، برمی گرداند. |
set | مقداری را برای یک ویژگی AdSense در این شکاف AD تعیین می کند. |
set Category Exclusion | برچسب محرومیت دسته AD سطح آگهی را در این شکاف تنظیم می کند. |
set Click Url | URL کلیک را تنظیم می کند که کاربران پس از کلیک بر روی آگهی هدایت می شوند. |
set Collapse Empty Div | تنظیم می کند که آیا div شکاف باید در صورت عدم وجود تبلیغ در شکاف پنهان شود. |
set Config | گزینه های پیکربندی عمومی را برای این شکاف تنظیم می کند. |
set Force Safe Frame | پیکربندی می کند که آیا تبلیغات در این شکاف باید با استفاده از یک ظرف SafeFrame مجبور به ارائه شود. |
set Safe Frame Config | تنظیمات سطح شکاف را برای پیکربندی SafeFrame تنظیم می کند. |
set Targeting | یک پارامتر هدفمند سفارشی را برای این شکاف تنظیم می کند. |
update Targeting From Map | پارامترهای هدفمند سفارشی را برای این شکاف ، از یک کلید: نقشه Value در یک شیء JSON تنظیم می کند. |
روش ها
سرویس اضافه کردن
addService ( service : Service ) : Slot
- مثال
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- همچنین ببینید
پارامترها | |
---|---|
service : Service | سرویس اضافه شده |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
ClearCategorexclusions
clearCategoryExclusions ( ) : Slot
- مثال
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
تدوین
clearTargeting ( key ?: string ) : Slot
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- همچنین ببینید
پارامترها | |
---|---|
| کلید پارامتر هدفمند. کلید اختیاری است ؛ اگر مشخص نشده باشد ، تمام پارامترهای هدفمند پاک می شوند. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
تعریف کردن
defineSizeMapping ( sizeMapping : SizeMappingArray ) : Slot
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping!);
- همچنین ببینید
پارامترها | |
---|---|
sizeMapping : SizeMappingArray | آرایه ای از نقشه های اندازه. برای ایجاد آن می توانید از SizemappingBuilder استفاده کنید. نقشه برداری هر اندازه مجموعه ای از دو عنصر است: SingleSearray و GeneralSize . |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
دریافت کنید
get ( key : string ) : null | string
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- همچنین ببینید
پارامترها | |
---|---|
key : string | نام این ویژگی برای جستجوی. |
برمی گرداند | |
---|---|
null | string | مقدار فعلی برای کلید ویژگی ، یا اگر کلید موجود نیست ، null . |
گچ
getAdUnitPath ( ) : string
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
برمی گرداند | |
---|---|
string | مسیر واحد تبلیغ. |
GetAttributeKeys
getAttributeKeys ( ) : string []
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
برمی گرداند | |
---|---|
string [] | مجموعه کلیدهای ویژگی. سفارش تعریف نشده است. |
getCategorExclusions
getCategoryExclusions ( ) : string []
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
برمی گرداند | |
---|---|
string [] | برچسب های محرومیت دسته آگهی برای این شکاف یا یک آرایه خالی در صورت تنظیم هیچ یک از آنها. |
اطلاعات
getResponseInformation ( ) : null | ResponseInformation
null
بازگردانده می شود. برمی گرداند | |
---|---|
null | ResponseInformation | آخرین اطلاعات پاسخ تبلیغات یا null در صورتی که شکاف AD نداشته باشد. |
getSlotElementId
getSlotElementId ( ) : string
div
شکاف ارائه شده هنگام تعریف شکاف را برمی گرداند.- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
برمی گرداند | |
---|---|
string | Slot div ID. |
دستکاری
getTargeting ( key : string ) : string []
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
پارامترها | |
---|---|
key : string | کلید هدفمند برای جستجوی. |
برمی گرداند | |
---|---|
string [] | مقادیر مرتبط با این کلید یا یک آرایه خالی در صورت وجود چنین کلید. |
GetTargetingKeys
getTargetingKeys ( ) : string []
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
برمی گرداند | |
---|---|
string [] | مجموعه کلیدهای هدفمند. سفارش تعریف نشده است. |
مجموعه
set ( key : string , value : string ) : Slot
فراخوانی این روش بیش از یک بار برای همان کلید ، مقادیر قبلی را برای آن کلید نادیده می گیرد. تمام مقادیر باید قبل از فراخوانی
display
یا refresh
تنظیم شوند.- مثال
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- همچنین ببینید
پارامترها | |
---|---|
key : string | نام صفت. |
value : string | مقدار ویژگی |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
setCategorexclusion
setCategoryExclusion ( categoryExclusion : string ) : Slot
- مثال
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- همچنین ببینید
پارامترها | |
---|---|
categoryExclusion : string | برچسب محرومیت دسته AD برای افزودن. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
setclickurl
setClickUrl ( value : string ) : Slot
سرورهای Google Ad Manager هنوز هم یک کلیک را ضبط می کنند حتی اگر URL کلیک جایگزین شود. هر URL صفحه فرود در ارتباط با خلاقیتی که ارائه می شود به مقدار ارائه شده اضافه می شود. تماسهای بعدی مقدار را بازنویسی می کنند. این فقط برای درخواست های غیر SRA کار می کند.
- مثال
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
پارامترها | |
---|---|
value : string | برای تنظیم URL کلیک کنید. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
setCollapSeemptyDiv
setCollapseEmptyDiv ( collapse : boolean , collapseBeforeAdFetch ?: boolean ) : Slot
div
شکاف باید در صورت عدم وجود تبلیغ در شکاف پنهان شود. این تنظیمات سطح خدمات را نادیده می گیرد.- مثال
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- همچنین ببینید
پارامترها | |
---|---|
collapse : boolean | در صورت بازگشت هیچ آگهی ، شکاف را فرو می ریزید. |
| این که آیا حتی قبل از اینکه یک آگهی انجام شود ، شکاف را فرو می ریزد. اگر فروپاشی true نیست ، نادیده گرفته می شود. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
باج
setConfig ( slotConfig : SlotSettingsConfig ) : void
پارامترها | |
---|---|
slotConfig : SlotSettingsConfig | شیء پیکربندی. |
setforcesafeframe
setForceSafeFrame ( forceSafeFrame : boolean ) : Slot
لطفاً هنگام استفاده از این API موارد زیر را در ذهن داشته باشید:
- این تنظیم فقط برای درخواست های تبلیغاتی بعدی که برای اسلات های مربوطه انجام می شود ، اعمال می شود.
- تنظیم سطح شکاف ، در صورت مشخص شدن ، همیشه تنظیم سطح صفحه را نادیده می گیرد.
- در صورت تنظیم
true
(در سطح شکاف یا سطح صفحه) ، تبلیغ همیشه با استفاده از یک کانتینر SafeFrame مستقل از انتخاب ساخته شده در UI Google Ad Manager انجام می شود. - با این حال ، اگر روی
false
یا مانده به صورت نامشخص تنظیم شود ، بسته به نوع خلاق و انتخاب انجام شده در UI Google Ad Manager ، با استفاده از یک ظرف SafeFrame انجام می شود. - این API باید با احتیاط مورد استفاده قرار گیرد زیرا این امر می تواند بر رفتار خلاقانی که تلاش می کنند از Iframes خود خارج شوند یا به آنها اعتماد کند که مستقیماً در صفحه ناشران ارائه می شود ، تأثیر بگذارد.
- مثال
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- همچنین ببینید
پارامترها | |
---|---|
forceSafeFrame : boolean | true که تمام تبلیغات موجود در این شکاف را در Safeframes و false برای امتناع از یک تنظیم سطح صفحه (در صورت وجود) انجام دهید. تنظیم این false در هنگام مشخص شدن در سطح صفحه ، چیزی تغییر نخواهد کرد. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
setSafeFrameConfig
setSafeFrameConfig ( config : null | SafeFrameConfig ) : Slot
این ترجیحات سطح شکاف ، در صورت مشخص شدن ، ترجیحات سطح صفحه را نادیده می گیرد.
- مثال
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- همچنین ببینید
پارامترها | |
---|---|
config : null | SafeFrameConfig | شیء پیکربندی. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
سرنگونی
setTargeting ( key : string , value : string | string [] ) : Slot
- مثال
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- همچنین ببینید
پارامترها | |
---|---|
key : string | کلید پارامتر هدفمند. |
value : string | string [] | هدف قرار دادن مقدار پارامتر یا آرایه مقادیر. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
به روزرسانی
updateTargetingFromMap ( map : {
[ adUnitPath : string ] : string | string [] ;
} ) : Slot
یادداشت ها:
- در صورت رونویسی ، فقط آخرین مقدار نگهداری می شود.
- اگر مقدار آرایه ای باشد ، هر مقدار قبلی رونویسی می شود ، ادغام نمی شود.
- مقادیر تنظیم شده در اینجا پارامترهای هدفمند تعیین شده در سطح سرویس را بازنویسی می کنند.
- مثال
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
پارامترها | |
---|---|
map : { | کلید پارامتر هدفمند: نقشه مقدار. |
برمی گرداند | |
---|---|
Slot | شیء شکاف که در آن روش خوانده شده است. |
googletag.config
رابط ها | |
---|---|
Ad Expansion Config | تنظیمات برای کنترل گسترش تبلیغ. |
Component Auction Config | یک شیء که یک حراج مؤلفه واحد را در یک حراج تبلیغ در دستگاه ارائه می دهد. |
Interstitial Config | شیئی که رفتار یک شکاف تبلیغاتی بینابینی را تعریف می کند. |
Page Settings Config | رابط اصلی پیکربندی برای تنظیمات سطح صفحه. |
Privacy Treatments Config | تنظیمات برای کنترل درمان های حریم خصوصی ناشر. |
Publisher Provided Signals Config | ناشر شیء سیگنال ها (PPS) را ارائه داد. |
Slot Settings Config | رابط اصلی پیکربندی برای تنظیمات سطح شکاف. |
Taxonomy Data | یک شیء حاوی مقادیر برای یک طبقه بندی واحد. |
نام مستعار را تایپ کنید | |
---|---|
Interstitial Trigger | محرکهای تبلیغاتی بینابینی پشتیبانی می کنند. |
Privacy Treatment | از درمان های حریم خصوصی ناشر پشتیبانی می شود. |
Taxonomy | طبقه بندی های پشتیبانی شده برای ناشر سیگنال ها (PPS) ارائه می دهند . |
نام مستعار را تایپ کنید
بینابین
InterstitialTrigger : "unhideWindow" | "navBar"
حریم خصوصی
PrivacyTreatment : "disablePersonalization"
طبقه بندی
Taxonomy : "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
- همچنین ببینید
googletag.config.adexpansionconfig
خواص | |
---|---|
enabled ? | آیا گسترش تبلیغات فعال است یا غیرفعال است. |
- مثال
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
خواص
Optional
فعال
enabled ?: null | boolean
تنظیم این مقدار بر پیش فرض پیکربندی شده در Google Ad Manager غلبه می کند.
googletag.config.componentauctionconfig
خواص | |
---|---|
auction Config | یک شی پیکربندی حراج برای این حراج مؤلفه. |
config Key | کلید پیکربندی مرتبط با این حراج مؤلفه. |
خواص
حراج
auctionConfig : null | {
auctionSignals ?: unknown ;
decisionLogicURL : string ;
interestGroupBuyers ?: string [] ;
perBuyerExperimentGroupIds ?: {
[ buyer : string ] : number ;
} ;
perBuyerGroupLimits ?: {
[ buyer : string ] : number ;
} ;
perBuyerSignals ?: {
[ buyer : string ] : unknown ;
} ;
perBuyerTimeouts ?: {
[ buyer : string ] : number ;
} ;
seller : string ;
sellerExperimentGroupId ?: number ;
sellerSignals ?: unknown ;
sellerTimeout ?: number ;
trustedScoringSignalsURL ?: string ;
}
اگر این مقدار روی
null
تنظیم شود ، هر پیکربندی موجود برای configKey
مشخص حذف می شود.- مثال
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- همچنین ببینید
عکسبرداری
configKey : string
این مقدار باید غیر خالی باشد و باید بی نظیر باشد. اگر دو اشیاء
ComponentAuctionConfig
همان مقدار کلید پیکربندی را به اشتراک بگذارند ، آخرین مورد تنظیم شده ، تنظیمات قبلی را بازنویسی می کند. googletag.config.interstititialConfig
خواص | |
---|---|
require Storage Access ? | این که آیا رضایت ذخیره سازی محلی برای نمایش این تبلیغ بینابینی مورد نیاز است. |
triggers ? | پیکربندی ماشه بینابینی برای این تبلیغ بینابینی. |
خواص
نیازهای Optional
requireStorageAccess ?: null | boolean
GPT از ذخیره محلی برای اجرای کلاه فرکانس برای تبلیغات بینابینی استفاده می کند. با این حال ، کاربرانی که رضایت ذخیره محلی را ارائه نداده اند ، هنوز واجد شرایط دریافت تبلیغات بینابینی هستند. تنظیم این خاصیت برای انتخاب
true
از رفتار پیش فرض ، و تضمین می کند که تبلیغات بین المللی فقط به کاربرانی که رضایت ذخیره محلی ارائه داده اند نشان داده می شود.- مثال
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
// Opt out of showing interstitials to users // without local storage consent. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
- همچنین ببینید
محرکهای Optional
triggers ?: null | Partial < Record < InterstitialTrigger , boolean > >
تنظیم مقدار یک ماشه بینابینی در
true
باعث فعال شدن آن می شود و false
آن را غیرفعال می کند. با این کار مقادیر پیش فرض پیکربندی شده در Google Ad Manager غلبه می کند.- مثال
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- همچنین ببینید
googletag.config.pagesettingsconfig
اجازه می دهد تا چندین ویژگی را با یک تماس API تنظیم کنید.
کلیه خصوصیات ذکر شده در زیر نمونه هایی هستند و ویژگی های واقعی استفاده از SetConfig را منعکس نمی کنند. برای مجموعه ویژگی ها ، قسمتهای موجود در نوع PagesettingsConfig را در زیر مشاهده کنید.
مثال ها:
- فقط ویژگی های مشخص شده در تماس googletag.setConfig اصلاح شده است.
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- تمام تنظیمات برای یک ویژگی معین با هر تماس به Googletag.setConfig به روز می شود.
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- تمام تنظیمات یک ویژگی را می توان با عبور
null
پاک کرد.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
خواص | |
---|---|
ad Expansion ? | تنظیمات برای کنترل گسترش تبلیغ. |
ad Yield ? | منسوخ شده است. |
pps ? | تنظیمات برای کنترل ناشر سیگنال ها (PPS) را ارائه داد. |
privacy Treatments ? | تنظیمات برای کنترل درمان های حریم خصوصی ناشر. |
thread Yield ? | تنظیم برای کنترل اینکه آیا GPT هنگام ارائه خلاقیت باید موضوع JS را به دست آورد. |
خواص
adexpansion Optional
adExpansion ?: null | AdExpansionConfig
Adyield Optional
adYield ?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
PPS Optional
pps ?: null | PublisherProvidedSignalsConfig
درمان های حریم خصوصی Optional
privacyTreatments ?: null | PrivacyTreatmentsConfig
Threadyield Optional
threadYield ?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
GPT فقط برای مرورگرهایی که از برنامه ریزی Sepost.posttask یا Scheduler.Yield API پشتیبانی می کنند ، ارائه می دهد.
مقادیر پشتیبانی شده:
-
null
(پیش فرض): GPT موضوع JS را برای شکافهای خارج از نمای ارائه می دهد. -
ENABLED_ALL_SLOTS
: GPT بدون در نظر گرفتن اینکه شکاف در نمای است ، موضوع JS را برای همه شکاف ها به دست می آورد. -
DISABLED
: GPT موضوع JS را به همراه نخواهد داشت.
- مثال
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- همچنین ببینید
googletag.config.PrivacyTreatmentsConfig
خواص | |
---|---|
treatments | مجموعه ای از درمان های حریم خصوصی ناشر برای فعال کردن. |
خواص
درمان ها
treatments : null | "disablePersonalization" []
- مثال
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvideSignalSconfig
خواص | |
---|---|
taxonomies | یک شیء حاوی نقشه های طبقه بندی . |
- مثال
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
خواص
طبقه بندی ها
taxonomies : Partial < Record < Taxonomy , TaxonomyData > >
googletag.config.slotsettingsconfig
اجازه می دهد تا چندین ویژگی را با یک تماس API واحد برای یک شکاف واحد تنظیم کنید.
کلیه خصوصیات ذکر شده در زیر نمونه هایی هستند و ویژگی های واقعی استفاده از SetConfig را منعکس نمی کنند. برای مجموعه ویژگی ها ، زمینه های موجود در نوع slotsettingsconfig را در زیر مشاهده کنید.
مثال ها:
- فقط ویژگی های مشخص شده در تماس slot.setConfig اصلاح شده است.
const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- تمام تنظیمات برای یک ویژگی معین با هر تماس به Slot.SetConfig به روز می شود.
// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- تمام تنظیمات یک ویژگی را می توان با عبور
null
پاک کرد.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
خواص | |
---|---|
ad Expansion ? | تنظیمات برای کنترل گسترش تبلیغ. |
component Auction ? | مجموعه ای از حراج های مؤلفه که در حراج تبلیغاتی در دستگاه قرار می گیرند. |
interstitial ? | تنظیماتی که رفتار شکاف AD را کنترل می کنند. |
خواص
adexpansion Optional
adExpansion ?: null | AdExpansionConfig
مؤلفه Optional
componentAuction ?: null | ComponentAuctionConfig []
بینابینی Optional
interstitial ?: null | InterstitialConfig
googletag.config.taxonomydata
خواص
ارزش ها
values : string []
googletag.enums
شمارش ها | |
---|---|
Out Of Page Format | قالب های خارج از صفحه پشتیبانی شده توسط GPT. |
Traffic Source | منابع ترافیکی پشتیبانی شده توسط GPT. |
شمارش ها
پیش بینی
OutOfPageFormat
- همچنین ببینید
پیشخدمت
googletag.events
رابط ها | |
---|---|
Event | رابط پایه برای همه رویدادهای GPT. |
Event Type Map | این یک نوع شبه است که یک نام رویداد را به نوع شیء رویداد مربوطه برای Service.AddeventListener و Service.RemoveEventListener ترسیم می کند. |
Game Manual Interstitial Slot Closed Event | این رویداد هنگامی اخراج می شود که یک شکاف بینابینی دستی توسط کاربر بسته شده است. |
Game Manual Interstitial Slot Ready Event | این رویداد هنگامی اخراج می شود که یک شکاف بینابینی دستی بازی آماده نمایش به کاربر باشد. |
Impression Viewable Event | این رویداد با توجه به معیارهای دید فعال ، هنگامی که یک تصور قابل مشاهده باشد ، اخراج می شود. |
Rewarded Slot Closed Event | این رویداد هنگامی که یک شکاف تبلیغاتی پاداش توسط کاربر بسته می شود ، اخراج می شود. |
Rewarded Slot Granted Event | این رویداد هنگامی اخراج می شود که پاداش برای مشاهده یک تبلیغ پاداش داده می شود. |
Rewarded Slot Ready Event | این رویداد هنگامی اخراج می شود که یک تبلیغ پاداش آماده نمایش باشد. |
Slot Onload Event | این رویداد هنگامی اخراج می شود که Iframe Creative رویداد بار خود را شلیک کند. |
Slot Render Ended Event | این رویداد هنگامی که کد خلاق به یک شکاف تزریق می شود ، اخراج می شود. |
Slot Requested Event | این رویداد هنگامی که یک تبلیغ برای یک شکاف خاص درخواست شده است ، اخراج می شود. |
Slot Response Received | این رویداد هنگامی اخراج می شود که پاسخ تبلیغاتی برای یک شکاف خاص دریافت شده است. |
Slot Visibility Changed Event | این رویداد هر زمان که درصد روی صفحه نمایش از منطقه یک آگهی تغییر می کند ، اخراج می شود. |
googletag.events.Event
خواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. |
slot | شکافی که باعث ایجاد این رویداد شد. |
- همچنین ببینید
خواص
نام سرویس
serviceName : string
شکاف
slot : Slot
googletag.events.eventtypemap
خواص | |
---|---|
game Manual Interstitial Slot Closed | نام مستعار برای رویدادها . |
game Manual Interstitial Slot Ready | نام مستعار برای رویدادها . |
impression Viewable | alias for Events.ImpressionViewableEvent . |
rewarded Slot Closed | نام مستعار برای رویدادها . |
rewarded Slot Granted | نام مستعار برای وقایع . |
rewarded Slot Ready | نام مستعار برای رویدادها . |
slot Onload | alias for Events.slotonloadevent . |
slot Render Ended | alias for Events.SlotrenderendedEvent . |
slot Requested | alias for Events.SlotRequesteEvent . |
slot Response Received | نام مستعار برای رویدادها . |
slot Visibility Changed | نام مستعار برای رویدادها . |
خواص
gamemanualinterstititialslotclosed
gameManualInterstitialSlotClosed : GameManualInterstitialSlotClosedEvent
gamemanualinterstititialslote
gameManualInterstitialSlotReady : GameManualInterstitialSlotReadyEvent
قابل مشاهده
impressionViewable : ImpressionViewableEvent
پاداش دار
rewardedSlotClosed : RewardedSlotClosedEvent
پاداش دار
rewardedSlotGranted : RewardedSlotGrantedEvent
پاداش دار
rewardedSlotReady : RewardedSlotReadyEvent
بار
slotOnload : SlotOnloadEvent
دارای شکاف
slotRenderEnded : SlotRenderEndedEvent
دارای شکاف
slotRequested : SlotRequestedEvent
در صورت اسلامی
slotResponseReceived : SlotResponseReceived
شیب دار
slotVisibilityChanged : SlotVisibilityChangedEvent
googletag.events.gamemanualinterstititialslotclosedevent
گسترش میتوجه: کتابچه راهنمای بازی بینابینی یک قالب با دسترسی محدود است.
خواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
// This listener is called when a game manual interstitial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
googletag.events.gamemanualinterstititialslotreevent
گسترش میتوجه: کتابچه راهنمای بازی بینابینی یک قالب با دسترسی محدود است.
خواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
روش ها | |
---|---|
make Game Manual Interstitial Visible | آگهی بینابینی دستی بازی را به کاربر نشان می دهد. |
- مثال
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
روش ها
makegamemanualinterstititialvisible
makeGameManualInterstitialVisible ( ) : void
googletag.events.impressionViewableEvent
گسترش میخواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- همچنین ببینید
googletag.events.rewardedslotclosedevent
گسترش میخواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
- همچنین ببینید
googletag.events.rewardedslotgrantedevent
گسترش میخواص | |
---|---|
payload | یک شیء حاوی اطلاعاتی در مورد پاداش اعطا شده است. |
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount, ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
- همچنین ببینید
خواص
محموله
payload : null | RewardedPayload
googletag.events.rewardedslotreevent
گسترش میخواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
روش ها | |
---|---|
make Rewarded Visible | تبلیغ پاداش را نشان می دهد. |
- مثال
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
- همچنین ببینید
روش ها
قابل استفاده
makeRewardedVisible ( ) : void
googletag.events.slotonloadevent
گسترش میSlotOnloadEvent
اخراج شود. خواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- همچنین ببینید
googletag.events.slotrenderendedevent
گسترش میخواص | |
---|---|
advertiser Id | آگهی تبلیغاتی آگهی ارائه شده. |
campaign Id | شناسه تبلیغاتی تبلیغات ارائه شده. |
company Ids | شناسه شرکتهایی که در تبلیغات پشتیبان ارائه شده پیشنهاد می کنند. |
creative Id | شناسه خلاق آگهی رزرواسیون ارائه شده. |
creative Template Id | شناسه الگوی خلاق آگهی رزرواسیون ارائه شده. |
is Backfill | این که آیا یک آگهی تبلیغاتی بود. |
is Empty | آیا یک تبلیغ برای شکاف بازگردانده شده است. |
label Ids | منسوخ شده است. |
line Item Id | شناسه مورد خط آگهی رزرواسیون ارائه شده. |
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
size | اندازه پیکسل خلاق ارائه شده را نشان می دهد. |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot Content Changed | آیا محتوای شکاف با تبلیغ ارائه شده تغییر کرده است. |
source Agnostic Creative Id | شناسه خلاقانه رزرو یا تبلیغات برگشتی. |
source Agnostic Line Item Id | شناسه آیتم خط از رزرو یا تبلیغات برگشتی. |
yield Group Ids | شناسه گروههای بازده برای تبلیغات برگشتی ارائه شده. |
- مثال
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- همچنین ببینید
خواص
تبلیغ کننده
advertiserId : null | number
null
است. شناسه کمپین
campaignId : null | number
null
است. شرکت
companyIds : null | number []
null
است. خلاق
creativeId : null | number
null
است. creativetemplateid
creativeTemplateId : null | number
null
است. isbackfill
isBackfill : boolean
false
صورت ، مقدار true
است. دارایی
isEmpty : boolean
false
این صورت مقدار true
است. برچسب های
labelIds : null | number []
خط خط
lineItemId : null | number
null
است. اندازه
size : null | string | number []
[728, 90]
. مقدار برای شکافهای تبلیغاتی خالی null
است. دارای شکاف
slotContentChanged : boolean
true
است ، در غیر این صورت false
. SourceAgnosticCreativeID
sourceAgnosticCreativeId : null | number
null
است. رفیق
sourceAgnosticLineItemId : null | number
null
است. گروههای عملکردی
yieldGroupIds : null | number []
null
است. googletag.events.SlotRequesteEvent
گسترش میخواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- همچنین ببینید
googletag.events.slotresponsereceived
گسترش میخواص | |
---|---|
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- همچنین ببینید
googletag.events.slotvisibilityChangedEvent
گسترش میخواص | |
---|---|
in View Percentage | درصد منطقه AD قابل مشاهده است. |
service Name | نام خدماتی که باعث ایجاد این رویداد شد. به ارث رسیده از |
slot | شکافی که باعث ایجاد این رویداد شد. به ارث رسیده از |
- مثال
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- همچنین ببینید
خواص
نمایشگاه
inViewPercentage : number
Googletag.Securesignals
رابط ها | |
---|---|
Bidder Signal Provider | یک سیگنال امن را برای یک پیشنهاد دهنده خاص برمی گرداند. |
Publisher Signal Provider | یک سیگنال امن را برای یک ناشر خاص برمی گرداند. |
Secure Signal Providers Array | رابط برای مدیریت سیگنال های امن. |
نام مستعار را تایپ کنید | |
---|---|
Secure Signal Provider | رابط برای بازگشت سیگنال ایمن برای یک پیشنهاد دهنده یا ارائه دهنده خاص. |
نام مستعار را تایپ کنید
SecuresignalProvider
SecureSignalProvider : BidderSignalProvider | PublisherSignalProvider
id
یا networkCode
باید ارائه شود ، اما نه هر دو. googletag.securesignals.biddersignalprovider
ارائه دهنده سیگنال امن پیشنهاد دهنده از 2 بخش تشکیل شده است:
- یک تابع جمع کننده ، که
Promise
برمی گرداند که به یک سیگنال ایمن برطرف می شود. -
id
ای که پیشنهاد دهنده مرتبط با سیگنال را مشخص می کند.
خواص | |
---|---|
collector Function | تابعی که Promise ای را برمی گرداند که به یک سیگنال ایمن برطرف می شود. |
id | یک شناسه منحصر به فرد برای جمع کننده مرتبط با این سیگنال امن ، همانطور که در Google AD Manager ثبت شده است. |
- مثال
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- همچنین ببینید
خواص
عملکرد
collectorFunction : ( ( ) => Promise < string > )
Promise
ای را برمی گرداند که به یک سیگنال ایمن برطرف می شود. شناسه
id : string
googletag.Securesignals.PublishersignalProvider
ارائه دهنده سیگنال ناشر از 2 بخش تشکیل شده است:
- یک تابع جمع کننده ، که
Promise
برمی گرداند که به یک سیگنال ایمن برطرف می شود. - یک
networkCode
که ناشر مرتبط با سیگنال را مشخص می کند.
خواص | |
---|---|
collector Function | تابعی که Promise ای را برمی گرداند که به یک سیگنال ایمن برطرف می شود. |
network Code | کد شبکه (همانطور که در مسیر واحد تبلیغ مشاهده می شود) برای ناشر مرتبط با این سیگنال امن. |
- مثال
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- همچنین ببینید
خواص
عملکرد
collectorFunction : ( ( ) => Promise < string > )
Promise
ای را برمی گرداند که به یک سیگنال ایمن برطرف می شود. کد
networkCode : string
googletag.securesignals.SecuresignalProvidersArray
روش ها | |
---|---|
clear All Cache | تمام سیگنال ها را برای همه کلکسیونرها از حافظه نهان پاک می کند. |
push | Securesignals.SecuresignalProvider را به آرایه ارائه دهنده سیگنال اضافه می کند و فرآیند تولید سیگنال را آغاز می کند. |
روش ها
ClearAllCache
clearAllCache ( ) : void
فراخوانی این روش ممکن است احتمال اینکه سیگنال ها را در درخواست های تبلیغاتی برای نماهای صفحه فعلی و بالقوه بعدی درج کنند ، کاهش دهد. به همین دلیل ، فقط باید در صورت بروز تغییرات معنی دار حالت ، مانند رویدادهایی که کاربر جدید را نشان می دهد (ورود به سیستم ، ورود به سیستم ، ثبت نام و غیره) فراخوانی شود.
فشار
push ( provider : SecureSignalProvider ) : void
پارامترها | |
---|---|
provider : SecureSignalProvider | Securesignals.SecuresignalProvider Object به آرایه اضافه می شود. |