مرجع GPT

این مرجع از نماد TypeScript برای توصیف انواع استفاده می‌کند. جدول زیر توضیح مختصری را با مثال ارائه می‌دهد.

عبارت تایپ
string نوع رشته اولیه.
string[] نوع آرایه، که مقادیر آن فقط می‌تواند رشته باشد.
number | string نوع اتحادی که مقدار آن می‌تواند عدد یا رشته باشد.
Array<number | string> نوع آرایه، که در آن مقادیر از نوع پیچیده (اتحاد) هستند.
[number, string] نوع چندتایی، که مقدار آن آرایه‌ای دو عنصری است که باید به‌ترتیب حاوی یک عدد و یک رشته باشد.
Slot نوع شیء، که مقدار آن نمونه‌ای از googletag.Slot است.
() => void نوع تابع بدون آرگومان‌های تعریف‌شده و بدون مقدار برگشتی.

برای آشنایی بیشتر با انواع پشتیبانی‌شده و عبارت‌های نوع، به TypeScript Handbook مراجعه کنید.

حاشیه‌نویسی‌های نوع

دونقطه بعداز متغیر، نام پارامتر، نام ویژگی، یا امضای تابع نشان‌دهنده حاشیه‌نویسی نوع است. حاشیه‌نویسی‌های نوع، انواع عنصری را که در سمت راست دونقطه قرار دارد می‌تواند بپذیرد یا برگرداند شرح می‌دهد. جدول زیر نمونه‌هایی از حاشیه‌نویسی‌های نوع را نشان می‌دهد که ممکن است در این مرجع ببینید.

حاشیه‌نویسی تایپ کنید
param: string نشان می‌دهد که param مقدار رشته‌ای را می‌پذیرد یا برمی‌گرداند. این نحو برای متغیرها، پارامترها، ویژگی‌ها، و انواع پاسخ استفاده می‌شود.
param?: number | string نشان می‌دهد که param اختیاری است، اما درصورت مشخص شدن، عدد یا رشته را می‌پذیرد. این نحو برای پارامترها و ویژگی‌ها استفاده می‌شود.
...params: Array<() => void> نشان می‌دهد که params یک پارامتر باقی‌مانده است که توابع را می‌پذیرد. پارامترهای Rest تعداد نامحدودی از مقادیر نوع مشخص‌شده را می‌پذیرند.

googletag

جای نام فراگیری که «برچسب ناشر Google» برای API خود استفاده می‌کند.
فضاهای نام
config
میانای پیکربندی اصلی برای تنظیمات سطح صفحه.
enums
این فضای نامی است که GPT برای انواع شمارشی استفاده می‌کند.
events
این جای‌نامی است که GPT برای «رویدادها» استفاده می‌کند.
secureSignals
این جای‌نامی است که GPT برای مدیریت سیگنال‌های امن استفاده می‌کند.
میانه‌ها
CommandArray
آرایه فرمان دنباله‌ای از توابع را می‌پذیرد و آن‌ها را به‌ترتیب فراخوانی می‌کند.
CompanionAdsService
سرویس «آگهی‌های همپا».
PrivacySettingsConfig
شیء پیکربندی برای تنظیمات حریم خصوصی.
PubAdsService
سرویس «آگهی‌های ناشر».
RequestHook
تابع بازخوانی که قبل‌از هر درخواست آگهی هنگام ثبت ازطریق PubAdsService.registerRequestHook فراخوانده می‌شود.
ResponseInformation
شیء نشان‌دهنده یک پاسخ آگهی.
RewardedPayload
شیء نشان‌دهنده پاداش مرتبط با آگهی پاداش‌دار.
Service
کلاس سرویس پایه که حاوی روش‌های مشترک برای همه سرویس‌ها است.
SizeMappingBuilder
سازنده برای اشیاء مشخصات نگاشت اندازه.
Slot
جایگاه شیئی است که یک جایگاه آگهی را در صفحه نشان می‌دهد.
نام‌های مستعار نوع
FluidSize
رشته اندازه که در آن محفظه آگهی ۱۰۰٪ عرض div والد خود را می‌گیرد و سپس ارتفاع آن را برای تناسب با محتوای طرح‌آگهی تغییر می‌دهد.
GeneralSize
پیکربندی اندازه معتبر برای جایگاه، که می‌تواند یک یا چند اندازه باشد.
MultiSize
فهرستی از اندازه‌های معتبر تکی.
NamedSize
اندازه‌های نام‌گذاری‌شده‌ای که جایگاه می‌تواند داشته باشد.
SingleSize
یک اندازه معتبر برای جایگاه.
SingleSizeArray
آرایه‌ای از دو عدد که نشان‌دهنده [عرض، ارتفاع] است.
SizeMapping
نگاشت اندازه ناحیه نمایش به اندازه‌های آگهی.
SizeMappingArray
فهرستی از نگاشت‌های اندازه.
متغیر
apiReady
پرچمی که نشان می‌دهد GPT API بارگیری شده و آماده فراخوانی است.
cmd
ارجاع به صف فرمان سراسری برای اجرای ناهمگام تماس‌های مرتبط با GPT.
pubadsReady
پرچمی که نشان می‌دهد PubAdsService فعال، بارگیری، و کاملاً عملیاتی شده است.
secureSignalProviders
ارجاع به آرایه ارائه‌دهندگان سیگنال امن.
توابع
companionAds
ارجاعی به CompanionAdsService برمی‌گرداند.
defineOutOfPageSlot
جایگاه آگهی خارج از صفحه را با مسیر واحد آگهی داده‌شده می‌سازد.
defineSlot
جایگاه آگهی را با مسیر و اندازه واحد آگهی داده‌شده می‌سازد و آن را با شناسه عنصر div در صفحه‌ای که حاوی آگهی خواهد بود مرتبط می‌کند.
destroySlots
جایگاه‌های داده‌شده را ازبین می‌برد و همه ارجاع‌ها و اشیای مرتبط با آن جایگاه‌ها را از GPT برمی‌دارد.
disablePublisherConsole
«کنسول ناشر Google» را غیرفعال می‌کند.
display
به سرویس‌های جایگاه دستور می‌دهد جایگاه را ارائه دهند.
enableServices
همه سرویس‌های GPT را که برای جایگاه‌های آگهی در صفحه تعریف شده‌اند فعال می‌کند.
getConfig
یک کپی ثابت از گزینه‌های پیکربندی عمومی برای صفحه تنظیم‌شده توسط setConfig دریافت می‌کند.
getVersion
نسخه فعلی GPT را برمی‌گرداند.
openConsole
«کنسول ناشر Google» را باز می‌کند.
pubads
ارجاعی به PubAdsService برمی‌گرداند.
setAdIframeTitle
عنوان را برای همه iframeهای محفظه آگهی که از این نقطه به بعد توسط PubAdsService ایجاد شده‌اند تنظیم می‌کند.
setConfig
گزینه‌های پیکربندی کلی را برای صفحه تنظیم می‌کند.
sizeMapping
SizeMappingBuilder جدیدی ایجاد می‌کند.

نام‌های مستعار نوع

FluidSize

FluidSize: "fluid"
رشته اندازه که در آن محفظه آگهی ۱۰۰٪ عرض div والد خود را می‌گیرد و سپس ارتفاع آن را برای تناسب با محتوای طرح‌آگهی تغییر می‌دهد. مشابه نحوه رفتار عناصر بلوک معمولی در صفحه. برای آگهی‌های بومی و برنمایی استفاده می‌شود (مقاله مرتبط را ببینید).

GeneralSize

GeneralSize: SingleSize | MultiSize
پیکربندی اندازه معتبر برای جایگاه، که می‌تواند یک یا چند اندازه باشد.

MultiSize

MultiSize: SingleSize[]
فهرستی از اندازه‌های معتبر تکی.

NamedSize

NamedSize: FluidSize | [FluidSize]
اندازه‌های نام‌گذاری‌شده‌ای که جایگاه می‌تواند داشته باشد. در بیشتر موارد، اندازه یک مستطیل با اندازه ثابت است، اما در برخی موارد به انواع دیگری از مشخصات اندازه نیاز داریم. فقط موارد زیر اندازه‌های نام‌گذاری‌شده معتبر هستند:
  • سیال: محفظه آگهی ۱۰۰٪ عرض div والد خود را می‌گیرد و سپس ارتفاع خود را تغییر می‌دهد تا با محتوای طرح‌آگهی مطابقت داشته باشد. مشابه نحوه رفتار عناصر بلوک معمولی در صفحه. برای آگهی‌های بومی و برنمایی استفاده می‌شود (مقاله مرتبط را ببینید). توجه داشته باشید که هر دو fluid و ['fluid'] فرم‌های قابل‌قبولی برای اعلام اندازه جایگاه به‌عنوان سیال هستند.

SingleSize

یک اندازه معتبر برای جایگاه.

SingleSizeArray

SingleSizeArray: [number, number]
آرایه‌ای از دو عدد که نشان‌دهنده [عرض، ارتفاع] است.

SizeMapping

نگاشت اندازه ناحیه نمایش به اندازه‌های آگهی. برای آگهی‌های واکنش‌گرا استفاده می‌شود.

SizeMappingArray

SizeMappingArray: SizeMapping[]
فهرستی از نگاشت‌های اندازه.

متغیر

Const apiReady

apiReady: boolean | undefined
پرچمی که نشان می‌دهد GPT API بارگیری شده و آماده فراخوانی است. این ویژگی تا زمانی که API آماده شود، به‌سادگی undefined خواهد بود.

توجه داشته باشید که روش توصیه‌شده برای مدیریت ناهمگام، استفاده از googletag.cmd برای صف‌بندی فراخوانی‌های برگشتی برای زمانی است که GPT آماده باشد. این فراخوانی‌های برگشتی نیازی به بررسی googletag.apiReady ندارند زیرا تضمین می‌شود که پس‌از راه‌اندازی میانای برنامه‌سازی کاربردی اجرا شوند.

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray
ارجاع به صف فرمان سراسری برای اجرای ناهمگام تماس‌های مرتبط با GPT.

متغیر googletag.cmd با نحو برچسب GPT در صفحه به یک آرایه جاوا اسکریپت خالی مقداردهی اولیه می‌شود و cmd.push روش استاندارد Array.push است که عنصری را به انتهای آرایه اضافه می‌کند. وقتی جاوا اسکریپت GPT بار می‌شود، آرایه را بررسی می‌کند و همه توابع را به‌ترتیب اجرا می‌کند. سپس اسکریپت cmd را با شیء CommandArray جایگزین می‌کند که روش push آن برای اجرای متغیر مستقل تابع ارسال‌شده به آن تعریف شده است. این سازوکار به GPT اجازه می‌دهد با واکشی ناهمگام جاوا اسکریپت، تأخیر درک‌شده را کاهش دهد و درعین‌حال به مرورگر اجازه می‌دهد به رندر کردن صفحه ادامه دهد.
مثال

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

Const pubadsReady

pubadsReady: boolean | undefined
پرچمی که نشان می‌دهد PubAdsService فعال، بارگیری، و کاملاً عملیاتی شده است. این ویژگی تا زمانی که enableServices فراخوانی شود و PubAdsService بارگیری و مقداردهی اولیه شود، به‌سادگی undefined خواهد بود.

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
ارجاع به آرایه ارائه‌دهندگان سیگنال امن.

آرایه ارائه‌دهندگان سیگنال امن توالی‌ای از توابع تولید سیگنال را می‌پذیرد و آن‌ها را به‌ترتیب فراخوانی می‌کند. این تابع برای جایگزینی آرایه استانداردی درنظر گرفته شده است که برای صف‌بندی توابع تولید سیگنال استفاده می‌شود تا پس‌از بار شدن GPT فراخوانی شوند.
مثال

JavaScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

TypeScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});
همچنین مراجعه کنید به

توابع

companionAds

companionAds(): CompanionAdsService
ارجاعی به CompanionAdsService برمی‌گرداند.
بازگشتی‌ها
CompanionAdsServiceسرویس «آگهی‌های همپا».

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
جایگاه آگهی خارج‌از صفحه را با مسیر واحد آگهی داده‌شده می‌سازد.

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

برای آگهی‌های خارج‌از صفحه مدیریت‌شده GPT،‏ div یک OutOfPageFormat پشتیبانی‌شده است.
مثال

JavaScript

// 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);

TypeScript

// 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مسیر واحد آگهی کامل با کد شبکه و کد واحد آگهی.
Optional div: string | OutOfPageFormatشناسه div که حاوی این واحد آگهی یا OutOfPageFormat خواهد بود.
بازگشتی‌ها
Slot | nullجایگاه تازه ایجادشده، یا null اگر جایگاهی ایجاد نشود.

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
جایگاه آگهی را با اندازه و مسیر واحد آگهی داده‌شده می‌سازد و آن را با شناسه عنصر div در صفحه‌ای که آگهی را دربرخواهد داشت مرتبط می‌کند.
مثال

JavaScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
همچنین مراجعه کنید به
پارامترها
adUnitPath: stringمسیر واحد آگهی کامل با کد شبکه و کد واحد.
size: GeneralSizeعرض و ارتفاع جایگاه اضافه‌شده. این اندازه‌ای است که در درخواست آگهی استفاده می‌شود اگر هیچ نگاشت اندازه واکنش‌گرایی ارائه نشده باشد یا اندازه نمای دید از کوچک‌ترین اندازه ارائه‌شده در نگاشت کوچک‌تر باشد.
Optional div: stringشناسه div که حاوی این واحد آگهی خواهد بود.
بازگشتی‌ها
Slot | nullجایگاه تازه ایجادشده، یا null اگر جایگاهی ایجاد نشود.

destroySlots

destroySlots(slots?: Slot[]): boolean
جایگاه‌های داده‌شده را ازبین می‌برد و همه ارجاع‌ها و اشیای مرتبط با آن جایگاه‌ها را از GPT برمی‌دارد. این API از جایگاه‌های بازگشتی و جایگاه‌های همراه پشتیبانی نمی‌کند.

فراخوانی این API در یک جایگاه، آگهی را پاک می‌کند و شیء جایگاه را از وضعیت داخلی که توسط GPT نگهداری می‌شود، حذف می‌کند. فراخوانی هر تابع دیگری در شیء جایگاه منجر به رفتار تعریف‌نشده خواهد شد. توجه داشته باشید که اگر ارجاع به آن جایگاه توسط صفحه ناشر حفظ شود، ممکن است مرورگر همچنان حافظه مرتبط با آن جایگاه را آزاد نکند. فراخوانی این API باعث می‌شود div مرتبط با آن جایگاه برای استفاده مجدد دردسترس قرار گیرد.

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

JavaScript

// 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();

TypeScript

// 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();
پارامترها
Optional slots: Slot[]آرایه فضاهای خالی برای ازبین بردن. آرایه اختیاری است؛ اگر مشخص نشده باشد، همه جایگاه‌ها ازبین خواهند رفت.
بازگشتی‌ها
booleantrue اگر جایگاه‌ها ازبین رفته باشند، درغیراین‌صورت false.

disablePublisherConsole

disablePublisherConsole(): void
«کنسول ناشر Google» را غیرفعال می‌کند.
همچنین مراجعه کنید به

نمایشگر

display(divOrSlot: string | Element | Slot): void
به سرویس‌های جایگاه دستور می‌دهد جایگاه را ارائه دهند. هر جایگاه آگهی باید فقط یک‌بار در هر صفحه نمایش داده شود. همه جایگاه‌ها باید تعریف شوند و سرویسی به آن‌ها اختصاص داده شود تا نمایش داده شوند. فراخوانی نمایش نباید تا زمانی که عنصر در DOM وجود دارد اتفاق بیفتد. روش معمول برای دستیابی به این هدف، قرار دادن آن در یک بلوک اسکریپت در عنصر div نام‌گذاری‌شده در فراخوانی روش است.

اگر از معماری درخواست واحد (SRA) استفاده می‌شود، همه جایگاه‌های آگهی واکشی‌نشده در زمان فراخوانی این روش به‌طور هم‌زمان واکشی خواهند شد. برای اینکه جایگاه آگهی را مجبور کنید نمایش داده نشود، باید کل div برداشته شود.
همچنین مراجعه کنید به
پارامترها
divOrSlot: string | Element | Slotشناسه عنصر div حاوی جایگاه آگهی یا عنصر div، یا شیء جایگاه. اگر عنصر div ارائه شده باشد، باید مشخصه «id» داشته باشد که با شناسه ارسال‌شده به defineSlot مطابقت داشته باشد.

enableServices

enableServices(): void
همه سرویس‌های GPT را که برای جایگاه‌های آگهی در صفحه تعریف شده‌اند فعال می‌کند.

getConfig

getConfig(keys: string | string[]): Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>
یک کپی ثابت از گزینه‌های پیکربندی عمومی برای صفحه تنظیم‌شده توسط setConfig دریافت می‌کند.

همه ویژگی‌های setConfig() توسط این روش پشتیبانی نمی‌شوند. دارایی‌های پشتیبانی‌شده:
مثال

JavaScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
پارامترها
keys: string | string[]کلیدهای گزینه‌های پیکربندی برای دریافت.
بازگشتی‌ها
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>نسخه ثابتی از گزینه‌های پیکربندی برای صفحه.

getVersion

getVersion(): string
نسخه فعلی GPT را برمی‌گرداند.
همچنین مراجعه کنید به
بازگشتی‌ها
stringرشته نسخه GPT درحال اجرا.

openConsole

openConsole(div?: string): void
«کنسول ناشر Google» را باز می‌کند.
مثال

JavaScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

TypeScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();
همچنین مراجعه کنید به
پارامترها
Optional div: stringشناسه div جایگاه آگهی. این مقدار اختیاری است. درصورت ارائه، «کنسول ناشر» تلاش می‌کند با جزئیات جایگاه آگهی مشخص‌شده در نما باز شود.

pubads

pubads(): PubAdsService
ارجاعی به PubAdsService برمی‌گرداند.
بازگشتی‌ها
PubAdsServiceسرویس Publisher Ads.

setAdIframeTitle

setAdIframeTitle(title: string): void
عنوان را برای همه iframeهای محفظه آگهی ایجادشده توسط PubAdsService از این نقطه به بعد تنظیم می‌کند.
مثال

JavaScript

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");
پارامترها
title: stringعنوان جدید برای همه iframeهای محفظه آگهی.

setConfig

setConfig(config: PageSettingsConfig): void
گزینه‌های پیکربندی کلی را برای صفحه تنظیم می‌کند.
پارامترها
config: PageSettingsConfig

sizeMapping

sizeMapping(): SizeMappingBuilder
SizeMappingBuilder جدیدی ایجاد می‌کند.
همچنین مراجعه کنید به
بازگشتی‌ها
SizeMappingBuilderسازنده جدید.

googletag.CommandArray

آرایه فرمان دنباله‌ای از توابع را می‌پذیرد و آن‌ها را به‌ترتیب فراخوانی می‌کند. این تابع برای جایگزینی آرایه استانداردی درنظر گرفته شده است که برای صف‌بندی توابع استفاده می‌شود تا پس‌از بار شدن GPT فراخوانی شوند.
روش‌ها
push
دنباله توابع مشخص‌شده در متغیرهای مستقل را به‌ترتیب اجرا می‌کند.

روش‌ها

فشار دادن

push(...f: ((this: typeof globalThis) => void)[]): number
دنباله توابع مشخص‌شده در متغیرهای مستقل را به‌ترتیب اجرا می‌کند.
مثال

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});
پارامترها
Rest ...f: ((this: typeof globalThis) => void)[]تابع جاوا اسکریپت برای اجرا. اتصال زمان اجرا همیشه globalThis خواهد بود. برای حفظ مقدار this بافت واژگانی محصور، یک تابع پیکان ارسال کنید.
بازگشتی‌ها
numberتعداد فرمان‌هایی که تاکنون پردازش شده است. این با مقدار برگشتی Array.push (طول فعلی آرایه) سازگار است.

googletag.CompanionAdsService

تمدید Service
سرویس «آگهی‌های همپا». آگهی‌های ویدیویی از این سرویس برای نمایش آگهی‌های همپا استفاده می‌کنند.
روش‌ها
addEventListener
شنونده‌ای را ثبت می‌کند که به شما امکان می‌دهد وقتی رویداد GPT خاصی در صفحه اتفاق می‌افتد، تابع جاوا اسکریپت را راه‌اندازی و فراخوانی کنید.
getSlots
فهرست وقت‌های مرتبط با این سرویس را دریافت کنید.
removeEventListener
شنونده‌ای را که قبلاً ثبت شده است برمی‌دارد.
setRefreshUnfilledSlots
تنظیم می‌کند که آیا جایگاه‌های همراهی که پر نشده‌اند به‌طور خودکار پر شوند یا نه.
همچنین مراجعه کنید به

روش‌ها

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void
تعیین می‌کند که آیا جایگاه‌های همراهی که پر نشده‌اند به‌طور خودکار پر شوند یا نه.

این روش را می‌توان چندین بار درطول عمر صفحه برای روشن و خاموش کردن پر کردن خودکار فراخوانی کرد. فقط جایگاه‌هایی که در PubAdsService نیز ثبت شده‌اند به‌طور خودکار پر می‌شوند. به‌دلیل محدودیت‌های خط‌مشی، این روش برای پر کردن جایگاه‌های همراه خالی هنگام ارائه ویدیو Ad Exchange طراحی نشده است.
مثال

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);
پارامترها
value: booleantrue برای پر کردن خودکار جایگاه‌های پرنشده، false برای بدون تغییر گذاشتن آن‌ها.

googletag.PrivacySettingsConfig

شیء پیکربندی برای تنظیمات حریم خصوصی.
مشخصات
childDirectedTreatment?
نشان می‌دهد که آیا صفحه باید مختص کودکان درنظر گرفته شود یا نه.
limitedAds?
امکان ارائه در حالت آگهی‌های محدود را فراهم می‌کند تا به ناشر در برآورده کردن نیازهای رعایت استانداردهای نظارتی کمک کند.
nonPersonalizedAds?
امکان اجرای آگهی در حالت آگهی‌های شخصی‌سازی‌نشده را فراهم می‌کند تا به ناشر در برآورده کردن نیازهای رعایت استانداردهای نظارتی کمک کند.
restrictDataProcessing?
امکان ارائه در حالت پردازش محدود را فراهم می‌کند تا به ناشر در برآورده کردن نیازهای مربوط به رعایت استانداردهای نظارتی کمک کند.
tagForAgeTreatment?
رفتار دارای محدودیت سنی، که نشان می‌دهد درخواست آگهی باید به‌عنوان کودک، نوجوان، یا نامشخص درنظر گرفته شود.
trafficSource?
نشان می‌دهد که آیا درخواست‌ها نشان‌دهنده ترافیک خریداری‌شده یا طبیعی هستند.
underAgeOfConsent?
نشان می‌دهد که آیا درخواست‌های آگهی به‌عنوان درخواست‌های ارسالی ازسوی کاربران زیر سن رضایت علامت‌گذاری شوند یا نه.
همچنین مراجعه کنید به

مشخصات

Optional childDirectedTreatment

childDirectedTreatment?: boolean
نشان می‌دهد که آیا صفحه باید مختص کودکان درنظر گرفته شود یا نه. برای پاک کردن پیکربندی، روی null تنظیم کنید.

Optional limitedAds

limitedAds?: boolean
امکان ارائه در حالت آگهی‌های محدود را فراهم می‌کند تا به ناشر در برآورده کردن نیازهای رعایت استانداردهای نظارتی کمک کند.

می‌توانید به دو روش به GPT دستور دهید که آگهی‌های محدود درخواست کند:
  • به‌طور خودکار، بااستفاده از سیگنالی از پلاتفرم مدیریت رضایت‌ها IAB TCF v2.0.
  • به‌صورت دستی، با تنظیم مقدار این فیلد روی true.
پیکربندی دستی آگهی‌های محدود فقط زمانی امکان‌پذیر است که GPT از نشانی وب آگهی‌های محدود بار شود. تلاش برای تغییر این تنظیمات وقتی GPT از نشانی وب استاندارد بار شده باشد، هشدار کنسول ناشر ایجاد می‌کند.

توجه داشته باشید که وقتی CMP درحال استفاده است، لازم نیست آگهی‌های محدود را به‌صورت دستی فعال کنید.
مثال

JavaScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

TypeScript

// 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

nonPersonalizedAds?: boolean
امکان اجرای آگهی در حالت آگهی‌های شخصی‌سازی‌نشده را فراهم می‌کند تا به ناشر در برآورده کردن نیازهای رعایت استانداردهای نظارتی کمک کند.

Optional restrictDataProcessing

restrictDataProcessing?: boolean
امکان ارائه در حالت پردازش محدود را فراهم می‌کند تا به ناشر در برآورده کردن نیازهای مربوط به رعایت استانداردهای نظارتی کمک کند.

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment
رفتار محدودشده براساس سن، که نشان می‌دهد درخواست آگهی باید به‌عنوان کودک، نوجوان، یا نامشخص درنظر گرفته شود.

با مشاور حقوقی خود مشورت کنید تا تنظیمات رفتار براساس سن را برای کاربران خود براساس الزامات قانونی و نظارتی تعیین کنید. برای اطلاعات بیشتر درباره این تنظیم، این مقاله «مرکز راهنمایی» را مرور کنید.

با تنظیم این ویژگی، تأیید می‌کنید که این اعلان دقیق است و شما مجاز هستید ازطرف مالک سایت اقدام کنید. می‌دانید که سوءاستفاده از این تنظیم ممکن است به بسته شدن حساب Google شما منجر شود.
مثال

JavaScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

TypeScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

Optional trafficSource

trafficSource?: TrafficSource
نشان می‌دهد که آیا درخواست‌ها نشان‌دهنده ترافیک خریداری‌شده یا طبیعی هستند. این مقدار بعد منبع ترافیک را در گزارش‌دهی Ad Manager درج می‌کند. اگر تنظیم نشده باشد، منبع ترافیک به‌طور پیش‌فرض روی undefined در گزارش‌دهی تنظیم می‌شود.
مثال

JavaScript

// 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,
});

TypeScript

// 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?: boolean
نشان می‌دهد که آیا درخواست‌های آگهی به‌عنوان درخواست‌های ارسالی ازسوی کاربران زیر سن رضایت علامت‌گذاری شوند یا نه. برای پاک کردن پیکربندی، روی null تنظیم کنید.

googletag.PubAdsService

تمدید Service
سرویس «آگهی‌های ناشر». از این سرویس برای واکشی و نمایش آگهی‌ها از حساب Google Ad Manager شما استفاده می‌شود.
روش‌ها
addEventListener
شنونده‌ای را ثبت می‌کند که به شما امکان می‌دهد وقتی رویداد GPT خاصی در صفحه اتفاق می‌افتد، تابع جاوا اسکریپت را راه‌اندازی و فراخوانی کنید.
clear
آگهی‌ها را از جایگاه‌های داده‌شده برمی‌دارد و آن‌ها را با محتوای خالی جایگزین می‌کند.
clearCategoryExclusions
منسوخ‌شده. همه برچسب‌های استثنای دسته آگهی در سطح صفحه را پاک می‌کند.
clearTargeting
منسوخ‌شده. پارامترهای هدف‌یابی سفارشی را برای کلیدی خاص یا همه کلیدها پاک می‌کند.
collapseEmptyDivs
منسوخ‌شده. جمع کردن divهای جایگاه را فعال می‌کند تا وقتی محتوای آگهی برای نمایش وجود ندارد، هیچ فضایی را در صفحه اشغال نکنند.
disableInitialLoad
منسوخ‌شده. درخواست‌های آگهی را هنگام بار کردن صفحه غیرفعال می‌کند، اما اجازه می‌دهد آگهی‌ها با فراخوانی PubAdsService.refresh درخواست شوند.
display
جایگاه آگهی را با اندازه و مسیر واحد آگهی داده‌شده می‌سازد و نمایش می‌دهد.
enableLazyLoad
منسوخ‌شده. بار کردن کُند را در GPT همان‌طور که توسط شیء پیکربندی تعریف شده است فعال می‌کند.
enableSingleRequest
منسوخ‌شده. حالت درخواست تکی را برای واکشی هم‌زمان چند آگهی فعال می‌کند.
enableVideoAds
منسوخ‌شده. به GPT علامت می‌دهد که آگهی‌های ویدیویی در صفحه وجود خواهد داشت.
get
منسوخ‌شده. مقدار مشخصه AdSense مرتبط با کلید ارائه‌شده را برمی‌گرداند.
getAttributeKeys
منسوخ‌شده. کلیدهای مشخصه‌ای را که در این سرویس تنظیم شده است برمی‌گرداند.
getSlots
فهرست وقت‌های مرتبط با این سرویس را دریافت کنید.
getTargeting
منسوخ‌شده. پارامتر هدف‌یابی سطح سرویس سفارشی خاصی را که تنظیم شده است برمی‌گرداند.
getTargetingKeys
منسوخ‌شده. فهرست همه کلیدهای هدف‌یابی سطح سرویس سفارشی را که تنظیم شده‌اند برمی‌گرداند.
isInitialLoadDisabled
منسوخ‌شده. برمی‌گرداند که آیا درخواست‌های اولیه برای آگهی‌ها با موفقیت توسط تماس قبلی PubAdsService.disableInitialLoad غیرفعال شده است یا نه.
refresh
آگهی‌های جدید را برای جایگاه‌های خاص یا همه جایگاه‌های صفحه واکشی و نمایش می‌دهد.
registerRequestHook
یک قلاب را ثبت می‌کند تا به‌طور موازی با سایر قلاب‌های ثبت‌شده قبل‌از هر درخواست آگهی در صفحه در یک مهلت زمانی سراسری اجرا شود.
removeEventListener
شنونده‌ای را که قبلاً ثبت شده است برمی‌دارد.
set
منسوخ‌شده. مقادیری را برای مشخصه‌های AdSense تنظیم می‌کند که برای همه جایگاه‌های آگهی تحت سرویس «آگهی‌های ناشر» اعمال می‌شود.
setCategoryExclusion
منسوخ‌شده. مستثنی کردن دسته آگهی در سطح صفحه را برای نام برچسب ارائه‌شده تنظیم می‌کند.
setCentering
منسوخ‌شده. مرکز قرار دادن افقی آگهی‌ها را فعال و غیرفعال می‌کند.
setForceSafeFrame
منسوخ‌شده. پیکربندی می‌کند که آیا همه آگهی‌های صفحه باید بااستفاده از محفظه SafeFrame به‌اجبار ارائه شوند یا نه.
setLocation
منسوخ‌شده. اطلاعات مکان را از وب‌سایت‌ها منتقل می‌کند تا بتوانید هدف‌یابی جغرافیایی را برای مکان‌های خاصی انجام دهید.
setPrivacySettings
امکان پیکربندی همه تنظیمات حریم خصوصی از یک میانای برنامه‌سازی کاربردی بااستفاده از شیء پیکربندی را فراهم می‌کند.
setPublisherProvidedId
مقدار شناسه ارائه‌شده توسط ناشر را تنظیم می‌کند.
setSafeFrameConfig
منسوخ‌شده. اولویت‌های سطح صفحه را برای پیکربندی SafeFrame تنظیم می‌کند.
setTargeting
منسوخ‌شده. پارامترهای هدف‌یابی سفارشی را برای کلید مشخصی تنظیم می‌کند که برای همه جایگاه‌های آگهی سرویس Publisher Ads اعمال می‌شود.
setVideoContent
منسوخ‌شده. اطلاعات محتوای ویدیویی را برای ارسال همراه با درخواست‌های آگهی برای اهداف هدف‌یابی و مستثنا کردن محتوا تنظیم می‌کند.
updateCorrelator
همبسته‌ساز ارسال‌شده با درخواست‌های آگهی را تغییر می‌دهد و به‌طور مؤثر بازدید صفحه جدیدی را شروع می‌کند.

روش‌ها

پاک کردن

clear(slots?: Slot[]): boolean
آگهی‌ها را از جایگاه‌های داده‌شده برمی‌دارد و آن‌ها را با محتوای خالی جایگزین می‌کند. جایگاه‌ها به‌عنوان واکشی‌نشده علامت‌گذاری خواهند شد.

به‌طور خاص، پاک کردن جایگاه، آگهی را از بازدید صفحه طولانی‌مدت GPT برمی‌دارد، بنابراین درخواست‌های آتی تحت‌تأثیر آگهی‌های انحصاری یا استثناهای رقابتی مربوط به این آگهی قرار نخواهند گرفت.
مثال

JavaScript

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();

TypeScript

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();
پارامترها
Optional slots: Slot[]آرایه جایگاه‌ها برای پاک کردن. آرایه اختیاری است؛ اگر مشخص نشده باشد، همه جایگاه‌ها پاک خواهد شد.
بازگشتی‌ها
booleanاگر جایگاه‌ها پاک شده باشند، true را برمی‌گرداند، درغیراین‌صورت false را برمی‌گرداند.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService
همه برچسب‌های استثنای دسته آگهی در سطح صفحه را پاک می‌کند. این کار زمانی مفید است که بخواهید جایگاه را بازآوری کنید.
مثال

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.
همچنین مراجعه کنید به
بازگشتی‌ها
PubAdsServiceشیء سرویسی که روش روی آن فراخوانی شده است.

clearTargeting

clearTargeting(key?: string): PubAdsService
پارامترهای هدف‌یابی سفارشی را برای کلیدی خاص یا همه کلیدها پاک می‌کند.
مثال

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.
همچنین مراجعه کنید به
پارامترها
Optional key: stringکلید پارامتر هدف‌یابی. کلید اختیاری است؛ اگر مشخص نشده باشد، همه پارامترهای هدف‌یابی پاک خواهند شد.
بازگشتی‌ها
PubAdsServiceشیء سرویسی که روش روی آن فراخوانی شده است.

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
امکان جمع کردن بخش‌های جایگاه را فراهم می‌کند تا وقتی محتوای آگهی برای نمایش وجود ندارد، هیچ فضایی را در صفحه اشغال نکنند. این حالت باید قبل‌از فعال شدن سرویس تنظیم شود.
همچنین مراجعه کنید به
پارامترها
Optional collapseBeforeAdFetch: booleanآیا جایگاه‌ها حتی قبل‌از واکشی آگهی‌ها جمع شوند یا نه. این پارامتر اختیاری است؛ اگر ارائه نشود، false به‌عنوان مقدار پیش‌فرض استفاده خواهد شد.
بازگشتی‌ها
booleanاگر حالت جمع شدن div فعال شده باشد، true را برمی‌گرداند و اگر فعال کردن حالت جمع شدن غیرممکن باشد، false را برمی‌گرداند زیرا این روش پس‌از فعال شدن سرویس فراخوانی شده است.

disableInitialLoad

disableInitialLoad(): void
درخواست‌های آگهی را هنگام بار کردن صفحه غیرفعال می‌کند، اما اجازه می‌دهد آگهی‌ها با فراخوانی PubAdsService.refresh درخواست شوند. این مورد باید قبل‌از فعال کردن سرویس تنظیم شود. باید از حالت ناهمگام استفاده شود؛ درغیراین‌صورت، درخواست آگهی بااستفاده از refresh غیرممکن خواهد بود.
همچنین مراجعه کنید به

نمایشگر

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
جایگاه آگهی را با اندازه و مسیر واحد آگهی داده‌شده می‌سازد و نمایش می‌دهد.

این روش معادل کوتاه‌شده‌ای برای فراخوانی googletag.defineSlot است که بلافاصله با googletag.display دنبال می‌شود.

رفتار این روش به این بستگی دارد که معماری درخواست تکی (SRA) فعال باشد یا نه:
  • SRA فعال است: همه جایگاه‌های آگهی تعریف‌شده تا نقطه این تماس دسته‌بندی می‌شوند و باهم درخواست می‌شوند.
  • SRA غیرفعال است (پیش‌فرض): جایگاه آگهی به‌صورت جداگانه درخواست خواهد شد.
توجه: وقتی این روش فراخوانی می‌شود، عکس آنی از جایگاه و وضعیت صفحه ایجاد می‌شود تا از سازگاری هنگام ارسال درخواست آگهی و ارائه پاسخ اطمینان حاصل شود. هرگونه تغییری که پس‌از فراخوانی این روش در جایگاه یا وضعیت صفحه ایجاد شود (ازجمله هدف‌یابی، تنظیمات حریم خصوصی، اجبار SafeFrame، و غیره) فقط برای درخواست‌های بعدی display() یا refresh() اعمال خواهد شد.
مثال

JavaScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
همچنین مراجعه کنید به
پارامترها
adUnitPath: stringمسیر واحد آگهی جایگاهی که باید ارائه شود.
size: GeneralSizeعرض و ارتفاع جایگاه.
Optional div: string | Elementشناسه div حاوی جایگاه یا خود عنصر div.
Optional clickUrl: stringنشانی وب کلیک برای استفاده در این جایگاه.

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void
بار کردن کُند را در GPT همان‌طور که توسط شیء پیکربندی تعریف شده است فعال می‌کند. برای نمونه‌های دقیق‌تر، نمونه بار کردن کُند را ببینید.

توجه: واکشی کُند در SRA فقط درصورتی کار می‌کند که همه جایگاه‌ها خارج از حاشیه واکشی باشند.
مثال

JavaScript

googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

TypeScript

googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});
همچنین مراجعه کنید به
پارامترها
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}		شیء پیکربندی امکان سفارشی‌سازی رفتار تنبل را فراهم می‌کند. هر پیکربندی حذف‌شده‌ای از پیش‌فرضی استفاده خواهد کرد که Google تنظیم کرده است و به‌مرور زمان تنظیم خواهد شد. برای غیرفعال کردن تنظیم خاصی، مثل حاشیه واکشی، مقدار را روی -1 تنظیم کنید.
  • fetchMarginPercent

    حداقل فاصله‌ای که جایگاه باید از ناحیه نمایش فعلی داشته باشد تا آگهی را به‌عنوان درصدی از اندازه ناحیه نمایش واکشی کنیم. مقدار ۰ یعنی «وقتی جایگاه وارد ناحیه نمایش می‌شود»، ۱۰۰ یعنی «وقتی آگهی ۱ ناحیه نمایش فاصله دارد»، و غیره.
  • renderMarginPercent

    حداقل فاصله‌ای که جایگاه باید از نمای فعلی داشته باشد تا آگهی را ارائه کنیم. این کار امکان واکشی پیشاپیش آگهی را فراهم می‌کند، اما برای ارائه و بارگیری سایر منابع فرعی منتظر می‌ماند. این مقدار دقیقاً مانند fetchMarginPercent به‌عنوان درصدی از نمای هدف عمل می‌کند.
  • mobileScaling

    ضریبی که برای حاشیه‌ها در دستگاه‌های همراه اعمال می‌شود. این کار باعث می‌شود حاشیه‌ها در تلفن همراه و رایانه متفاوت باشد. برای مثال، مقدار ۲.۰ همه حاشیه‌ها را در دستگاه‌های همراه در ۲ ضرب می‌کند و حداقل فاصله‌ای را که جایگاه می‌تواند قبل‌از واکشی و ارائه داشته باشد افزایش می‌دهد.

enableSingleRequest

enableSingleRequest(): boolean
حالت درخواست تکی را برای واکشی هم‌زمان چند آگهی فعال می‌کند. این کار مستلزم آن است که همه جایگاه‌های «آگهی‌های ناشر» قبل‌از فعال کردن سرویس تعریف و به PubAdsService اضافه شوند. حالت درخواست تکی باید قبل‌از فعال شدن سرویس تنظیم شود.
همچنین مراجعه کنید به
بازگشتی‌ها
booleanاگر حالت درخواست تکی فعال شده باشد، true را برمی‌گرداند و اگر فعال کردن حالت درخواست تکی غیرممکن باشد، false را برمی‌گرداند زیرا این روش پس‌از فعال شدن سرویس فراخوانی شده است.

enableVideoAds

enableVideoAds(): void
به GPT علامت می‌دهد که آگهی‌های ویدیویی در صفحه وجود خواهد داشت. این کار محدودیت‌های حذف رقابتی را در آگهی‌های تصویری و ویدیویی فعال می‌کند. اگر محتوای ویدیو مشخص است، PubAdsService.setVideoContent را فراخوانی کنید تا بتوانید از مستثنا کردن محتوا برای آگهی‌های تصویری استفاده کنید.

دریافت

get(key: string): string
مقدار مشخصه AdSense مرتبط با کلید داده‌شده را برمی‌گرداند.
مثال

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.
همچنین مراجعه کنید به
پارامترها
key: stringنام مشخصه‌ای که باید جستجو شود.
بازگشتی‌ها
stringمقدار فعلی برای کلید مشخصه، یا null اگر کلید وجود نداشته باشد.

getAttributeKeys

getAttributeKeys(): string[]
کلیدهای مشخصه‌ای را که در این سرویس تنظیم شده است برمی‌گرداند.
مثال

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].
بازگشتی‌ها
string[]آرایه کلیدهای مشخصه تنظیم‌شده در این سرویس. ترتیب تعریف نشده است.

getTargeting

getTargeting(key: string): string[]
پارامتر هدف‌یابی سطح سرویس سفارشی خاصی را که تنظیم شده است برمی‌گرداند.
مثال

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).
پارامترها
key: stringکلید هدف‌یابی برای جستجو.
بازگشتی‌ها
string[]مقادیر مرتبط با این کلید، یا آرایه خالی اگر چنین کلیدی وجود نداشته باشد.

getTargetingKeys

getTargetingKeys(): string[]
فهرست همه کلیدهای هدف‌یابی سطح سرویس سفارشی را که تنظیم شده‌اند برمی‌گرداند.
مثال

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].
بازگشتی‌ها
string[]آرایه کلیدهای هدف‌یابی. ترتیب تعریف نشده است.

isInitialLoadDisabled

isInitialLoadDisabled(): boolean
برمی‌گرداند که آیا درخواست‌های اولیه برای آگهی‌ها با موفقیت توسط تماس قبلی PubAdsService.disableInitialLoad غیرفعال شده است یا نه.
بازگشتی‌ها
booleanاگر فراخوانی قبلی به PubAdsService.disableInitialLoad موفقیت‌آمیز باشد، true را برمی‌گرداند، درغیراین‌صورت false را برمی‌گرداند.

بازآوری

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void
آگهی‌های جدید را برای جایگاه‌های خاص یا همه جایگاه‌های صفحه واکشی و نمایش می‌دهد. فقط در حالت پرداز ناهمگام کار می‌کند.

برای رفتار مناسب در همه مرورگرها، فراخوانی refresh باید قبل‌از فراخوانی display جایگاه آگهی انجام شود. اگر تماس با display حذف شود، ممکن است بازآوری رفتار غیرمنتظره‌ای داشته باشد. درصورت تمایل، می‌توان از روش PubAdsService.disableInitialLoad برای متوقف کردن display از واکشی آگهی استفاده کرد.

بازآوری جایگاه، آگهی قدیمی را از بازدید صفحه طولانی‌مدت GPT برمی‌دارد، بنابراین درخواست‌های آتی تحت‌تأثیر آگهی‌های انحصاری یا استثناهای رقابتی مربوط به آن آگهی قرار نخواهند گرفت.
مثال

JavaScript

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 });

TypeScript

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 });
همچنین مراجعه کنید به
پارامترها
Optional slots: Slot[]جایگاه‌های آگهی برای بازآوری. آرایه اختیاری است؛ اگر مشخص نشده باشد، همه جایگاه‌ها بازآوری خواهند شد.
Optional options: {
  changeCorrelator: boolean;
}		گزینه‌های پیکربندی مرتبط با این تماس بازآوری.
  • changeCorrelator

    مشخص می‌کند که آیا همبسته‌ساز جدیدی برای واکشی آگهی‌ها تولید شود یا نه. سرورهای آگهی ما این مقدار همبسته را برای مدت کوتاهی (درحال‌حاضر ۳۰ ثانیه، اما ممکن است تغییر کند) حفظ می‌کنند، به‌طوری‌که درخواست‌های دارای همبسته یکسان که نزدیک به هم دریافت می‌شوند، به‌عنوان یک بازدید صفحه درنظر گرفته خواهند شد. به‌طور پیش‌فرض، برای هر بازآوری یک همبسته‌ساز جدید تولید می‌شود.

    توجه: این گزینه تأثیری بر بازدید صفحه طولانی‌مدت GPT ندارد، که به‌طور خودکار آگهی‌های فعلی صفحه را منعکس می‌کند و زمان انقضا ندارد.

registerRequestHook

registerRequestHook(hook: RequestHook, hookId: string): (() => void)
Experimental قلابی را ثبت می‌کند تا به‌طور موازی با قلاب‌های ثبت‌شده دیگر قبل‌از هر درخواست آگهی در صفحه در یک مهلت سراسری اجرا شود.
مثال

JavaScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

TypeScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();
پارامترها
hook: RequestHookتابعی که شیء حاوی فهرست جایگاه‌های درخواستی را می‌گیرد و وعده‌ای را برمی‌گرداند که پس‌از تکمیل همه کنش‌های ناهمگام حل‌وفصل می‌شود.
hookId: stringشناسه‌ای برای برچسب‌گذاری قلاب برای تشخیص بهتر.
بازگشتی‌ها
(() => void)تابعی برای لغو ثبت‌نام قلاب.

تنظیم

set(key: string, value: string): PubAdsService
مقادیری را برای مشخصه‌های AdSense تنظیم می‌کند که برای همه جایگاه‌های آگهی تحت سرویس «آگهی‌های ناشر» اعمال می‌شود.

فراخوانی این تابع بیش‌از یک بار برای یک کلید، مقادیر قبلی تنظیم‌شده برای آن کلید را لغو می‌کند. همه مقادیر باید قبل‌از فراخوانی display یا refresh تنظیم شوند.
مثال

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});
همچنین مراجعه کنید به
پارامترها
key: stringنام مشخصه.
value: stringمقدار مشخصه.
بازگشتی‌ها
PubAdsServiceشیء سرویسی که روش روی آن فراخوانی شده است.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService
مستثنی کردن دسته آگهی در سطح صفحه را برای نام برچسب داده‌شده تنظیم می‌کند.
مثال

JavaScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

TypeScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});
همچنین مراجعه کنید به
پارامترها
categoryExclusion: stringبرچسب مستثنی کردن دسته آگهی برای افزودن.
بازگشتی‌ها
PubAdsServiceشیء سرویسی که روش روی آن فراخوانی شده است.

setCentering

setCentering(centerAds: boolean): void
تراز کردن افقی آگهی‌ها را فعال و غیرفعال می‌کند. «مرکز قرار دادن» به‌طور پیش‌فرض غیرفعال است. In legacy gpt_mobile.js, centering is enabled by default.

This method should be invoked before calling display or refresh because only ads that are requested after calling this method will be centered.
مثال

JavaScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

TypeScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});
پارامترها
centerAds: booleantrue برای وسط‌چین کردن آگهی‌ها، false برای چپ‌چین کردن آن‌ها.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
پیکربندی می‌کند که آیا همه آگهی‌های صفحه باید بااستفاده از محفظه SafeFrame به‌اجبار ارائه شوند یا نه.

لطفاً هنگام استفاده از این میانای برنامه‌سازی کاربردی، موارد زیر را درنظر داشته باشید:
  • این تنظیم فقط برای درخواست‌های آگهی بعدی که برای جایگاه‌های مربوطه انجام می‌شود اعمال خواهد شد.
  • تنظیم سطح جایگاه، درصورت مشخص شدن، همیشه تنظیم سطح صفحه را لغو می‌کند.
  • اگر روی true (در سطح جایگاه یا سطح صفحه) تنظیم شود، آگهی همیشه بااستفاده از محفظه SafeFrame، مستقل از انتخاب انجام‌شده در میانای کاربری Google Ad Manager، ارائه خواهد شد.
  • بااین‌حال، اگر روی false تنظیم شود یا نامشخص باقی بماند، آگهی بااستفاده از محفظه SafeFrame بسته به نوع طرح‌آگهی و انتخاب انجام‌شده در میانای کاربری Google Ad Manager ارائه خواهد شد.
  • این میانای برنامه‌سازی کاربردی باید با احتیاط استفاده شود زیرا می‌تواند بر رفتار طرح‌آگهی‌هایی که تلاش می‌کنند از iFrame خود خارج شوند یا به پرداز زدن مستقیم آن‌ها در صفحه ناشر متکی هستند تأثیر بگذارد.
مثال

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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");

TypeScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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: booleantrue برای اجبار همه آگهی‌های صفحه به ارائه در SafeFrames و false برای تغییر تنظیم قبلی به نادرست. تنظیم این مورد روی false وقتی قبلاً مشخص نشده باشد، چیزی را تغییر نمی‌دهد.
بازگشتی‌ها
PubAdsServiceشیء سرویسی که روش روی آن فراخوانی شده است.

setLocation

setLocation(address: string): PubAdsService
اطلاعات مکان را از وب‌سایت‌ها ارسال می‌کند تا بتوانید هدف‌یابی جغرافیایی سطرهای هدف را به مکان‌های خاصی انجام دهید.
مثال

JavaScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

TypeScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});
پارامترها
address: stringنشانی اختیاری.
بازگشتی‌ها
PubAdsServiceشیء سرویسی که روش روی آن فراخوانی شده است.

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
امکان پیکربندی همه تنظیمات حریم خصوصی را از یک میانای برنامه‌سازی کاربردی بااستفاده از شیء پیکربندی فراهم می‌کند.
مثال

JavaScript

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,
});

TypeScript

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
مقدار شناسه ارائه‌شده توسط ناشر را تنظیم می‌کند.
مثال

JavaScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
همچنین مراجعه کنید به
پارامترها
ppid: stringشناسه الفباعددی ارائه‌شده توسط ناشر. باید بین ۲۲ تا ۱۵۰ نویسه داشته باشد.
بازگشتی‌ها
PubAdsServiceشیء سرویسی که روش روی آن فراخوانی شده است.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
اولویت‌های سطح صفحه را برای پیکربندی SafeFrame تنظیم می‌کند. هر کلید ناشناخته‌ای در شیء پیکربندی نادیده گرفته خواهد شد. اگر مقدار نامعتبری برای کلید شناسایی‌شده ارسال شود، کل پیکربندی نادیده گرفته خواهد شد.

این اولویت‌های سطح صفحه با اولویت‌های سطح جایگاه لغو خواهند شد، اگر مشخص شده باشند.
مثال

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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");

TypeScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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
پارامترهای هدف‌یابی سفارشی را برای کلید داده‌شده تنظیم می‌کند که برای همه جایگاه‌های آگهی سرویس Publisher Ads اعمال می‌شود. فراخوانی چندباره این مورد برای یک کلید، مقادیر قدیمی را رونویسی می‌کند. این کلیدها در حساب Google Ad Manager شما تعریف شده‌اند.
مثال

JavaScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    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 ندارد، که به‌طور خودکار آگهی‌های موجود در صفحه را منعکس می‌کند و زمان انقضا ندارد.
مثال

JavaScript

// 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.

TypeScript

// 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.RequestHook

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

googletag.ResponseInformation

شیء نشان‌دهنده یک پاسخ آگهی.
مشخصات
advertiserId
شناسه آگهی‌دهنده.
campaignId
شناسه پویش.
creativeId
شناسه طرح‌آگهی.
creativeTemplateId
شناسه الگوی آگهی.
lineItemId
شناسه مورد سطری.
همچنین مراجعه کنید به

مشخصات

advertiserId

advertiserId: number
شناسه آگهی‌دهنده.

campaignId

campaignId: number
شناسه پویش.

creativeId

creativeId: number
شناسه طرح‌آگهی.

creativeTemplateId

creativeTemplateId: number
شناسه الگوی آگهی.

lineItemId

lineItemId: number
شناسه مورد سطری.

googletag.RewardedPayload

شیء نشان‌دهنده پاداش مرتبط با آگهی پاداش‌دار
مشخصات
amount
تعداد موارد موجود در پاداش.
type
نوع موردی که در پاداش گنجانده شده است (برای مثال، «سکه»).
همچنین مراجعه کنید به

مشخصات

مبلغ

amount: number
تعداد موارد موجود در پاداش.

نوع

type: string
نوع موردی که در پاداش گنجانده شده است (برای مثال، «سکه»).

googletag.Service

کلاس سرویس پایه که حاوی روش‌های مشترک برای همه سرویس‌ها است.
روش‌ها
addEventListener
شنونده‌ای را ثبت می‌کند که به شما امکان می‌دهد وقتی رویداد GPT خاصی در صفحه اتفاق می‌افتد، تابع جاوا اسکریپت را راه‌اندازی و فراخوانی کنید.
getSlots
فهرست وقت‌های مرتبط با این سرویس را دریافت کنید.
removeEventListener
شنونده‌ای را که قبلاً ثبت شده است برمی‌دارد.

روش‌ها

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
شنونده‌ای را ثبت می‌کند که به شما امکان می‌دهد وقتی رویداد GPT خاصی در صفحه اتفاق می‌افتد، تابع جاوا اسکریپت را راه‌اندازی و فراخوانی کنید. رویدادهای زیر پشتیبانی می‌شوند: شیئی از نوع رویداد مناسب هنگام فراخوانی به شنونده ارسال می‌شود.
مثال

JavaScript

// 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.
  }
});

TypeScript

// 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

getSlots(): Slot[]
فهرست وقت‌های مرتبط با این سرویس را دریافت کنید.
بازگشتی‌ها
Slot[]جایگاه‌ها به‌ترتیبی که به سرویس اضافه شده‌اند.

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
شنونده‌ای را که قبلاً ثبت شده است برمی‌دارد.
مثال

JavaScript

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();
});

TypeScript

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
نگاشتی را از آرایه تک‌اندازه‌ای (که نمایانگر نمای هدف است) به آرایه تک‌اندازه‌ای یا چنداندازه‌ای که نمایانگر جایگاه است اضافه می‌کند.
build
مشخصات نقشه اندازه را از نگاشت‌های اضافه‌شده به این سازنده می‌سازد.
همچنین مراجعه کنید به

روش‌ها

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
نگاشتی را از آرایه تک‌اندازه (نشان‌دهنده نمای هدف) به آرایه تک‌اندازه یا چنداندازه نشان‌دهنده جایگاه آگهی اضافه می‌کند.
مثال

JavaScript

// 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 &lt; 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]

TypeScript

// 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 &lt; 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(): SizeMappingArray
Builds a size map specification from the mappings added to this builder.

If any invalid mappings have been supplied, this method will return null. درغیراین‌صورت، مشخصاتی را در قالب صحیح برمی‌گرداند تا به Slot.defineSizeMapping ارسال شود.

توجه: رفتار سازنده پس‌از فراخوانی این روش تعریف نشده است.
بازگشتی‌ها
SizeMappingArrayنتیجه‌ای که این سازنده ساخته است. اگر نگاشت‌های اندازه نامعتبر ارائه شده باشد، می‌تواند تهی باشد.

googletag.Slot

جایگاه شیئی است که یک جایگاه آگهی را در صفحه نشان می‌دهد.
روش‌ها
addService
سرویسی به این جایگاه اضافه می‌کند.
clearCategoryExclusions
منسوخ‌شده. همه برچسب‌های استثنای دسته آگهی سطح جایگاه را برای این جایگاه پاک می‌کند.
clearTargeting
منسوخ‌شده. پارامترهای هدف‌یابی سطح جایگاه سفارشی خاص یا همه آن‌ها را برای این جایگاه پاک می‌کند.
defineSizeMapping
آرایه‌ای از نگاشت‌ها را از حداقل اندازه ناحیه نمایش به اندازه جایگاه برای این جایگاه تنظیم می‌کند.
get
منسوخ‌شده. مقدار مشخصه AdSense مرتبط با کلید ارائه‌شده برای این جایگاه را برمی‌گرداند.
getAdUnitPath
مسیر کامل واحد آگهی را با کد شبکه و مسیر واحد آگهی برمی‌گرداند.
getAttributeKeys
منسوخ‌شده. فهرست کلیدهای مشخصه تنظیم‌شده در این جایگاه را برمی‌گرداند.
getCategoryExclusions
منسوخ‌شده. برچسب‌های استثنای دسته آگهی را برای این جایگاه برمی‌گرداند.
getConfig
یک کپی ثابت از گزینه‌های پیکربندی عمومی برای جایگاه تنظیم‌شده توسط setConfig دریافت می‌کند.
getResponseInformation
اطلاعات پاسخ آگهی را برمی‌گرداند.
getSlotElementId
شناسه جایگاه div را که هنگام تعریف جایگاه ارائه شده است برمی‌گرداند.
getTargeting
منسوخ‌شده. پارامتر هدف‌یابی سفارشی خاصی را که در این جایگاه تنظیم شده است برمی‌گرداند.
getTargetingKeys
منسوخ‌شده. فهرست همه کلیدهای هدف‌یابی سفارشی تنظیم‌شده در این جایگاه را برمی‌گرداند.
set
منسوخ‌شده. مقداری را برای مشخصه AdSense در این جایگاه آگهی تنظیم می‌کند.
setCategoryExclusion
منسوخ‌شده. برچسب استثنای دسته آگهی در سطح جایگاه را روی این جایگاه تنظیم می‌کند.
setClickUrl
منسوخ‌شده. نشانی وب کلیک را تنظیم می‌کند که کاربران پس‌از کلیک کردن روی آگهی به آن هدایت می‌شوند.
setCollapseEmptyDiv
منسوخ‌شده. تنظیم می‌کند که آیا جایگاه div باید وقتی آگهی‌ای در جایگاه وجود ندارد پنهان شود یا نه.
setConfig
گزینه‌های پیکربندی کلی را برای این جایگاه تنظیم می‌کند.
setForceSafeFrame
منسوخ‌شده. پیکربندی می‌کند که آیا آگهی‌های این جایگاه باید بااستفاده از محفظه SafeFrame پردازش شوند یا نه.
setSafeFrameConfig
منسوخ‌شده. اولویت‌های سطح جایگاه را برای پیکربندی SafeFrame تنظیم می‌کند.
setTargeting
منسوخ‌شده. پارامتر هدف‌یابی سفارشی برای این جایگاه تنظیم می‌کند.
updateTargetingFromMap
منسوخ‌شده. پارامترهای هدف‌یابی سفارشی را برای این جایگاه از نقشه کلید:مقدار در شیء JSON تنظیم می‌کند.

روش‌ها

addService

addService(service: Service): Slot
سرویسی به این جایگاه اضافه می‌کند.
مثال

JavaScript

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
همچنین مراجعه کنید به
پارامترها
service: Serviceسرویسی که باید اضافه شود.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

clearCategoryExclusions

clearCategoryExclusions(): Slot
همه برچسب‌های مستثنا کردن دسته آگهی در سطح جایگاه را برای این جایگاه پاک می‌کند.
مثال

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

clearTargeting

clearTargeting(key?: string): Slot
پارامترهای هدف‌یابی سطح جایگاه سفارشی خاص یا همه آن‌ها را برای این جایگاه پاک می‌کند.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.
همچنین مراجعه کنید به
پارامترها
Optional key: stringکلید پارامتر هدف‌یابی. کلید اختیاری است؛ اگر مشخص نشده باشد، همه پارامترهای هدف‌یابی پاک خواهند شد.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot
آرایه‌ای از نگاشت‌ها را از حداقل اندازه نمای هدف به اندازه جایگاه برای این جایگاه تنظیم می‌کند.
مثال

JavaScript

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);

TypeScript

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 برای ایجاد آن استفاده کنید. هر نگاشت اندازه آرایه‌ای از دو عنصر است: SingleSizeArray و GeneralSize.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

دریافت

get(key: string): string
مقدار مشخصه AdSense مرتبط با کلید ارائه‌شده برای این جایگاه را برمی‌گرداند. برای دیدن مشخصه‌های سطح سرویس که این جایگاه به ارث برده است، از PubAdsService.get استفاده کنید.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.
همچنین مراجعه کنید به
پارامترها
key: stringنام مشخصه‌ای که باید جستجو شود.
بازگشتی‌ها
stringمقدار فعلی برای کلید مشخصه، یا null اگر کلید وجود نداشته باشد.

getAdUnitPath

getAdUnitPath(): string
مسیر کامل واحد آگهی را با کد شبکه و مسیر واحد آگهی برمی‌گرداند.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.
بازگشتی‌ها
stringمسیر واحد آگهی.

getAttributeKeys

getAttributeKeys(): string[]
فهرست کلیدهای مشخصه تنظیم‌شده در این جایگاه را برمی‌گرداند. برای دیدن کلیدهای مشخصه‌های سطح سرویس که این جایگاه به ارث برده است، از PubAdsService.getAttributeKeys استفاده کنید.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].
بازگشتی‌ها
string[]آرایه کلیدهای مشخصه. ترتیب تعریف نشده است.

getCategoryExclusions

getCategoryExclusions(): string[]
برچسب‌های مستثنی کردن دسته آگهی را برای این جایگاه برمی‌گرداند.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].
بازگشتی‌ها
string[]برچسب‌های منع نمایش دسته آگهی برای این جایگاه، یا آرایه خالی اگر هیچ‌کدام تنظیم نشده باشد.

getConfig

getConfig(keys: string | string[]): Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>
یک کپی ثابت از گزینه‌های پیکربندی عمومی برای جایگاه تنظیم‌شده توسط setConfig دریافت می‌کند.

همه ویژگی‌های setConfig() توسط این روش پشتیبانی نمی‌شوند. دارایی‌های پشتیبانی‌شده:
مثال

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
پارامترها
keys: string | string[]کلیدهای گزینه‌های پیکربندی برای دریافت.
بازگشتی‌ها
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>نسخه منجمدشده‌ای از گزینه‌های پیکربندی برای جایگاه.

getResponseInformation

getResponseInformation(): ResponseInformation
اطلاعات پاسخ آگهی را برمی‌گرداند. این مورد براساس آخرین پاسخ آگهی برای جایگاه است. اگر این مورد زمانی فراخوانی شود که جایگاه آگهی ندارد، null برگردانده خواهد شد.
بازگشتی‌ها
ResponseInformationجدیدترین اطلاعات پاسخ آگهی، یا null اگر جایگاه آگهی نداشته باشد.

getSlotElementId

getSlotElementId(): string
شناسه جایگاه div را که هنگام تعریف جایگاه ارائه شده است برمی‌گرداند.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.
بازگشتی‌ها
stringشناسه فضای div.

getTargeting

getTargeting(key: string): string[]
پارامتر هدف‌یابی سفارشی خاصی را که در این جایگاه تنظیم شده است برمی‌گرداند. پارامترهای هدف‌یابی سطح سرویس گنجانده نشده است.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).
پارامترها
key: stringکلید هدف‌یابی برای جستجو.
بازگشتی‌ها
string[]مقادیر مرتبط با این کلید، یا آرایه خالی اگر چنین کلیدی وجود نداشته باشد.

getTargetingKeys

getTargetingKeys(): string[]
فهرست همه کلیدهای هدف‌یابی سفارشی تنظیم‌شده در این جایگاه را برمی‌گرداند. کلیدهای هدف‌یابی سطح سرویس گنجانده نشده است.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].
بازگشتی‌ها
string[]آرایه کلیدهای هدف‌یابی. ترتیب تعریف نشده است.

تنظیم

set(key: string, value: string): Slot
مقداری را برای مشخصه AdSense در این جایگاه آگهی تنظیم می‌کند. این کار هر مقداری را که در سطح سرویس برای این کلید تنظیم شده است لغو می‌کند.

فراخوانی این روش بیش‌از یک بار برای یک کلید، مقادیر تنظیم‌شده قبلی برای آن کلید را لغو می‌کند. همه مقادیر باید قبل‌از فراخوانی display یا refresh تنظیم شوند.
مثال

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());
همچنین مراجعه کنید به
پارامترها
key: stringنام مشخصه.
value: stringمقدار مشخصه.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot
برچسب مستثنا کردن دسته آگهی در سطح جایگاه را در این جایگاه تنظیم می‌کند.
مثال

JavaScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());
همچنین مراجعه کنید به
پارامترها
categoryExclusion: stringبرچسب مستثنی کردن دسته آگهی برای افزودن.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

setClickUrl

setClickUrl(value: string): Slot
نشانی وب کلیک را تنظیم می‌کند که کاربران پس‌از کلیک کردن روی آگهی به آن هدایت می‌شوند.

سرورهای Google Ad Manager حتی اگر نشانی وب کلیک جایگزین شود، همچنان کلیک را ثبت می‌کنند. هر نشانی وب صفحه مقصدی که با طرح آگهی ارائه‌شده مرتبط باشد به مقدار ارائه‌شده اضافه می‌شود. تماس‌های بعدی مقدار را رونویسی می‌کنند. این فقط برای درخواست‌های غیر SRA کار می‌کند.
مثال

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());
پارامترها
value: stringنشانی وب کلیک برای تنظیم.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
تنظیم می‌کند که آیا جایگاه div باید وقتی آگهی‌ای در جایگاه وجود ندارد پنهان شود یا نه. این تنظیمات سطح سرویس را لغو می‌کند.
مثال

JavaScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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.

TypeScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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اینکه اگر آگهی‌ای برگردانده نشد، جایگاه جمع شود یا نه.
Optional collapseBeforeAdFetch: booleanآیا جایگاه حتی قبل‌از واکشی آگهی جمع شود یا نه. اگر جمع کردن true نباشد، نادیده گرفته می‌شود.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot
گزینه‌های پیکربندی کلی را برای این جایگاه تنظیم می‌کند.
پارامترها
slotConfig: SlotSettingsConfigشیء پیکربندی.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
پیکربندی می‌کند که آیا آگهی‌های این جایگاه باید بااستفاده از محفظه SafeFrame به‌اجبار ارائه شوند یا نه.

لطفاً هنگام استفاده از این API، موارد زیر را درنظر داشته باشید:
  • این تنظیم فقط برای درخواست‌های آگهی بعدی که برای جایگاه‌های مربوطه انجام می‌شود اعمال خواهد شد.
  • تنظیم سطح جایگاه، درصورت مشخص شدن، همیشه تنظیم سطح صفحه را لغو می‌کند.
  • اگر روی true (در سطح جایگاه یا سطح صفحه) تنظیم شود، آگهی همیشه بااستفاده از محفظه SafeFrame، مستقل از انتخاب انجام‌شده در میانای کاربری Google Ad Manager، ارائه خواهد شد.
  • بااین‌حال، اگر روی false تنظیم شود یا نامشخص باقی بماند، آگهی بااستفاده از محفظه SafeFrame بسته به نوع طرح‌آگهی و انتخاب انجام‌شده در میانای کاربری Google Ad Manager ارائه خواهد شد.
  • این میانای برنامه‌سازی کاربردی باید با احتیاط استفاده شود زیرا می‌تواند بر رفتار طرح‌آگهی‌هایی که تلاش می‌کنند از iFrame خود خارج شوند یا به پرداز زدن مستقیم آن‌ها در صفحه ناشر متکی هستند تأثیر بگذارد.
مثال

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());
همچنین مراجعه کنید به
پارامترها
forceSafeFrame: booleantrue برای اجبار همه آگهی‌ها در این جایگاه برای ارائه در SafeFrames و false برای انصراف از تنظیم سطح صفحه (درصورت وجود). تنظیم این مورد روی false وقتی در سطح صفحه مشخص نشده باشد چیزی را تغییر نخواهد داد.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot
اولویت‌های سطح جایگاه را برای پیکربندی SafeFrame تنظیم می‌کند. هر کلید ناشناخته‌ای در شیء پیکربندی نادیده گرفته خواهد شد. اگر مقدار نامعتبری برای کلید شناخته‌شده‌ای ارسال شود، کل پیکربندی نادیده گرفته خواهد شد.

این اولویت‌های سطح جایگاه، درصورت مشخص شدن، اولویت‌های سطح صفحه را لغو خواهند کرد.
مثال

JavaScript

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");

TypeScript

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: SafeFrameConfigشیء پیکربندی.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

setTargeting

setTargeting(key: string, value: string | string[]): Slot
پارامتر هدف‌یابی سفارشی برای این جایگاه تنظیم می‌کند. فراخوانی این روش به‌دفعات برای یک کلید، مقادیر قدیمی را بازنویسی می‌کند. مقادیری که اینجا تنظیم می‌شود روی پارامترهای هدف‌یابی تنظیم‌شده در سطح سرویس رونویسی می‌شود. این کلیدها در حساب Google Ad Manager شما تعریف شده‌اند.
مثال

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});
همچنین مراجعه کنید به
پارامترها
key: stringکلید پارامتر هدف‌یابی.
value: string | string[]مقدار پارامتر هدف‌یابی یا آرایه مقادیر.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot
پارامترهای هدف‌یابی سفارشی را برای این جایگاه، از نگاشت کلید:مقدار در شیء JSON تنظیم می‌کند. این کار مانند فراخوانی Slot.setTargeting برای همه مقادیر کلیدی شیء است. این کلیدها در حساب Google Ad Manager شما تعریف شده‌اند.

نکته‌ها:
  • درصورت بازنویسی، فقط آخرین مقدار حفظ خواهد شد.
  • اگر مقدار آرایه باشد، هر مقدار قبلی رونویسی می‌شود و ادغام نمی‌شود.
  • مقادیری که اینجا تنظیم می‌شود روی پارامترهای هدف‌یابی تنظیم‌شده در سطح سرویس رونویسی می‌شود.
مثال

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});
پارامترها
map: {
  [adUnitPath: string]: string | string[];
}		نقشه کلید:مقدار پارامتر هدف‌یابی.
بازگشتی‌ها
Slotشیء جایگاهی که روش روی آن فراخوانی شده است.

googletag.config

میانای پیکربندی اصلی برای تنظیمات سطح صفحه.
میانه‌ها
AdExpansionConfig
تنظیمات کنترل گسترش آگهی.
AdSenseAttributesConfig
تنظیماتی برای کنترل رفتار آگهی‌های AdSense.
AutoRefreshConfig
تنظیمات پیکربندی بازآوری خودکار.
ContinueButtonConfig
تنظیمات برای پیکربندی رفتار دکمه ادامه.
InterstitialConfig
شیئی که رفتار یک جایگاه آگهی تمام‌صفحه را تعریف می‌کند.
LazyLoadConfig
تنظیمات کنترل استفاده از بارکردن کُند در GPT.
PageSettingsConfig
میانای پیکربندی اصلی برای تنظیمات سطح صفحه.
PrivacyTreatmentsConfig
تنظیمات کنترل کردن نحوه برخورد ناشر با حریم خصوصی.
PublisherProvidedSignalsConfig
شیء پیکربندی نشان‌های ناشرداده (PPS).
SafeFrameConfig
تنظیمات کنترل SafeFrame در GPT.
SlotSettingsConfig
میانای پیکربندی اصلی برای تنظیمات سطح جایگاه.
TaxonomyData
شیء حاوی مقادیر برای یک طبقه‌بندی.
VideoAdsConfig
تنظیمات برای پیکربندی تنظیمات مربوط به آگهی ویدیویی.
نام‌های مستعار نوع
CollapseDivBehavior
مقادیر پشتیبانی‌شده برای کنترل رفتار جمع شدن جایگاه‌های آگهی.
InterstitialTrigger
راه‌اندازهای آگهی بینابینی پشتیبانی‌شده.
PrivacyTreatment
رفتارهای حریم خصوصی ناشر پشتیبانی‌شده.
Taxonomy
طبقه‌بندی‌های پشتیبانی‌شده برای نشان‌های ناشرداده (PPS).

نام‌های مستعار نوع

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"
مقادیر پشتیبانی‌شده برای کنترل رفتار جمع شدن جایگاه‌های آگهی.
همچنین مراجعه کنید به

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"
راه‌اندازهای آگهی بینابینی پشتیبانی‌شده.

توجه: از ۱۵ ژوئن ۲۰۲۶، راه‌انداز backward دیگر پشتیبانی نخواهد شد و فعال کردن آن تأثیری نخواهد داشت. برای اطلاعات بیشتر، یادداشت‌های انتشار GPT را ببینید.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
رفتارهای حریم خصوصی ناشر پشتیبانی‌شده.

طبقه‌بندی

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
طبقه‌بندی‌های پشتیبانی‌شده برای نشان‌های ناشرداده (PPS).
همچنین مراجعه کنید به

googletag.config.AdExpansionConfig

تنظیمات کنترل گسترش آگهی.
مشخصات
enabled?
آیا گسترش آگهی فعال یا غیرفعال است.
مثال

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

مشخصات

‫Optional فعال شد

enabled?: boolean
اینکه گسترش آگهی فعال یا غیرفعال باشد.

تنظیم این مقدار، مقدار پیش‌فرض پیکربندی‌شده در Google Ad Manager را لغو می‌کند.
همچنین مراجعه کنید به

googletag.config.AdSenseAttributesConfig

تنظیماتی برای کنترل رفتار آگهی‌های AdSense.

از این مشخصه‌ها می‌توان برای لغو تنظیمات سمت سرور براساس هر درخواست استفاده کرد.
مشخصات
adsense_ad_format?
قالب آگهی AdSense.
adsense_channel_ids?
شناسه‌های کانال AdSense.
adsense_test_mode?
اینکه حالت آزمایشی فعال است یا نه.
document_language?
زبان صفحه‌ای که آگهی‌ها در آن نمایش داده می‌شود.
page_url?
نشانی وب صفحه‌ای که آگهی‌ها در آن نمایش داده می‌شوند.
همچنین مراجعه کنید به

مشخصات

Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"
قالب آگهی AdSense.

Optional adsense_channel_ids

adsense_channel_ids?: string
شناسه‌های کانال AdSense.

مقادیر مجاز شناسه‌های کانال هستند که با «+» از هم جدا شده‌اند.

مثال: 271828183+314159265
همچنین مراجعه کنید به

Optional adsense_test_mode

adsense_test_mode?: "on"
فعال بودن یا نبودن حالت آزمایشی.

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

Optional document_language

document_language?: string
زبان صفحه‌ای که آگهی‌ها در آن نمایش داده می‌شود.

مقادیر مجاز کدهای زبان ISO 639-1 معتبر هستند.

مثال: en
همچنین مراجعه کنید به

Optional page_url

page_url?: string
نشانی وب صفحه‌ای که آگهی‌ها در آن نمایش داده می‌شود.

مقادیر مجاز نشانی‌های وب معتبر هستند.

مثال: http://www.example.com

googletag.config.AutoRefreshConfig

تنظیمات پیکربندی بازآوری خودکار.
مشخصات
backForwardCache?
آیا GPT وقتی صفحه از حافظه نهان ناوبری بین صفحات بازیابی می‌شود، جایگاه آگهی فعال را به‌طور خودکار بازآوری می‌کند یا نه.
heavyAds?
اینکه آیا GPT درصورت فعال شدن «مداخله آگهی سنگین» Chrome در iframe آگهی جایگاه، جایگاه آگهی را به‌طور خودکار بازآوری می‌کند یا نه.

مشخصات

Optional backForwardCache

backForwardCache?: boolean
آیا GPT وقتی صفحه از حافظه نهان ناوبری بین صفحات بازیابی می‌شود، جایگاه آگهی فعال را به‌طور خودکار بازآوری می‌کند یا نه. پیش‌فرض‌ها به true.
مثال

JavaScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });
همچنین مراجعه کنید به

Optional heavyAds

heavyAds?: boolean
اینکه آیا GPT درصورت فعال شدن «مداخله آگهی سنگین» Chrome در iframe آگهی جایگاه، جایگاه آگهی را به‌طور خودکار بازآوری می‌کند یا نه. پیش‌فرض‌ها به true.
مثال

JavaScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });
همچنین مراجعه کنید به

googletag.config.ContinueButtonConfig

تنظیمات برای پیکربندی رفتار دکمه ادامه.
مشخصات
backgroundColor?
رنگ پس‌زمینه دکمه.
font?
خانواده قلم نوشتار دکمه.
fontColor?
رنگ نوشتار دکمه.
freqCapIntervalMinutes?
فاصله حدگذاری بسامد به دقیقه.
targetId?
شناسه عنصر HTML که دکمه ادامه باید روی آن ارائه/راه‌اندازی شود.
همچنین مراجعه کنید به

مشخصات

Optional backgroundColor

backgroundColor?: string
رنگ پس‌زمینه دکمه.

مثال: 'blue'، '#94B1FF'

Optional قلم

font?: string
خانواده قلم نوشتار دکمه.

مثال: 'Arial'

Optional fontColor

fontColor?: string
رنگ نوشتار دکمه.

مثال: 'white'، '#B73B87'

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number
فاصله حدگذاری بسامد برحسب دقیقه.

باید عدد صحیحی بزرگ‌تر یا مساوی ۱ باشد.

Optional targetId

targetId?: string
شناسه عنصر HTML که دکمه ادامه باید روی آن ارائه/راه‌اندازی شود.

googletag.config.InterstitialConfig

شیئی که رفتار یک جایگاه آگهی تمام‌صفحه را تعریف می‌کند.
مشخصات
requireStorageAccess?
آیا برای نمایش این آگهی بینابینی، رضایت ذخیره‌سازی محلی لازم است.
triggers?
پیکربندی راه‌انداز بینابینی برای این آگهی بینابینی.

مشخصات

Optional requireStorageAccess

requireStorageAccess?: boolean
آیا برای نمایش این آگهی بینابینی به رضایت ذخیره‌سازی محلی نیاز است.

GPT از ذخیره‌سازی محلی برای اعمال حدگذاری بسامد برای آگهی‌های بینابینی استفاده می‌کند. بااین‌حال، کاربرانی که رضایت خود را برای فضای ذخیره‌سازی محلی ارائه نکرده‌اند همچنان واجدشرایط دریافت آگهی‌های بینابینی هستند. تنظیم این ویژگی روی true باعث انصراف از رفتار پیش‌فرض می‌شود و تضمین می‌کند که آگهی‌های بینابینی فقط به کاربرانی نشان داده می‌شود که رضایت خود را برای ذخیره‌سازی محلی اعلام کرده‌اند.
مثال

JavaScript

// 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
  },
});

TypeScript

// 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?: Partial<Record<InterstitialTrigger, boolean>>
پیکربندی راه‌انداز بینابینی برای این آگهی بینابینی.

تنظیم مقدار راه‌انداز بینابینی روی true آن را فعال می‌کند و روی false آن را غیرفعال می‌کند. این کار مقادیر پیش‌فرض پیکربندی‌شده در Google Ad Manager را لغو می‌کند.
مثال

JavaScript

// 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,
    },
  },
});

TypeScript

// 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.LazyLoadConfig

تنظیمات کنترل استفاده از بارکردن کُند در GPT.
مشخصات
fetchMarginPercent?
حداقل فاصله‌ای که جایگاه باید از ناحیه نمایش فعلی داشته باشد تا آگهی درخواست کنیم، که به‌صورت درصدی از اندازه ناحیه نمایش بیان می‌شود.
mobileScaling?
ضریبی که برای حاشیه‌ها در دستگاه‌های همراه اعمال می‌شود.
renderMarginPercent?
حداقل فاصله‌ای که جایگاه باید از ناحیه نمایش فعلی داشته باشد تا آگهی را ارائه کنیم، که به‌صورت درصدی از اندازه ناحیه نمایش بیان می‌شود.
همچنین مراجعه کنید به

مشخصات

Optional fetchMarginPercent

fetchMarginPercent?: number
حداقل فاصله‌ای که جایگاه باید از ناحیه نمایش فعلی داشته باشد تا آگهی درخواست کنیم، که به‌صورت درصدی از اندازه ناحیه نمایش بیان می‌شود.

این تنظیم که همراه با renderMarginPercent استفاده می‌شود، امکان واکشی پیشاپیش آگهی را فراهم می‌کند، اما برای ارائه و بارگیری سایر منابع فرعی منتظر می‌ماند. بنابراین، این مقدار باید همیشه بزرگ‌تر یا مساوی renderMarginPercent باشد.

مقدار 0 یعنی «وقتی جایگاه وارد نمای هدف می‌شود»، 100 یعنی «وقتی آگهی ۱ نمای هدف فاصله دارد»، و غیره.

Optional mobileScaling

mobileScaling?: number
ضریبی که برای حاشیه‌ها در دستگاه‌های همراه اعمال می‌شود. این ضریب هم برای fetchMarginPercent و هم برای renderMarginPercent اعمال می‌شود.

این امکان را فراهم می‌کند که حاشیه‌های متفاوتی در تلفن همراه درمقایسه با رایانه وجود داشته باشد، جایی که اندازه‌های نمای و سرعت‌های پیمایش ممکن است متفاوت باشد. برای مثال، مقدار ۲٫۰ همه حاشیه‌ها را در دستگاه‌های همراه در ۲ ضرب می‌کند و حداقل فاصله‌ای را که جایگاه می‌تواند قبل‌از واکشی و پردازش از نمای هدف داشته باشد افزایش می‌دهد.

Optional renderMarginPercent

renderMarginPercent?: number
حداقل فاصله‌ای که جایگاه باید از ناحیه نمایش فعلی داشته باشد تا آگهی را ارائه کنیم، که به‌صورت درصدی از اندازه ناحیه نمایش بیان می‌شود.

این تنظیم که همراه با fetchMarginPercent استفاده می‌شود، امکان واکشی پیشاپیش آگهی را فراهم می‌کند، اما برای ارائه و بارگیری منابع فرعی دیگر منتظر می‌ماند. بنابراین، این مقدار باید همیشه کمتر یا مساوی fetchMarginPercent باشد.

مقدار 0 یعنی «وقتی جایگاه وارد ناحیه دید می‌شود»، 100 یعنی «وقتی آگهی ۱ ناحیه دید فاصله دارد»، و غیره.

googletag.config.PageSettingsConfig

میانای پیکربندی اصلی برای تنظیمات سطح صفحه.

امکان تنظیم چندین ویژگی را با یک فراخوانی میانای برنامه‌سازی کاربردی فراهم می‌کند.

همه ویژگی‌های فهرست‌شده در زیر نمونه هستند و ویژگی‌های واقعی را که از 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,
  });
مشخصات
adExpansion?
تنظیمات کنترل گسترش آگهی.
adsenseAttributes?
تنظیمات پیکربندی مشخصه‌های AdSense.
adYield?
منسوخ‌شده. 
autoRefresh?
تنظیمات پیکربندی رفتار بازآوری خودکار آگهی.
categoryExclusion?
تنظیمات پیکربندی استثناهای دسته آگهی.
centering?
تنظیمات برای کنترل کردن تراز افقی آگهی‌ها.
collapseDiv?
تنظیماتی برای کنترل رفتار جمع شدن جایگاه‌های آگهی.
disableInitialLoad?
تنظیم برای کنترل زمان درخواست آگهی‌ها.
lazyLoad?
تنظیمات کنترل استفاده از بارکردن کُند در GPT.
location?
تنظیم برای هدف‌یابی جغرافیایی عناصر خط به مکان‌های جغرافیایی.
pps?
تنظیمات کنترل نشان‌های ناشرداده (PPS).
privacyTreatments?
تنظیمات کنترل کردن نحوه برخورد ناشر با حریم خصوصی.
requestHookTimeoutMs?
تنظیماتی برای کنترل حداکثر زمانی که GPT برای تکمیل همه قلاب‌های درخواست ثبت‌شده قبل‌از ادامه درخواست آگهی منتظر می‌ماند.
safeFrame?
تنظیمات کنترل استفاده از SafeFrame در GPT.
singleRequest?
تنظیم برای فعال یا غیرفعال کردن «معماری درخواست تکی» (SRA).
targeting?
تنظیمات برای کنترل هدف‌یابی کلید-مقدار.
threadYield?
تنظیماتی برای کنترل اینکه آیا GPT باید رشته JS را هنگام درخواست و ارائه خلاقیت‌ها واگذار کند یا نه.
videoAds?
تنظیمات برای کنترل آگهی‌های ویدیویی.

مشخصات

Optional adExpansion

adExpansion?: AdExpansionConfig
تنظیمات کنترل گسترش آگهی.

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
تنظیمات پیکربندی مشخصه‌های AdSense.

مشخصه‌های AdSense پیکربندی‌شده ازطریق این تنظیمات برای همه جایگاه‌های آگهی در صفحه اعمال خواهد شد. این تنظیم ممکن است چندین‌بار برای تعریف مقادیر مشخصه متعدد یا بازنویسی مقادیر موجود فراخوانی شود.

تغییرات مشخصه AdSense فقط برای آگهی‌هایی اعمال می‌شود که پس‌از فراخوانی این روش درخواست شده‌اند. به همین دلیل، توصیه می‌شود این روش را قبل‌از هرگونه تماس با googletag.display یا PubAdsService.refresh فراخوانی کنید.
مثال

JavaScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Optional autoRefresh

autoRefresh?: AutoRefreshConfig
تنظیمات پیکربندی رفتار بازآوری خودکار آگهی.
مثال

JavaScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

Optional categoryExclusion

categoryExclusion?: string[]
تنظیمات پیکربندی استثناهای دسته آگهی.
مثال

JavaScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });
همچنین مراجعه کنید به

Optional مرکزیابی

centering?: boolean
تنظیمات برای کنترل کردن تراز افقی آگهی‌ها. مرکز قرار دادن به‌طور پیش‌فرض غیرفعال است.

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

JavaScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
تنظیمات برای کنترل رفتار جمع شدن جایگاه‌های آگهی.

جایگاه آگهی جمع‌شده هیچ فضایی را در صفحه اشغال نمی‌کند.

مقادیر پشتیبانی‌شده:
  • null (پیش‌فرض): جایگاه جمع نخواهد شد.
  • DISABLED: جایگاه آگهی، چه آگهی برگردانده شود چه نشود، جمع نخواهد شد.
  • BEFORE_FETCH: جایگاه در ابتدا به‌صورت جمع‌شده خواهد بود و وقتی آگهی برگردانده شود ازهم باز می‌شود.
  • ON_NO_FILL: جایگاه در ابتدا به‌صورت گسترده‌شده شروع می‌شود و اگر آگهی‌ای برگردانده نشود، جمع می‌شود.
مثال

JavaScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

TypeScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });
همچنین مراجعه کنید به

Optional disableInitialLoad

disableInitialLoad?: boolean
تنظیماتی برای کنترل زمان درخواست آگهی.

به‌طور پیش‌فرض، روش googletag.display هم جایگاه‌های آگهی را ثبت می‌کند و هم برای آن‌ها آگهی درخواست می‌کند. بااین‌حال، مواقعی وجود دارد که ممکن است ترجیح داده شود این کنش‌ها از هم جدا شوند تا زمان بار شدن محتوای آگهی دقیق‌تر کنترل شود.

با فعال کردن این تنظیم، وقتی روش display() فراخوانی می‌شود، آگهی‌ها برای جایگاه‌های ثبت‌شده درخواست نمی‌شوند. به‌جای آن، باید تماس جداگانه‌ای با PubAdsService.refresh برقرار شود تا درخواست آگهی آغاز شود.

این روش باید قبل‌از فراخوانی googletag.enableServices فراخوانی شود.
مثال

JavaScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });
همچنین مراجعه کنید به

Optional lazyLoad

lazyLoad?: LazyLoadConfig
تنظیمات کنترل استفاده از بار کردن کُند در GPT.

بار کردن کُند تکنیکی برای به‌تأخیر انداختن درخواست و بازپرداخت آگهی‌ها تا زمانی است که به نمای کاربر نزدیک شوند. برای مثال دقیق‌تر، نمونه بار کردن کُند را ببینید.

توجه: اگر singleRequest فعال باشد، واکشی کُند فقط زمانی کار می‌کند که همه جایگاه‌ها خارج از حاشیه واکشی باشند.

هرگونه تنظیمات بار کردن کُند که هنگام فراخوانی setConfig() مشخص نشده باشد، از مقدار پیش‌فرض تنظیم‌شده توسط Google استفاده خواهد کرد. این پیش‌فرض‌ها ممکن است درطول زمان تنظیم شوند. برای غیرفعال کردن تنظیم خاصی، مقدار را روی null تنظیم کنید.
مثال

JavaScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

TypeScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });
همچنین مراجعه کنید به

Optional مکان

location?: string
تنظیم برای هدف‌یابی جغرافیایی عناصر خط به مکان‌های جغرافیایی.
مثال

JavaScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

TypeScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });
همچنین مراجعه کنید به

Optional pps

تنظیمات کنترل نشان‌های ناشرداده (PPS).

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig
تنظیمات کنترل کردن نحوه برخورد ناشر با حریم خصوصی.

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"
تنظیماتی برای کنترل حداکثر زمانی که GPT قبل‌از ادامه درخواست آگهی منتظر می‌ماند تا همه قلاب‌های درخواست ثبت‌شده تکمیل شوند.

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

مقادیر پشتیبانی‌شده:
  • عدد مثبت برحسب میلی‌ثانیه: دوره انتظار سفارشی‌شده.
  • 'auto': GPT از زمان استراحت بهینه‌سازی‌شده Google استفاده می‌کند.
  • ‫null: غیرفعال کردن زمان‌های استراحت (GPT به‌طور نامحدود منتظر می‌ماند تا قلاب‌ها تکمیل شوند).
مثال

JavaScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

TypeScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

Optional safeFrame

safeFrame?: SafeFrameConfig
تنظیمات کنترل استفاده از SafeFrame در GPT.

مقادیر پیکربندی‌شده ازطریق این تنظیمات برای همه جایگاه‌های آگهی در صفحه اعمال خواهد شد. جایگاه‌های آگهی تکی ممکن است این مقادیر را ازطریق SlotSettingsConfig.safeFrame لغو کنند.
مثال

JavaScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

TypeScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

Optional singleRequest

singleRequest?: boolean
تنظیم برای فعال یا غیرفعال کردن «معماری درخواست تکی» (SRA).

وقتی SRA فعال باشد، همه جایگاه‌های آگهی تعریف‌شده قبل‌از فراخوانی googletag.display یا PubAdsService.refresh به‌صورت دسته‌ای در یک درخواست آگهی تکی قرار می‌گیرند. این کار مزایای عملکردی دارد، اما برای اطمینان از رعایت شدن موانع و استثناهای رقابتی نیز ضروری است.

وقتی «درخواست تکی آگهی» غیرفعال باشد، هر جایگاه آگهی به‌صورت جداگانه درخواست می‌شود. این رفتار پیش‌فرض GPT است.

این روش باید قبل‌از فراخوانی googletag.enableServices فراخوانی شود.
مثال

JavaScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });
همچنین مراجعه کنید به

Optional هدف‌یابی

targeting?: Record<string, string | string[]>
تنظیمات برای کنترل هدف‌یابی مقدار کلید.

هدف‌یابی پیکربندی‌شده ازطریق این تنظیمات برای همه جایگاه‌های آگهی در صفحه اعمال خواهد شد. این تنظیم ممکن است چندین بار فراخوانی شود تا چندین مقدار کلیدی هدف‌یابی را تعریف کند یا مقادیر موجود را بازنویسی کند. کلیدهای هدف‌یابی در حساب Google Ad Manager شما تعریف شده‌اند.
مثال

JavaScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

TypeScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });
همچنین مراجعه کنید به

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
تنظیم برای کنترل اینکه آیا GPT باید هنگام درخواست و ارائه آگهی‌های خلاقانه، رشته JS را واگذار کند یا نه.

GPT فقط برای مرورگرهایی واگذار می‌کند که از Scheduler.postTask یا Scheduler.yield API پشتیبانی می‌کنند.

مقادیر پشتیبانی‌شده:
  • null (پیش‌فرض): GPT رشته JS را برای جایگاه‌های خارج از نمای هدف واگذار می‌کند.
  • ‫ENABLED_ALL_SLOTS: GPT رشته JS را برای همه جایگاه‌ها، صرف‌نظر از اینکه جایگاه در نمای هدف باشد یا نه، واگذار می‌کند.
  • ‫DISABLED: GPT رشته JS را تولید نخواهد کرد.
مثال

JavaScript

// 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 });

TypeScript

// 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 });
همچنین مراجعه کنید به

Optional videoAds

videoAds?: VideoAdsConfig
تنظیمات کنترل آگهی‌های ویدیویی.
مثال

JavaScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

TypeScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});
همچنین مراجعه کنید به

googletag.config.PrivacyTreatmentsConfig

تنظیمات کنترل کردن نحوه برخورد ناشر با حریم خصوصی.
مشخصات
treatments
آرایه‌ای از اقدامات حریم خصوصی ناشر برای فعال کردن.

مشخصات

درمان‌ها

treatments: "disablePersonalization"[]
مجموعه‌ای از رفتارهای حریم خصوصی ناشر برای فعال کردن.
مثال

JavaScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

TypeScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

googletag.config.PublisherProvidedSignalsConfig

شیء پیکربندی نشان‌های ناشرداده (PPS).
مشخصات
taxonomies
شیء حاوی نگاشت‌های طبقه‌بندی یا تهی برای پاک کردن پیکربندی.
مثال

JavaScript

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'
    },
  },
});

TypeScript

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.SafeFrameConfig

تنظیمات کنترل SafeFrame در GPT.
مشخصات
allowOverlayExpansion?
اینکه آیا SafeFrame باید به محتوای آگهی اجازه دهد با هم‌پوشانی محتوای صفحه ازهم باز شود یا نه.
allowPushExpansion?
اینکه آیا SafeFrame باید به محتوای آگهی اجازه دهد با فشار دادن محتوای صفحه ازهم باز شود.
forceSafeFrame?
آیا آگهی(ها) باید بااستفاده از محفظه SafeFrame به‌اجبار ارائه شود یا نه.
sandbox?
اینکه SafeFrame باید از مشخصه جعبه امن HTML5 برای جلوگیری از پیمایش سطح بالا بدون تعامل کاربر استفاده کند یا نه.
useUniqueDomain?
منسوخ‌شده. اینکه SafeFrame باید از زیردامنه‌های تصادفی برای طرح‌آگهی‌های «رزرو» استفاده کند یا نه.
همچنین مراجعه کنید به

مشخصات

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean
اینکه آیا SafeFrame باید به محتوای آگهی اجازه دهد با هم‌پوشانی محتوای صفحه ازهم باز شود یا نه.

Optional allowPushExpansion

allowPushExpansion?: boolean
اینکه آیا SafeFrame باید به محتوای آگهی اجازه دهد با فشار دادن محتوای صفحه ازهم باز شود.

Optional forceSafeFrame

forceSafeFrame?: boolean
آیا آگهی(ها) باید بااستفاده از محفظه SafeFrame به‌اجبار ارائه شود یا نه.

Optional sandbox

sandbox?: boolean
اینکه SafeFrame باید از مشخصه جعبه امن HTML5 برای جلوگیری از پیمایش سطح بالا بدون تعامل کاربر استفاده کند یا نه. تنها مقدار معتبر true است (نمی‌تواند به false اجبار شود). توجه داشته باشید که مشخصه sandbox افزایه‌ها (مثلاً Flash) را غیرفعال می‌کند.

Optional useUniqueDomain

useUniqueDomain?: boolean
اینکه SafeFrame باید از زیردامنه‌های تصادفی برای طرح‌آگهی‌های «رزرو» استفاده کند یا نه. برای پاک کردن مقدار ذخیره‌شده، null را ارسال کنید.

توجه: این ویژگی به‌طور پیش‌فرض فعال است.
همچنین مراجعه کنید به

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,
  });
مشخصات
adExpansion?
تنظیمات پیکربندی گسترش آگهی.
adsenseAttributes?
تنظیمات پیکربندی مشخصه‌های AdSense.
categoryExclusion?
تنظیمات پیکربندی استثناهای دسته آگهی.
clickUrl?
تنظیمات پیکربندی نشانی وبی که کاربران پس‌از کلیک کردن روی آگهی به آن هدایت خواهند شد.
collapseDiv?
تنظیمات پیکربندی رفتار جمع شدن جایگاه آگهی.
continueButton?
تنظیمات پیکربندی رفتار دکمه ادامه برای آگهی‌های توقف محتوا.
interstitial?
تنظیماتی که رفتار جایگاه آگهی بینابینی را پیکربندی می‌کند.
safeFrame?
تنظیمات پیکربندی استفاده از SafeFrame در GPT.
targeting?
تنظیمات پیکربندی هدف‌یابی مقدار کلید.

مشخصات

Optional adExpansion

adExpansion?: AdExpansionConfig
تنظیمات پیکربندی گسترش آگهی.
همچنین مراجعه کنید به

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
تنظیمات پیکربندی مشخصه‌های AdSense.

مشخصه‌های AdSense پیکربندی‌شده ازطریق این تنظیمات فقط برای جایگاه آگهی اعمال می‌شود. این تنظیم ممکن است چندین‌بار برای تعریف مقادیر مشخصه متعدد یا بازنویسی مقادیر موجود فراخوانی شود.

تغییرات مشخصه AdSense فقط برای آگهی‌هایی اعمال می‌شود که پس‌از فراخوانی این روش درخواست شده‌اند. به همین دلیل، توصیه می‌شود این روش را قبل‌از هرگونه تماس با googletag.display یا PubAdsService.refresh فراخوانی کنید.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

Optional categoryExclusion

categoryExclusion?: string[]
تنظیمات پیکربندی استثناهای دسته آگهی.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });
همچنین مراجعه کنید به

Optional clickUrl

clickUrl?: string
تنظیم پیکربندی نشانی وبی که کاربران پس‌از کلیک کردن روی آگهی به آن هدایت می‌شوند.

سرورهای Google Ad Manager همچنان کلیک را ثبت می‌کنند، حتی اگر نشانی وب کلیک جایگزین شود. هر نشانی وب صفحه مقصدی که با طرح آگهی ارائه‌شده مرتبط باشد به مقدار ارائه‌شده اضافه می‌شود. تنظیم این مقدار بیش‌از یک بار، هر مقدار پیکربندی‌شده قبلی را رونویسی خواهد کرد. ارسال null مقدار را پاک می‌کند.

توجه: این تنظیم فقط برای درخواست‌های غیرSRA اعمال می‌شود.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
تنظیمات پیکربندی رفتار جمع شدن جایگاه آگهی.

جایگاه آگهی جمع‌شده هیچ فضایی را در صفحه اشغال نمی‌کند.

مقادیر پشتیبانی‌شده:
  • null (پیش‌فرض): جایگاه جمع نخواهد شد.
  • DISABLED: جایگاه آگهی، چه آگهی برگردانده شود چه نشود، جمع نخواهد شد.
  • BEFORE_FETCH: جایگاه در ابتدا به‌صورت جمع‌شده خواهد بود و وقتی آگهی برگردانده شود ازهم باز می‌شود.
  • ON_NO_FILL: جایگاه در ابتدا به‌صورت گسترده‌شده شروع می‌شود و اگر آگهی‌ای برگردانده نشود، جمع می‌شود.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});
همچنین مراجعه کنید به

Optional continueButton

continueButton?: ContinueButtonConfig
تنظیمات پیکربندی رفتار دکمه ادامه برای آگهی‌های توقف محتوا.

این تنظیمات امکان سفارشی‌سازی ظاهر و رفتار تعامل‌های خروج و ادامه خواندن مرتبط با قالب‌های توقف محتوا را فراهم می‌کند.

هرگونه تنظیمات دکمه ادامه که هنگام فراخوانی setConfig() مشخص نشده باشد، از مقدار پیش‌فرض تعیین‌شده توسط Google استفاده خواهد کرد.

برای غیرفعال کردن یا پاک کردن همه تنظیمات دکمه ادامه، null را ارسال کنید.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

Optional بینابینی

interstitial?: InterstitialConfig
تنظیماتی که رفتار جایگاه آگهی بینابینی را پیکربندی می‌کند.
همچنین مراجعه کنید به

Optional safeFrame

safeFrame?: SafeFrameConfig
تنظیمات پیکربندی استفاده از SafeFrame در GPT.

مقادیر پیکربندی‌شده ازطریق این تنظیم فقط برای جایگاه آگهی اعمال می‌شود و مقادیر تنظیم‌شده ازطریق PageSettingsConfig.safeFrame را لغو می‌کند.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

Optional هدف‌یابی

targeting?: Record<string, string | string[]>
تنظیمات پیکربندی هدف‌یابی کلید-مقدار.

هدف‌یابی پیکربندی‌شده ازطریق این تنظیمات فقط برای جایگاه آگهی اعمال می‌شود. این تنظیم ممکن است چندین بار فراخوانی شود تا چندین مقدار کلیدی هدف‌یابی را تعریف کند یا مقادیر موجود را بازنویسی کند. کلیدهای هدف‌یابی در حساب Google Ad Manager شما تعریف شده‌اند.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });
همچنین مراجعه کنید به

googletag.config.TaxonomyData

شیء حاوی مقادیر برای یک طبقه‌بندی.
مشخصات
values
فهرستی از مقادیر طبقه‌بندی.

مشخصات

مقدار

values: readonly string[]
فهرستی از مقادیر طبقه‌بندی.

googletag.config.VideoAdsConfig

تنظیمات برای پیکربندی تنظیمات مربوط به آگهی ویدیویی.
مشخصات
enableVideoAds
آیا آگهی‌های ویدیویی در صفحه وجود خواهند داشت یا نه.
videoCmsId?
شناسه منبع محتوای ویدیو.
videoContentId?
شناسه محتوای ویدیو.
همچنین مراجعه کنید به

مشخصات

enableVideoAds

enableVideoAds: boolean
اینکه آگهی‌های ویدیویی در صفحه وجود داشته باشند یا نه.

وقتی روی true تنظیم شود، محدودیت‌های مستثنا کردن محتوا را در آگهی‌های تصویری و ویدیویی فعال می‌کند.

اگر محتوای ویدیویی مشخص باشد، videoContentId و videoCmsId را روی مقادیر ارائه‌شده به سرویس دریافت محتوای Google Ad Manager تنظیم کنید تا از مستثنا کردن محتوا برای آگهی‌های تصویری استفاده کنید.

Optional videoCmsId

videoCmsId?: string
شناسه منبع محتوای ویدیو.

این مقدار منحصربه‌فردی است که توسط سرویس دریافت محتوای Google Ad Manager برای شناسایی منبع محتوای ویدیو مشخص‌شده توسط videoContentId اختصاص داده شده است.
همچنین مراجعه کنید به

Optional videoContentId

videoContentId?: string
شناسه محتوای ویدیو.

این مقدار منحصربه‌فردی است که ویدیو خاصی را از منبع محتوای مشخص‌شده توسط videoCmsId شناسایی می‌کند. این مقدار توسط سیستم مدیریت محتوایی که محتوای ویدیویی شما را میزبانی می‌کند اختصاص داده می‌شود.
همچنین مراجعه کنید به

googletag.enums

این فضای نامی است که GPT برای انواع شمارشی استفاده می‌کند.
فهرست‌ها
OutOfPageFormat
قالب‌های خارج از صفحه که GPT پشتیبانی می‌کند.
TagForAgeTreatment
تنظیمات رفتار با سن که GPT از آن‌ها پشتیبانی می‌کند.
TrafficSource
منابع ترافیک پشتیبانی‌شده توسط GPT.

فهرست‌ها

OutOfPageFormat

OutOfPageFormat
قالب‌های خارج از صفحه که GPT پشتیبانی می‌کند.
همچنین مراجعه کنید به
اعضای شمارش
AD_INTENTS
قالب «هدف‌های آگهی».
BOTTOM_ANCHOR
قالب لنگری که در آن جایگاه به پایین نمای دید می‌چسبد.
GAME_MANUAL_INTERSTITIAL
قالب بینابینی دستی بازی.

توجه: بینابینی دستی بازی قالبی با دسترسی محدود است.
INTERSTITIAL
قالب آگهی بینابینی وب.
LEFT_SIDE_RAIL
قالب ریل کناری چپ.
REWARDED
قالب پاداش‌دار.
RIGHT_SIDE_RAIL
قالب ریل سمت راست.
TOP_ANCHOR
قالب لنگر که در آن جایگاه به بالای نمای دید می‌چسبد.

TagForAgeTreatment

TagForAgeTreatment
تنظیمات رفتار با سن که GPT از آن‌ها پشتیبانی می‌کند.
همچنین مراجعه کنید به
اعضای شمارش
CHILD
نشان می‌دهد که درخواست‌های آگهی باید با رفتار مناسب سن کودک مواجه شوند.
TEEN
نشان می‌دهد که درخواست‌های آگهی باید با رفتار مناسب برای سن نوجوانان مواجه شوند.
UNSPECIFIED
مقدار پیش‌فرض. نشان می‌دهد که هیچ سیگنال رفتار محدودشده سنی خاصی برای درخواست آگهی اعمال نمی‌شود.

TrafficSource

TrafficSource
منابع ترافیک پشتیبانی‌شده توسط GPT.
همچنین مراجعه کنید به
اعضای شمارش
ORGANIC
ورودی نشانی وب مستقیم، جستجوی سایت، یا بارگیری برنامه.
PURCHASED
ترافیک هدایت‌شده از دارایی‌هایی غیراز دارایی‌های تحت مالکیت (فعالیت‌های خریداری‌شده یا ترغیب‌شده).

googletag.events

این جای‌نامی است که GPT برای «رویدادها» استفاده می‌کند. کد شما می‌تواند بااستفاده از Service.addEventListener به این رویدادها واکنش نشان دهد.
میانه‌ها
Event
رابط پایه برای همه رویدادهای GPT.
EventTypeMap
این یک شبه‌نوع است که نام رویداد را به نوع شیء رویداد مربوطه برای Service.addEventListener و Service.removeEventListener نگاشت می‌کند.
GameManualInterstitialSlotClosedEvent
این رویداد زمانی فعال می‌شود که جایگاه بینابینی دستی بازی توسط کاربر بسته شده باشد.
GameManualInterstitialSlotReadyEvent
این رویداد زمانی فعال می‌شود که جایگاه بینابینی دستی بازی برای نمایش به کاربر آماده باشد.
ImpressionViewableEvent
این رویداد زمانی فعال می‌شود که طبق معیارهای Active View، یک ظهور قابل‌مشاهده شود.
RewardedSlotClosedEvent
این رویداد زمانی فعال می‌شود که جایگاه آگهی پاداش‌دار توسط کاربر بسته شود.
RewardedSlotGrantedEvent
این رویداد زمانی فعال می‌شود که پاداشی برای مشاهده آگهی پاداش‌دار اعطا شود.
RewardedSlotReadyEvent
این رویداد زمانی فعال می‌شود که آگهی پاداش‌دار آماده نمایش باشد.
RewardedSlotVideoCompletedEvent
این رویداد زمانی فعال می‌شود که پخش آگهی ویدیویی پاداش‌دار تمام شده باشد.
SlotOnloadEvent
این رویداد زمانی فعال می‌شود که iframe طرح آگهی رویداد بارگیری خود را فعال کند.
SlotRenderEndedEvent
این رویداد زمانی فعال می‌شود که کد آگهی در جایگاه درج شود.
SlotRequestedEvent
این رویداد زمانی فعال می‌شود که آگهی برای جایگاه خاصی درخواست شده باشد.
SlotResponseReceived
این رویداد زمانی فعال می‌شود که پاسخ آگهی برای جایگاه خاصی دریافت شده باشد.
SlotVisibilityChangedEvent
این رویداد هر زمان که درصد روی صفحه جایگاه آگهی تغییر کند، فعال می‌شود.

googletag.events.Event

رابط پایه برای همه رویدادهای GPT. همه رویدادهای GPT زیر فیلدهای زیر را خواهند داشت.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
همچنین مراجعه کنید به

مشخصات

serviceName

serviceName: string
نام سرویسی که رویداد را راه‌اندازی کرده است.

slot

slot: Slot
جایگاهی که رویداد را راه‌اندازی کرده است.

googletag.events.EventTypeMap

این یک شبه‌نوع است که نام رویداد را به نوع شیء رویداد مربوطه برای Service.addEventListener و Service.removeEventListener نگاشت می‌کند. این مورد فقط برای اهداف مرجع و ایمنی تایپی مستند شده است.
مشخصات
gameManualInterstitialSlotClosed
نام مستعار برای events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady
نام مستعار برای events.GameManualInterstitialSlotReadyEvent.
impressionViewable
نام مستعار برای events.ImpressionViewableEvent.
rewardedSlotClosed
نام مستعار برای events.RewardedSlotClosedEvent.
rewardedSlotGranted
نام مستعار برای events.RewardedSlotGrantedEvent.
rewardedSlotReady
نام مستعار برای events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted
نام مستعار برای events.RewardedSlotVideoCompletedEvent.
slotOnload
نام مستعار برای events.SlotOnloadEvent.
slotRenderEnded
نام مستعار برای events.SlotRenderEndedEvent.
slotRequested
نام مستعار برای events.SlotRequestedEvent.
slotResponseReceived
نام مستعار برای events.SlotResponseReceived.
slotVisibilityChanged
نام مستعار برای events.SlotVisibilityChangedEvent.

مشخصات

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
نام مستعار برای events.GameManualInterstitialSlotClosedEvent.

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
نام مستعار برای events.GameManualInterstitialSlotReadyEvent.

impressionViewable

impressionViewable: ImpressionViewableEvent
نام مستعار برای events.ImpressionViewableEvent.

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent
نام مستعار برای events.RewardedSlotClosedEvent.

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent
نام مستعار برای events.RewardedSlotGrantedEvent.

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent
نام مستعار برای events.RewardedSlotReadyEvent.

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent
نام مستعار برای events.RewardedSlotVideoCompletedEvent.

slotOnload

slotOnload: SlotOnloadEvent
نام مستعار برای events.SlotOnloadEvent.

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent
نام مستعار برای events.SlotRenderEndedEvent.

slotRequested

slotRequested: SlotRequestedEvent
نام مستعار برای events.SlotRequestedEvent.

slotResponseReceived

slotResponseReceived: SlotResponseReceived
نام مستعار برای events.SlotResponseReceived.

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent
نام مستعار برای events.SlotVisibilityChangedEvent.

googletag.events.GameManualInterstitialSlotClosedEvent

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

توجه: بینابینی دستی بازی قالبی با دسترسی محدود است.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

// 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.
    }
  });
}

TypeScript

// 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.GameManualInterstitialSlotReadyEvent

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

توجه: بینابینی دستی بازی قالبی با دسترسی محدود است.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
روش‌ها
makeGameManualInterstitialVisible
آگهی بینابینی راهنمای بازی را به کاربر نمایش می‌دهد.
مثال

JavaScript

// 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.
    }
  });
}

TypeScript

// 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.
    }
  });
}
همچنین مراجعه کنید به

روش‌ها

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean
آگهی بینابینی راهنمای بازی را به کاربر نمایش می‌دهد. برمی‌گرداند که آیا آگهی با موفقیت نمایش داده شده است یا نه.
بازگشتی‌ها
boolean

googletag.events.ImpressionViewableEvent

تمدید Event
این رویداد زمانی فعال می‌شود که طبق معیارهای Active View، یک ظهور قابل‌مشاهده شود.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

// 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.
  }
});

TypeScript

// 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

تمدید Event
این رویداد زمانی فعال می‌شود که جایگاه آگهی پاداش‌دار توسط کاربر بسته شود. ممکن است قبل یا بعداز اعطای پاداش فعال شود. برای تعیین اینکه پاداش اعطا شده است یا نه، به‌جای آن از events.RewardedSlotGrantedEvent استفاده کنید.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

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.
    }
  });
}

TypeScript

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

تمدید Event
این رویداد زمانی فعال می‌شود که پاداشی برای مشاهده آگهی پاداش‌دار اعطا شود. اگر آگهی قبل‌از برآورده شدن معیارهای اعطای پاداش بسته شود، این رویداد اجرا نخواهد شد.
مشخصات
payload
شیئی حاوی اطلاعاتی درباره پاداش اعطاشده.
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

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.
    }
  });
}

TypeScript

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

شیئی حاوی اطلاعاتی درباره پاداش اعطاشده.

googletag.events.RewardedSlotReadyEvent

تمدید Event
این رویداد زمانی فعال می‌شود که آگهی پاداش‌دار آماده نمایش باشد. ناشر مسئول است که قبل‌از نمایش آگهی، گزینه‌ای برای مشاهده آگهی به کاربر ارائه دهد.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
روش‌ها
makeRewardedVisible
آگهی پاداش‌دار را نمایش می‌دهد.
مثال

JavaScript

// 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.
    }
  });
}

TypeScript

// 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

makeRewardedVisible(): boolean
آگهی پاداش‌دار را نمایش می‌دهد. این روش نباید فراخوانی شود تا زمانی که کاربر با مشاهده آگهی موافقت کرده باشد.
بازگشتی‌ها
booleanاینکه آگهی پاداش‌دار با موفقیت نمایش داده شده است یا نه.

googletag.events.RewardedSlotVideoCompletedEvent

تمدید Event
این رویداد زمانی فعال می‌شود که پخش آگهی ویدیویی پاداش‌دار تمام شده باشد.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

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 video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

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 video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
همچنین مراجعه کنید به

googletag.events.SlotOnloadEvent

تمدید Event
این رویداد زمانی فعال می‌شود که iframe طرح آگهی رویداد بارگیری خود را فعال کند. هنگام ارائه آگهی‌های رسانه‌ای پیشرفته در حالت ارائه همگام‌سازی، از iframe استفاده نمی‌شود، بنابراین هیچ SlotOnloadEvent فعال نخواهد شد.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

// 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.
  }
});

TypeScript

// 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

تمدید Event
این رویداد زمانی فعال می‌شود که کد آگهی در جایگاه درج شود. این رویداد قبل‌از واکشی منابع طرح آگهی رخ می‌دهد، بنابراین ممکن است طرح آگهی هنوز قابل‌مشاهده نباشد. اگر لازم است بدانید چه زمانی بار کردن همه منابع طرح‌آگهی برای جایگاه تمام شده است، به‌جای آن events.SlotOnloadEvent را درنظر بگیرید.
مشخصات
advertiserId
شناسه آگهی‌دهنده آگهی ارائه‌شده.
campaignId
شناسه پویش آگهی ارائه‌شده.
companyIds
شناسه‌های شرکت‌هایی که برای آگهی دوباره تکمیل‌شده ارائه‌شده قیمت پیشنهادی داده‌اند.
creativeId
شناسه طرح آگهی رزروشده ارائه‌شده.
creativeTemplateId
شناسه الگوی خلاقانه آگهی رزروشده ارائه‌شده.
isBackfill
آیا آگهی یک آگهی تکمیلی بوده است یا خیر.
isEmpty
آیا آگهی برای جایگاه برگردانده شده است یا نه.
labelIds
منسوخ‌شده. 
lineItemId
شناسه ردیف آگهی رزروشده ارائه‌شده.
responseIdentifier
شناسه پاسخ، شناسه یکتایی برای پاسخ آگهی است.
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
size
اندازه پیکسل طرح آگهی پردازش‌شده را نشان می‌دهد.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
slotContentChanged
اینکه آیا محتوای جایگاه با آگهی پردازش‌شده تغییر کرده است یا نه.
sourceAgnosticCreativeId
شناسه طرح آگهی رزروشده یا آگهی جایگزین.
sourceAgnosticLineItemId
شناسه مورد سطری آگهی رزرو یا آگهی جایگزین رندرشده.
yieldGroupIds
شناسه‌های گروه‌های بازده برای آگهی دوباره تکمیل‌شده رندرشده.
مثال

JavaScript

// 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.
  }
});

TypeScript

// 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

advertiserId: number
شناسه آگهی‌دهنده آگهی ارائه‌شده. مقدار برای جایگاه‌های خالی، آگهی‌های جایگزین، و طرح‌آگهی‌های ارائه‌شده توسط سرویس‌هایی غیراز PubAdsService برابر با null است.

campaignId

campaignId: number
شناسه پویش آگهی ارائه‌شده. مقدار برای جایگاه‌های خالی، آگهی‌های جایگزین، و طرح‌آگهی‌های ارائه‌شده توسط سرویس‌هایی غیراز PubAdsService برابر با null است.

companyIds

companyIds: number[]
شناسه‌های شرکت‌هایی که برای آگهی دوباره تکمیل‌شده ارائه‌شده قیمت پیشنهادی داده‌اند. مقدار برای جایگاه‌های خالی، آگهی‌های مدل رزرو، و طرح‌آگهی‌های ارائه‌شده توسط سرویس‌هایی غیراز PubAdsService برابر با null است.

creativeId

creativeId: number
شناسه طرح آگهی رزروشده ارائه‌شده. مقدار برای جایگاه‌های خالی، آگهی‌های جایگزین، و طرح‌آگهی‌های ارائه‌شده توسط سرویس‌هایی غیراز PubAdsService برابر با null است.

creativeTemplateId

creativeTemplateId: number
شناسه الگوی خلاقانه آگهی رزروشده ارائه‌شده. مقدار برای جایگاه‌های خالی، آگهی‌های جایگزین، و طرح‌آگهی‌های ارائه‌شده توسط سرویس‌هایی غیراز PubAdsService برابر با null است.

isBackfill

isBackfill: boolean
آیا آگهی یک آگهی تکمیلی بوده است یا خیر. اگر آگهی از نوع آگهی پرکننده باشد، مقدار true است، درغیراین‌صورت false است.

isEmpty

isEmpty: boolean
آیا آگهی برای جایگاه برگردانده شده است یا نه. اگر هیچ آگهی‌ای برگردانده نشود، مقدار true است، درغیراین‌صورت false است.

labelIds

labelIds: number[]

lineItemId

lineItemId: number
شناسه ردیف آگهی رزروشده ارائه‌شده. مقدار برای جایگاه‌های خالی، آگهی‌های جایگزین، و طرح‌آگهی‌های ارائه‌شده توسط سرویس‌هایی غیراز PubAdsService برابر با null است.

responseIdentifier

responseIdentifier: string
شناسه پاسخ، شناسه یکتایی برای پاسخ آگهی است. از این مقدار می‌توان برای شناسایی و مسدود کردن آگهی در مرکز بررسی آگهی استفاده کرد.

اندازه

size: string | number[]
اندازه پیکسل طرح آگهی پردازش‌شده را نشان می‌دهد. مثال: [728, 90]. مقدار برای جایگاه‌های آگهی خالی null است.

slotContentChanged

slotContentChanged: boolean
اینکه آیا محتوای جایگاه با آگهی پردازش‌شده تغییر کرده است یا نه. اگر محتوا تغییر کرده باشد، مقدار true است، درغیراین‌صورت false است.

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number
شناسه طرح آگهی رزروشده یا آگهی جایگزین. اگر آگهی رزرو یا پر کردن مجدد واحد آگهی نباشد، یا طرح آگهی توسط سرویس‌هایی غیراز PubAdsService ارائه شود، مقدار null است.

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number
شناسه مورد سطری آگهی رزرو یا آگهی جایگزین رندرشده. اگر آگهی رزرو یا پر کردن مجدد واحد آگهی نباشد، یا طرح آگهی توسط سرویس‌هایی غیراز PubAdsService ارائه شود، مقدار null است.

yieldGroupIds

yieldGroupIds: number[]
شناسه‌های گروه‌های بازده برای آگهی دوباره تکمیل‌شده رندرشده. مقدار برای جایگاه‌های خالی، آگهی‌های مدل رزرو، و طرح‌آگهی‌های ارائه‌شده توسط سرویس‌هایی غیراز PubAdsService برابر با null است.

googletag.events.SlotRequestedEvent

تمدید Event
این رویداد زمانی فعال می‌شود که آگهی برای جایگاه خاصی درخواست شده باشد.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

// 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.
  }
});

TypeScript

// 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

تمدید Event
این رویداد زمانی فعال می‌شود که پاسخ آگهی برای جایگاه خاصی دریافت شده باشد.
مشخصات
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

// 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.
  }
});

TypeScript

// 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

تمدید Event
این رویداد هر زمان که درصد روی صفحه جایگاه آگهی تغییر کند، فعال می‌شود. رویداد محدود شده است و بیشتر از یک بار در هر ۲۰۰ میلی‌ثانیه اجرا نخواهد شد.
مشخصات
inViewPercentage
درصد ناحیه آگهی که قابل‌مشاهده است.
serviceName
نام سرویسی که رویداد را راه‌اندازی کرده است.
slot
جایگاهی که رویداد را راه‌اندازی کرده است.
مثال

JavaScript

// 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.
  }
});

TypeScript

// 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

inViewPercentage: number
درصد ناحیه آگهی که قابل‌مشاهده است. مقدار عددی بین ۰ و ۱۰۰ است.

googletag.secureSignals

این جای‌نامی است که GPT برای مدیریت سیگنال‌های امن استفاده می‌کند.
میانه‌ها
BidderSignalProvider
نشان امنی را برای پیشنهاددهنده خاصی برمی‌گرداند.
PublisherSignalProvider
سیگنال امنی را برای ناشر خاصی برمی‌گرداند.
SecureSignalProvidersArray
میانایی برای مدیریت سیگنال‌های امن.
نام‌های مستعار نوع
SecureSignalProvider
میانای برگرداندن سیگنال امن برای مناقصه‌گر یا ارائه‌دهنده خاص.

نام‌های مستعار نوع

SecureSignalProvider

میانای برگرداندن سیگنال امن برای مناقصه‌گر یا ارائه‌دهنده خاص. یکی از id یا networkCode باید ارائه شود، اما نه هر دو.

googletag.secureSignals.BidderSignalProvider

نشان امنی را برای پیشنهاددهنده خاصی برمی‌گرداند.

ارائه‌دهنده نشان امن پیشنهاددهنده از ۲ بخش تشکیل شده است:

  1. تابع جمع‌آوری‌کننده که Promise را برمی‌گرداند که به سیگنال ایمن تبدیل می‌شود.
  2. id که پیشنهاددهنده مرتبط با نشان را شناسایی می‌کند.
برای برگرداندن سیگنال امن برای ناشر، به‌جای آن از secureSignals.PublisherSignalProvider استفاده کنید.
مشخصات
collectorFunction
تابعی که Promise را برمی‌گرداند که به سیگنال امنی تبدیل می‌شود.
id
شناسه یکتای جمع‌آوری‌کننده مرتبط با این سیگنال امن، همان‌طور که در «مدیر آگهی Google» ثبت شده است.
مثال

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
همچنین مراجعه کنید به

مشخصات

collectorFunction

collectorFunction: (() => Promise<string>)
تابعی که Promise را برمی‌گرداند که به سیگنال امنی تبدیل می‌شود.

id

id: string
شناسه یکتای جمع‌آوری‌کننده مرتبط با این سیگنال امن، همان‌طور که در «مدیر آگهی Google» ثبت شده است.

googletag.secureSignals.PublisherSignalProvider

سیگنال امنی را برای ناشر خاصی برمی‌گرداند.

ارائه‌دهنده سیگنال ناشر از ۲ بخش تشکیل شده است:

  1. تابع جمع‌آوری‌کننده که Promise را برمی‌گرداند که به سیگنال ایمن تبدیل می‌شود.
  2. networkCode که ناشر مرتبط با نشان را شناسایی می‌کند.
برای برگرداندن نشان امن برای پیشنهاددهنده، به‌جای آن از secureSignals.BidderSignalProvider استفاده کنید.
مشخصات
collectorFunction
تابعی که Promise را برمی‌گرداند که به سیگنال امنی تبدیل می‌شود.
networkCode
کد شبکه (همان‌طور که در مسیر واحد آگهی دیده می‌شود) برای ناشر مرتبط با این سیگنال امن.
مثال

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
همچنین مراجعه کنید به

مشخصات

collectorFunction

collectorFunction: (() => Promise<string>)
تابعی که Promise را برمی‌گرداند که به سیگنال امنی تبدیل می‌شود.

networkCode

networkCode: string
کد شبکه (همان‌طور که در مسیر واحد آگهی دیده می‌شود) برای ناشر مرتبط با این سیگنال امن.

googletag.secureSignals.SecureSignalProvidersArray

میانایی برای مدیریت سیگنال‌های امن.
روش‌ها
clearAllCache
همه سیگنال‌ها را برای همه جمع‌آوری‌کنندگان از حافظه نهان پاک می‌کند.
push
secureSignals.SecureSignalProvider جدیدی به آرایه ارائه‌دهنده سیگنال اضافه می‌کند و فرایند تولید سیگنال را آغاز می‌کند.

روش‌ها

clearAllCache

clearAllCache(): void
همه نشان‌ها را برای همه جمع‌آورندگان از حافظه نهان پاک می‌کند.

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

فشار دادن

push(provider: SecureSignalProvider): void
secureSignals.SecureSignalProvider جدیدی به آرایه ارائه‌دهنده سیگنال اضافه می‌کند و فرایند تولید سیگنال را آغاز می‌کند.
پارامترها
provider: SecureSignalProviderشیء secureSignals.SecureSignalProvider برای اضافه شدن به آرایه.