مرجع GPT

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

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

برای اطلاعات بیشتر در مورد انواع پشتیبانی شده و عبارات نوع، به راهنمای TypeScript مراجعه کنید.

حاشیه نویسی را تایپ کنید

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

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

تعاریف را تایپ کنید

انواع
SingleSize | MultiSize

یک پیکربندی اندازه معتبر برای یک اسلات، که می تواند یک یا چند اندازه باشد.

SingleSize []

لیستی از اندازه های معتبر تکی.

"fluid" | ["fluid"]

اندازه های نامگذاری شده ای که یک اسلات می تواند داشته باشد. در اکثر موارد اندازه یک مستطیل با اندازه ثابت است، اما مواردی وجود دارد که به انواع دیگر مشخصات اندازه نیاز داریم. فقط موارد زیر اندازه های نامگذاری شده معتبر هستند:

  • مایع : ظرف تبلیغات 100% عرض div والد را می گیرد و سپس ارتفاع آن را تغییر می دهد تا متناسب با محتوای خلاقانه باشد. مشابه رفتار عناصر بلوک معمولی در یک صفحه. برای تبلیغات بومی استفاده می شود ( مقاله مرتبط را ببینید). توجه داشته باشید که هم fluid و هم ['fluid'] اشکال قابل قبولی برای اعلام اندازه شکاف به عنوان سیال هستند.

SingleSizeArray | NamedSize

یک اندازه معتبر برای یک اسلات.

[number, number]

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

[ SingleSizeArray , GeneralSize ]

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

SizeMapping []

لیستی از نگاشت اندازه

"unhideWindow" | "navBar"

محرک های تبلیغات بینابینی پشتیبانی می شود.

"disablePersonalization"

پشتیبانی از رفتارهای حریم خصوصی ناشر.

"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

طبقه بندی های پشتیبانی شده برای سیگنال های ارائه شده توسط ناشر (PPS) .

BidderSignalProvider | PublisherSignalProvider

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

انواع Enum

Enums
googletag . enums . OutOfPageFormat
فرمت های خارج از صفحه که توسط GPT پشتیبانی می شوند.
googletag . enums . TrafficSource
منابع ترافیک پشتیبانی شده توسط GPT.

googletag . enums . OutOfPageFormat

  • فرمت های خارج از صفحه که توسط GPT پشتیبانی می شوند.

  • همچنین ببینید
  • ارزش های
    BOTTOM_ANCHOR
    قالب لنگر که در آن شکاف به پایین درگاه دید می چسبد.
    INTERSTITIAL
    قالب خلاق بینابینی وب.
    LEFT_SIDE_RAIL
    فرمت ریل سمت چپ.
    REWARDED
    قالب پاداش.
    RIGHT_SIDE_RAIL
    فرمت ریل سمت راست.
    TOP_ANCHOR
    قالب لنگر که در آن شکاف به بالای درگاه دید می چسبد.

googletag . enums . TrafficSource

  • منابع ترافیک پشتیبانی شده توسط GPT.

  • همچنین ببینید
  • ارزش های
    ORGANIC
    ورود مستقیم URL، جستجوی سایت، یا دانلود برنامه.
    PURCHASED
    ترافیک هدایت‌شده از دارایی‌هایی غیر از مالکیت (فعالیت اکتسابی یا مشوق‌های دیگر).

googletag

فضای نام جهانی که تگ Google Publisher برای API خود استفاده می کند.

خلاصه متغیر
apiReady
پرچمی که نشان می دهد GPT API بارگیری شده و آماده فراخوانی است.
cmd
ارجاع به صف فرمان جهانی برای اجرای ناهمزمان تماس های مربوط به GPT.
pubadsReady
پرچمی که نشان می دهد PubAdsService فعال، بارگیری شده و کاملاً عملیاتی است.
secureSignalProviders
ارجاع به آرایه ارائه دهندگان سیگنال امن.
خلاصه عملکرد
companionAds
مرجعی را به CompanionAdsService برمی گرداند.
defineOutOfPageSlot
با مسیر واحد آگهی داده شده، یک جایگاه تبلیغاتی خارج از صفحه ایجاد می کند.
defineSlot
یک جایگاه تبلیغاتی با یک مسیر و اندازه واحد تبلیغاتی معین می سازد و آن را با شناسه یک عنصر div در صفحه ای که حاوی آگهی است مرتبط می کند.
destroySlots
اسلات های داده شده را از بین می برد و تمام اشیاء مرتبط و مراجع آن اسلات ها را از GPT حذف می کند.
disablePublisherConsole
کنسول Google Publisher را غیرفعال می کند.
display
به خدمات اسلات دستور می دهد تا اسلات را ارائه دهند.
enableServices
همه سرویس‌های GPT را که برای اسلات تبلیغاتی در صفحه تعریف شده‌اند، فعال می‌کند.
getVersion
نسخه فعلی GPT را برمی‌گرداند.
openConsole
Google Publisher Console را باز می کند.
pubads
مرجعی را به PubAdsService برمی گرداند.
setAdIframeTitle
عنوان را برای همه iframe های کانتینر آگهی ایجاد شده توسط PubAdsService از این مرحله به بعد تنظیم می کند.
setConfig
گزینه های پیکربندی کلی صفحه را تنظیم می کند.
sizeMapping
یک SizeMappingBuilder جدید ایجاد می کند.

googletag . apiReady

  • apiReady: boolean | undefined

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

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

  • مثال

    جاوا اسکریپت

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    جاوا اسکریپت (میراث)

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    TypeScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

googletag . cmd

  • cmd: Array<(this: typeof globalThis) => void> | CommandArray

  • ارجاع به صف فرمان جهانی برای اجرای ناهمزمان تماس های مربوط به GPT.

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

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

googletag . pubadsReady

  • pubadsReady: boolean | undefined

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

googletag . secureSignalProviders

  • secureSignalProviders: SecureSignalProvider [] | SecureSignalProvidersArray | undefined

  • ارجاع به آرایه ارائه دهندگان سیگنال امن.

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

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

googletag . companionAds

googletag . defineOutOfPageSlot

  • defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat ): Slot | null

  • با مسیر واحد آگهی داده شده، یک جایگاه تبلیغاتی خارج از صفحه ایجاد می کند.

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

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

  • مثال

    جاوا اسکریپت

    // Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

    جاوا اسکریپت (میراث)

    // Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

    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
    مسیر کامل واحد تبلیغات با کد شبکه و کد واحد تبلیغات.
    div?: string | OutOfPageFormat
    شناسه div که حاوی این واحد تبلیغات یا OutOfPageFormat است.
  • برمی گرداند
    Slot | null
    اسلات تازه ایجاد شده، یا اگر شکافی ایجاد نشود، null .

googletag . defineSlot

  • defineSlot(adUnitPath: string, size: GeneralSize , div?: string): Slot | null

  • یک جایگاه تبلیغاتی با یک مسیر و اندازه واحد تبلیغاتی معین می سازد و آن را با شناسه یک عنصر div در صفحه ای که حاوی آگهی است مرتبط می کند.

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

googletag . destroySlots

  • destroySlots(slots?: Slot []): boolean

  • اسلات های داده شده را از بین می برد و تمام اشیاء مرتبط و مراجع آن اسلات ها را از GPT حذف می کند. این API از اسلات های پس انداز و اسلات های همراه پشتیبانی نمی کند.

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

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

  • مثال

    جاوا اسکریپت

    // The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

    جاوا اسکریپت (میراث)

    // The calls to construct an ad and display contents.
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

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

googletag . disablePublisherConsole

  • disablePublisherConsole(): void

  • کنسول Google Publisher را غیرفعال می کند.

  • همچنین ببینید

googletag . display

  • display(divOrSlot: string | Element | Slot ): void

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

    اگر از معماری تک درخواست (SRA) استفاده شود، تمام اسلات های تبلیغاتی واکشی نشده در زمانی که این روش فراخوانی می شود، به یکباره واکشی می شوند. برای اینکه یک شکاف آگهی نمایش داده نشود، کل div باید حذف شود.

  • مثال

    جاوا اسکریپت

    googletag.cmd.push(() => {
  googletag.display("div-1");
});

    جاوا اسکریپت (میراث)

    googletag.cmd.push(function () {
  googletag.display("div-1");
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    همچنین ببینید
  • مولفه های
    divOrSlot: string | Element | Slot
    شناسه عنصر div حاوی شکاف آگهی یا عنصر div یا شی شکاف. اگر یک عنصر div ارائه شده باشد، باید یک ویژگی 'id' داشته باشد که با شناسه ارسال شده به defineSlot مطابقت داشته باشد.

googletag . enableServices

  • enableServices(): void

  • همه سرویس‌های GPT را که برای اسلات تبلیغاتی در صفحه تعریف شده‌اند، فعال می‌کند.

googletag . getVersion

  • getVersion(): string

  • نسخه فعلی GPT را برمی‌گرداند.

  • همچنین ببینید
  • برمی گرداند
    string
    رشته نسخه GPT در حال اجرا.

googletag . openConsole

  • openConsole(div?: string): void

  • Google Publisher Console را باز می کند.

  • مثال

    جاوا اسکریپت

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

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

    جاوا اسکریپت (میراث)

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

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

    TypeScript

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

// Calling without div ID.
googletag.openConsole();
    همچنین ببینید
  • مولفه های
    div?: string
    شناسه div اسلات آگهی. این مقدار اختیاری است. هنگامی که ارائه شد، کنسول ناشر تلاش می کند تا با جزئیات فضای تبلیغاتی مشخص شده باز شود.

googletag . pubads

googletag . setAdIframeTitle

  • setAdIframeTitle(title: string): void

  • عنوان را برای همه iframe های کانتینر آگهی ایجاد شده توسط PubAdsService از این مرحله به بعد تنظیم می کند.

  • مثال

    جاوا اسکریپت

    googletag.setAdIframeTitle("title");

    جاوا اسکریپت (میراث)

    googletag.setAdIframeTitle("title");

    TypeScript

    googletag.setAdIframeTitle("title");
  • مولفه های
    title: string
    عنوان جدید برای همه iframe های کانتینر تبلیغاتی.

googletag . setConfig

googletag . sizeMapping

googletag . CommandArray

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

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

push

  • push(...f: Array<(this: typeof globalThis) => void>): number

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

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

googletag . CompanionAdsService

Service را گسترش می دهد

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

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

setRefreshUnfilledSlots

  • setRefreshUnfilledSlots(value: boolean): void

  • تعیین می کند که آیا اسلات های همراهی که پر نشده اند به طور خودکار پر شوند یا خیر.

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

  • مثال

    جاوا اسکریپت

    googletag.companionAds().setRefreshUnfilledSlots(true);

    جاوا اسکریپت (میراث)

    googletag.companionAds().setRefreshUnfilledSlots(true);

    TypeScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
  • مولفه های
    value: boolean
    true برای پر کردن خودکار اسلات های پر نشده، false تا بدون تغییر باقی بماند.

googletag . PrivacySettingsConfig

شی پیکربندی برای تنظیمات حریم خصوصی.

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

childDirectedTreatment

limitedAds

nonPersonalizedAds

  • nonPersonalizedAds: boolean

  • برای کمک به نیازهای انطباق با مقررات ناشر، سرویس را در حالت تبلیغات غیرشخصی اجرا می کند.

restrictDataProcessing

  • restrictDataProcessing: boolean

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

trafficSource

  • trafficSource: TrafficSource

  • نشان می دهد که آیا درخواست ها ترافیک خریداری شده یا ارگانیک را نشان می دهند. این مقدار بعد منبع ترافیک را در گزارش Ad Manager پر می کند. اگر تنظیم نشده باشد، منبع ترافیک به طور پیش‌فرض در گزارش undefined .

  • مثال

    جاوا اسکریپت

    // Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

    جاوا اسکریپت (میراث)

    // Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

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

underAgeOfConsent

  • underAgeOfConsent: null | 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
تبلیغات جدید را برای خاص یا همه اسلات های موجود در صفحه واکشی و نمایش می دهد.
removeEventListener
شنونده قبلا ثبت نام شده را حذف می کند.
set
مقادیری را برای ویژگی‌های AdSense تنظیم می‌کند که برای همه جایگاه‌های تبلیغاتی تحت سرویس Publisher Ads اعمال می‌شود.
setCategoryExclusion
یک استثناء طبقه بندی آگهی در سطح صفحه برای نام برچسب داده شده تنظیم می کند.
setCentering
مرکز افقی تبلیغات را فعال و غیرفعال می کند.
setForceSafeFrame
پیکربندی می‌کند که آیا همه آگهی‌های موجود در صفحه باید با استفاده از ظرف SafeFrame ارائه شوند یا خیر.
setLocation
اطلاعات مکان را از وب‌سایت‌ها ارسال می‌کند تا بتوانید موارد خط را به مکان‌های خاص هدف‌گیری جغرافیایی کنید.
setPrivacySettings
به پیکربندی تمام تنظیمات حریم خصوصی از یک API با استفاده از یک شیء پیکربندی اجازه می‌دهد.
setPublisherProvidedId
مقدار شناسه ارائه شده توسط ناشر را تنظیم می کند.
setSafeFrameConfig
تنظیمات برگزیده سطح صفحه را برای پیکربندی SafeFrame تنظیم می کند.
setTargeting
پارامترهای هدف‌یابی سفارشی را برای یک کلید مشخص تنظیم می‌کند که برای همه جایگاه‌های تبلیغاتی سرویس آگهی‌های ناشر اعمال می‌شود.
setVideoContent
اطلاعات محتوای ویدیویی را برای ارسال به همراه درخواست‌های آگهی برای اهداف هدف‌یابی و حذف محتوا تنظیم می‌کند.
updateCorrelator
همبستگی که با درخواست های تبلیغاتی ارسال می شود را تغییر می دهد و عملاً یک نمای صفحه جدید را شروع می کند.

clear

  • clear(slots?: Slot []): boolean

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

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

  • مثال

    جاوا اسکریپت

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

    جاوا اسکریپت (میراث)

    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

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

clearCategoryExclusions

  • clearCategoryExclusions(): PubAdsService

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

  • مثال

    جاوا اسکریپت

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

    جاوا اسکریپت (میراث)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

clearTargeting

  • clearTargeting(key?: string): PubAdsService

  • پارامترهای هدف گیری سفارشی را برای یک کلید خاص یا برای همه کلیدها پاک می کند.

  • مثال

    جاوا اسکریپت

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

    جاوا اسکریپت (میراث)

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.
    همچنین ببینید
  • مولفه های
    key?: string
    کلید پارامتر هدف. کلید اختیاری است. تمام پارامترهای هدف گیری در صورت نامشخص بودن پاک خواهند شد.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که متد بر روی آن فراخوانی شده است.

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

  • جمع کردن div های اسلات را فعال می کند تا زمانی که محتوای تبلیغاتی برای نمایش وجود ندارد، فضایی را در صفحه اشغال نکنند. این حالت باید قبل از فعال شدن سرویس تنظیم شود.

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

disableInitialLoad

display

  • display(adUnitPath: string, size: GeneralSize , div?: string | Element, clickUrl?: string): void

  • یک جایگاه تبلیغاتی با مسیر و اندازه واحد تبلیغاتی داده شده می سازد و نمایش می دهد. این روش با حالت تک درخواست کار نمی کند.

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

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

enableLazyLoad

  • enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void

  • بارگیری تنبل را در GPT همانطور که توسط شی پیکربندی تعریف شده است فعال می کند. برای مثال های دقیق تر، نمونه بارگیری Lazy را ببینید.

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

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

      حداقل فاصله یک شکاف از نمای فعلی باید قبل از واکشی تبلیغ به عنوان درصدی از اندازه درگاه نمایش باشد. مقدار 0 به معنای "زمانی که شکاف وارد نمای نمایش می شود"، 100 به معنای "زمانی که تبلیغ 1 پورت دید فاصله دارد" و غیره است.
    • renderMarginPercent

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

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

enableSingleRequest

  • enableSingleRequest(): boolean

  • حالت درخواست تک را برای واکشی چند آگهی به طور همزمان فعال می کند. این امر مستلزم آن است که قبل از فعال کردن سرویس، تمام جایگاه‌های تبلیغات ناشر تعریف و به PubAdsService اضافه شوند. حالت تک درخواست باید قبل از فعال شدن سرویس تنظیم شود.

  • همچنین ببینید
  • برمی گرداند
    boolean
    اگر حالت درخواست تک فعال باشد true و اگر غیرممکن باشد حالت درخواست تک را فعال کنید false برمی‌گرداند زیرا متد پس از فعال شدن سرویس فراخوانی شده است.

enableVideoAds

  • enableVideoAds(): void

  • به GPT سیگنال می دهد که تبلیغات ویدیویی در صفحه وجود خواهد داشت. این محدودیت‌های حذف رقابتی در تبلیغات نمایشی و ویدیویی را فعال می‌کند. اگر محتوای ویدیویی شناخته شده است، با PubAdsService.setVideoContent تماس بگیرید تا بتوانید از حذف محتوا برای تبلیغات نمایشی استفاده کنید.

get

  • get(key: string): null | string

  • مقدار مشخصه AdSense مرتبط با کلید داده شده را برمی گرداند.

  • مثال

    جاوا اسکریپت

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

    جاوا اسکریپت (میراث)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
    همچنین ببینید
  • مولفه های
    key: string
    نام ویژگی مورد نظر برای جستجو
  • برمی گرداند
    null | string
    مقدار فعلی برای کلید مشخصه، یا اگر کلید موجود نباشد، null .

getAttributeKeys

  • getAttributeKeys(): string[]

  • کلیدهای ویژگی تنظیم شده در این سرویس را برمی گرداند.

  • مثال

    جاوا اسکریپت

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    جاوا اسکریپت (میراث)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
  • برمی گرداند
    string[]
    مجموعه ای از کلیدهای ویژگی روی این سرویس تنظیم شده است. سفارش تعریف نشده است.

getTargeting

  • getTargeting(key: string): string[]

  • یک پارامتر هدف‌یابی در سطح خدمات سفارشی را که تنظیم شده است، برمی‌گرداند.

  • مثال

    جاوا اسکریپت

    googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

    جاوا اسکریپت (میراث)

    googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).
  • مولفه های
    key: string
    کلید هدف گیری برای جستجو
  • برمی گرداند
    string[]
    مقادیر مرتبط با این کلید، یا یک آرایه خالی اگر چنین کلیدی وجود نداشته باشد.

getTargetingKeys

  • getTargetingKeys(): string[]

  • فهرستی از تمام کلیدهای هدف گذاری در سطح سرویس سفارشی که تنظیم شده اند را برمی گرداند.

  • مثال

    جاوا اسکریپت

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

    جاوا اسکریپت (میراث)

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].
  • برمی گرداند
    string[]
    مجموعه ای از کلیدهای هدف گیری سفارش تعریف نشده است.

isInitialLoadDisabled

  • isInitialLoadDisabled(): boolean

  • نشان می‌دهد که آیا درخواست‌های اولیه برای تبلیغات با موفقیت در تماس قبلی PubAdsService.disableInitialLoad غیرفعال شده است یا خیر.

  • برمی گرداند
    boolean
    اگر تماس قبلی با PubAdsService.disableInitialLoad موفقیت آمیز بود، true ، در غیر این صورت false .

refresh

  • refresh(slots?: null | Slot [], options?: { changeCorrelator: boolean }): void

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

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

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

  • مثال

    جاوا اسکریپت

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

    جاوا اسکریپت (میراث)

    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

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

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

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

set

  • set(key: string, value: string): PubAdsService

  • مقادیری را برای ویژگی‌های AdSense تنظیم می‌کند که برای همه جایگاه‌های تبلیغاتی تحت سرویس Publisher Ads اعمال می‌شود.

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

  • مثال

    جاوا اسکریپت

    googletag.pubads().set("adsense_background_color", "#FFFFFF");

    جاوا اسکریپت (میراث)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    همچنین ببینید
  • مولفه های
    key: string
    نامی از مشخصات.
    value: string
    ارزش صفت.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که متد بر روی آن فراخوانی شده است.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): PubAdsService

  • یک استثناء طبقه بندی آگهی در سطح صفحه برای نام برچسب داده شده تنظیم می کند.

  • مثال

    جاوا اسکریپت

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

    جاوا اسکریپت (میراث)

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

    TypeScript

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
    همچنین ببینید
  • مولفه های
    categoryExclusion: string
    برچسب حذف دسته آگهی برای افزودن.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که متد بر روی آن فراخوانی شده است.

setCentering

  • setCentering(centerAds: boolean): void

  • مرکز افقی تبلیغات را فعال و غیرفعال می کند. مرکز به طور پیش فرض غیرفعال است. در gpt_mobile.js قدیمی، وسط به طور پیش فرض فعال است.

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

  • مثال

    جاوا اسکریپت

    // Make ads centered.
googletag.pubads().setCentering(true);

    جاوا اسکریپت (میراث)

    // Make ads centered.
googletag.pubads().setCentering(true);

    TypeScript

    // Make ads centered.
googletag.pubads().setCentering(true);
  • مولفه های
    centerAds: boolean
    true در مرکز تبلیغات، false برای تراز چپ آنها.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

  • پیکربندی می‌کند که آیا همه آگهی‌های موجود در صفحه باید با استفاده از ظرف SafeFrame ارائه شوند یا خیر.

    لطفاً هنگام استفاده از این API موارد زیر را در نظر داشته باشید:

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

  • مثال

    جاوا اسکریپت

    googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    جاوا اسکریپت (میراث)

    googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
    همچنین ببینید
  • مولفه های
    forceSafeFrame: boolean
    true تا همه تبلیغات موجود در صفحه در SafeFrames ارائه شوند و false برای تغییر تنظیمات قبلی به false. تنظیم این روی false زمانی که قبلا مشخص نشده باشد، چیزی را تغییر نخواهد داد.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که تابع روی آن فراخوانی شده است.

setLocation

  • setLocation(address: string): PubAdsService

  • اطلاعات مکان را از وب‌سایت‌ها ارسال می‌کند تا بتوانید موارد خط را به مکان‌های خاص هدف‌گیری جغرافیایی کنید.

  • مثال

    جاوا اسکریپت

    // Postal code:
googletag.pubads().setLocation("10001,US");

    جاوا اسکریپت (میراث)

    // Postal code:
googletag.pubads().setLocation("10001,US");

    TypeScript

    // Postal code:
googletag.pubads().setLocation("10001,US");
  • مولفه های
    address: string
    آدرس فرم آزاد.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که متد بر روی آن فراخوانی شده است.

setPrivacySettings

  • setPrivacySettings(privacySettings: PrivacySettingsConfig ): PubAdsService

  • به پیکربندی تمام تنظیمات حریم خصوصی از یک API با استفاده از یک شیء پیکربندی اجازه می‌دهد.

  • مثال

    جاوا اسکریپت

    googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

    جاوا اسکریپت (میراث)

    googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

    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

  • مقدار شناسه ارائه شده توسط ناشر را تنظیم می کند.

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    همچنین ببینید
  • مولفه های
    ppid: string
    شناسه الفبایی که توسط ناشر ارائه شده است. باید بین 32 تا 150 کاراکتر باشد.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که متد بر روی آن فراخوانی شده است.

setSafeFrameConfig

  • setSafeFrameConfig(config: SafeFrameConfig ): PubAdsService

  • تنظیمات برگزیده سطح صفحه را برای پیکربندی SafeFrame تنظیم می کند. هر کلید ناشناخته در شیء پیکربندی نادیده گرفته می شود. اگر یک مقدار نامعتبر برای یک کلید شناخته شده ارسال شود، کل پیکربندی نادیده گرفته می شود.

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

  • مثال

    جاوا اسکریپت

    googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    جاوا اسکریپت (میراث)

    googletag.pubads().setForceSafeFrame(true);

var pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
    همچنین ببینید
  • مولفه های
    config: SafeFrameConfig
    شی پیکربندی.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که متد بر روی آن فراخوانی شده است.

setTargeting

  • setTargeting(key: string, value: string | string[]): PubAdsService

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

  • مثال

    جاوا اسکریپت

    // Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

    جاوا اسکریپت (میراث)

    // Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

    TypeScript

    // Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);
    همچنین ببینید
  • مولفه های
    key: string
    کلید پارامتر هدف.
    value: string | string[]
    مقدار پارامتر هدف یا آرایه ای از مقادیر.
  • برمی گرداند
    PubAdsService
    شیء سرویسی که متد بر روی آن فراخوانی شده است.

setVideoContent

  • setVideoContent(videoContentId: string, videoCmsId: string): void

  • اطلاعات محتوای ویدیویی را برای ارسال به همراه درخواست‌های آگهی برای اهداف هدف‌یابی و حذف محتوا تنظیم می‌کند. با فراخوانی این روش، تبلیغات ویدیویی به طور خودکار فعال می شوند. برای videoContentId و videoCmsId ، از مقادیری استفاده کنید که به سرویس جذب محتوای Google Ad Manager ارائه شده است.

  • همچنین ببینید
  • مولفه های
    videoContentId: string
    شناسه محتوای ویدیویی
    videoCmsId: string
    شناسه CMS ویدیو.

updateCorrelator

  • updateCorrelator(): PubAdsService

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

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

  • مثال

    جاوا اسکریپت

    // Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

    جاوا اسکریپت (میراث)

    // Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

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

شیئی که نشان دهنده یک پاسخ آگهی واحد است.

خلاصه اموال
advertiserId
شناسه آگهی دهنده
campaignId
شناسه کمپین
creativeId
شناسه خلاق.
creativeTemplateId
شناسه قالب آگهی
lineItemId
شناسه مورد خط.
همچنین ببینید

advertiserId

  • advertiserId: null | number

  • شناسه آگهی دهنده

campaignId

  • campaignId: null | number

  • شناسه کمپین

creativeId

  • creativeId: null | number

  • شناسه خلاق.

creativeTemplateId

  • creativeTemplateId: null | number

  • شناسه قالب آگهی

lineItemId

  • lineItemId: null | number

  • شناسه مورد خط.

googletag . RewardedPayload

شیئی که نشان دهنده پاداش مرتبط با یک تبلیغ پاداش است

خلاصه اموال
amount
تعداد موارد گنجانده شده در پاداش.
type
نوع کالایی که در جایزه گنجانده شده است (مثلاً "سکه").
همچنین ببینید

amount

  • amount: number

  • تعداد موارد گنجانده شده در پاداش.

type

  • type: string

  • نوع کالایی که در جایزه گنجانده شده است (مثلاً "سکه").

googletag . SafeFrameConfig

شیء پیکربندی برای ظروف SafeFrame .

خلاصه اموال
allowOverlayExpansion
آیا SafeFrame باید به محتوای تبلیغات اجازه دهد تا با همپوشانی محتوای صفحه گسترش یابد یا خیر.
allowPushExpansion
آیا SafeFrame باید به محتوای تبلیغات اجازه دهد تا با فشار دادن محتوای صفحه گسترش یابد یا خیر.
sandbox
آیا SafeFrame باید از ویژگی HTML5 sandbox برای جلوگیری از ناوبری سطح بالا بدون تعامل کاربر استفاده کند یا خیر.
useUniqueDomain
منسوخ. آیا SafeFrame باید از زیر دامنه‌های تصادفی‌سازی شده برای خلاقیت‌های رزرو استفاده کند یا خیر.
همچنین ببینید

allowOverlayExpansion

  • allowOverlayExpansion: boolean

  • آیا SafeFrame باید به محتوای تبلیغات اجازه دهد تا با همپوشانی محتوای صفحه گسترش یابد یا خیر.

allowPushExpansion

  • allowPushExpansion: boolean

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

sandbox

  • sandbox: boolean

  • آیا SafeFrame باید از ویژگی HTML5 sandbox برای جلوگیری از ناوبری سطح بالا بدون تعامل کاربر استفاده کند یا خیر. تنها مقدار معتبر true است (نمی توان آن را false اجبار کرد). توجه داشته باشید که ویژگی sandbox افزونه ها (مثلاً فلش) را غیرفعال می کند.

useUniqueDomain

  • useUniqueDomain: null | boolean

  • آیا SafeFrame باید از زیر دامنه‌های تصادفی‌سازی شده برای خلاقیت‌های رزرو استفاده کند یا خیر. برای پاک کردن مقدار ذخیره شده null را پاس کنید.

    توجه: این ویژگی به صورت پیش فرض فعال است.

  • همچنین ببینید

googletag . Service

کلاس سرویس پایه که شامل متدهای مشترک برای همه سرویس ها است.

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

addEventListener

  • addEventListener<K extends keyof EventTypeMap >(eventType: K, listener: (arg: EventTypeMap [K]) => void): Service

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

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

  • مثال

    جاوا اسکریپت

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

    جاوا اسکریپت (میراث)

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

    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

  • شنونده قبلا ثبت نام شده را حذف می کند.

  • مثال

    جاوا اسکریپت

    googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

    جاوا اسکریپت (میراث)

    googletag.cmd.push(function () {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  var onViewableListener = function (event) {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(function () {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

    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

  • یک نگاشت از یک آرایه تک سایز (که نمایانگر درگاه دید است) به یک آرایه تک یا چند اندازه که نشان دهنده شکاف است اضافه می کند.

  • مثال

    جاوا اسکریپت

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

    جاوا اسکریپت (میراث)

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

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

  • build(): null | SizeMappingArray

  • مشخصات نقشه اندازه را از نقشه های اضافه شده به این سازنده می سازد.

    اگر هر گونه نگاشت نامعتبر ارائه شده باشد، این روش null را برمی گرداند. در غیر این صورت مشخصاتی را با فرمت صحیح برمی گرداند تا به Slot.defineSizeMapping منتقل شود.

    توجه: رفتار سازنده پس از فراخوانی این متد تعریف نشده است.

  • برمی گرداند
    null | SizeMappingArray
    نتیجه ساخته شده توسط این سازنده. اگر نگاشت اندازه نامعتبر ارائه شده باشد، می تواند باطل شود.

googletag . Slot

Slot یک شی است که نشان دهنده یک جایگاه آگهی در یک صفحه است.

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

addService

  • addService(service: Service ): Slot

  • Service به این شکاف اضافه می کند.

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

    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

  • تمام برچسب های محرومیت دسته AD در سطح اسلات را برای این شکاف پاک می کند.

  • مثال

    جاوا اسکریپت

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

    جاوا اسکریپت (میراث)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

clearTargeting

  • clearTargeting(key?: string): Slot

  • پارامترهای هدفمند هدف خاص یا همه سطح سفارشی را برای این شکاف پاک می کند.

  • مثال

    جاوا اسکریپت

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

    جاوا اسکریپت (میراث)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

    TypeScript

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.
    همچنین ببینید
  • مولفه های
    key?: string
    کلید پارامتر هدفمند. کلید اختیاری است ؛ اگر مشخص نشده باشد ، تمام پارامترهای هدفمند پاک می شوند.
  • برمی گرداند
    Slot
    شیء شکاف که در آن روش خوانده شده است.

defineSizeMapping

  • defineSizeMapping(sizeMapping: SizeMappingArray ): Slot

  • مجموعه ای از نگاشتها را از حداقل اندازه منظره به اندازه شکاف برای این شکاف تنظیم می کند.

  • مثال

    جاوا اسکریپت

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

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ]
  )
  .build();

slot.defineSizeMapping(mapping);

    جاوا اسکریپت (میراث)

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

var mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ]
  )
  .build();

slot.defineSizeMapping(mapping);

    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

  • get(key: string): null | string

  • مقدار را برای ویژگی AdSense مرتبط با کلید داده شده برای این شکاف برمی گرداند. برای دیدن ویژگی های سطح خدمات که توسط این شکاف به ارث رسیده اند ، از PubAdsService.get استفاده کنید.

  • مثال

    جاوا اسکریپت

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

    جاوا اسکریپت (میراث)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

    TypeScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.
    همچنین ببینید
  • مولفه های
    key: string
    نام این ویژگی برای جستجوی.
  • برمی گرداند
    null | string
    مقدار فعلی برای کلید ویژگی ، یا اگر کلید موجود نیست ، null .

getAdUnitPath

  • getAdUnitPath(): string

  • مسیر کامل واحد AD را با کد شبکه و مسیر واحد AD برمی گرداند.

  • مثال

    جاوا اسکریپت

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

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

    جاوا اسکریپت (میراث)

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

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

    TypeScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.
  • برمی گرداند
    string
    مسیر واحد تبلیغ.

getAttributeKeys

  • getAttributeKeys(): string[]

  • لیست کلیدهای ویژگی تنظیم شده در این شکاف را برمی گرداند. برای دیدن کلیدهای ویژگی های سطح خدمات که توسط این شکاف به ارث رسیده اند ، از PubAdsService.getAttributeKeys استفاده کنید.

  • مثال

    جاوا اسکریپت

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    جاوا اسکریپت (میراث)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
  • برمی گرداند
    string[]
    مجموعه کلیدهای ویژگی. سفارش تعریف نشده است.

getCategoryExclusions

  • getCategoryExclusions(): string[]

  • برچسب های محرومیت دسته AD را برای این شکاف برمی گرداند.

  • مثال

    جاوا اسکریپت

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

    جاوا اسکریپت (میراث)

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

    TypeScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].
  • برمی گرداند
    string[]
    برچسب های محرومیت دسته آگهی برای این شکاف یا یک آرایه خالی در صورت تنظیم هیچ یک از آنها.

getResponseInformation

  • getResponseInformation(): null | ResponseInformation

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

  • برمی گرداند
    null | ResponseInformation
    آخرین اطلاعات پاسخ تبلیغات یا null در صورتی که شکاف AD نداشته باشد.

getSlotElementId

  • getSlotElementId(): string

  • شناسه div شکاف ارائه شده هنگام تعریف شکاف را برمی گرداند.

  • مثال

    جاوا اسکریپت

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

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

    جاوا اسکریپت (میراث)

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

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

    TypeScript

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

slot.getSlotElementId();
// Returns 'div-1'.
  • برمی گرداند
    string
    Slot div ID.

getTargeting

  • getTargeting(key: string): string[]

  • یک پارامتر هدفمند سفارشی خاص را که در این شکاف تنظیم شده است ، برمی گرداند. پارامترهای هدفمند سطح خدمات گنجانده نشده است.

  • مثال

    جاوا اسکریپت

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

    جاوا اسکریپت (میراث)

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

    TypeScript

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).
  • مولفه های
    key: string
    کلید هدفمند برای جستجوی.
  • برمی گرداند
    string[]
    مقادیر مرتبط با این کلید یا یک آرایه خالی در صورت وجود چنین کلید.

getTargetingKeys

  • getTargetingKeys(): string[]

  • لیست کلیه کلیدهای هدفمند سفارشی را که روی این شکاف تنظیم شده است ، برمی گرداند. کلیدهای هدفمند سطح خدمات گنجانده نشده است.

  • مثال

    جاوا اسکریپت

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

    جاوا اسکریپت (میراث)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

    TypeScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].
  • برمی گرداند
    string[]
    مجموعه کلیدهای هدفمند. سفارش تعریف نشده است.

set

  • set(key: string, value: string): Slot

  • مقداری را برای یک ویژگی AdSense در این شکاف AD تعیین می کند. با این کار مقادیر تعیین شده در سطح سرویس برای این کلید غلبه می کند.

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

  • مثال

    جاوا اسکریپت

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

    جاوا اسکریپت (میراث)

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

    TypeScript

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
    همچنین ببینید
  • مولفه های
    key: string
    نامی از مشخصات.
    value: string
    ارزش صفت.
  • برمی گرداند
    Slot
    شیء شکاف که در آن روش خوانده شده است.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): Slot

  • برچسب محرومیت دسته AD سطح آگهی را در این شکاف تنظیم می کند.

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

    // Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());
    همچنین ببینید
  • مولفه های
    categoryExclusion: string
    برچسب محرومیت دسته AD برای افزودن.
  • برمی گرداند
    Slot
    شیء شکاف که در آن روش خوانده شده است.

setClickUrl

  • setClickUrl(value: string): Slot

  • URL کلیک را تنظیم می کند که کاربران پس از کلیک بر روی آگهی هدایت می شوند.

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

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

setCollapseEmptyDiv

  • setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

  • تنظیم می کند که آیا div شکاف باید در صورت عدم وجود تبلیغ در شکاف پنهان شود. این تنظیمات سطح خدمات را نادیده می گیرد.

  • مثال

    جاوا اسکریپت

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

    جاوا اسکریپت (میراث)

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

    TypeScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.
    همچنین ببینید
  • مولفه های
    collapse: boolean
    در صورت بازگشت هیچ آگهی ، شکاف را فرو می ریزید.
    collapseBeforeAdFetch?: boolean
    این که آیا حتی قبل از اینکه یک آگهی انجام شود ، شکاف را فرو می ریزد. اگر فروپاشی true نیست ، نادیده گرفته می شود.
  • برمی گرداند
    Slot
    شیء شکاف که در آن روش خوانده شده است.

setConfig

  • setConfig(slotConfig: SlotSettingsConfig ): void

  • گزینه های پیکربندی عمومی را برای این شکاف تنظیم می کند.

  • مولفه های
    slotConfig: SlotSettingsConfig
    شیء پیکربندی.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): Slot

  • پیکربندی می کند که آیا تبلیغات در این شکاف باید با استفاده از یک ظرف SafeFrame مجبور به ارائه شود.

    لطفاً هنگام استفاده از این API موارد زیر را در ذهن داشته باشید:

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

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

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

    TypeScript

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

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig ): Slot

  • تنظیمات سطح شکاف را برای پیکربندی SafeFrame تنظیم می کند. هرگونه کلیدهای ناشناخته در شیء پیکربندی نادیده گرفته می شود. اگر یک مقدار نامعتبر برای یک کلید شناخته شده منتقل شود ، کل پیکربندی نادیده گرفته می شود.

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

  • مثال

    جاوا اسکریپت

    googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    جاوا اسکریپت (میراث)

    googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

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

setTargeting

  • setTargeting(key: string, value: string | string[]): Slot

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

  • مثال

    جاوا اسکریپت

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

    جاوا اسکریپت (میراث)

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

    TypeScript

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

updateTargetingFromMap

  • updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot

  • پارامترهای هدفمند سفارشی را برای این شکاف ، از یک کلید: نقشه Value در یک شیء JSON تنظیم می کند. این همان فراخوانی Slot.setTargeting برای تمام مقادیر کلیدی شی است. این کلیدها در حساب Google Ad Manager شما تعریف شده اند.

    یادداشت:

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

  • مثال

    جاوا اسکریپت

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

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

    جاوا اسکریپت (میراث)

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

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

    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

تنظیمات برای کنترل گسترش تبلیغ.

خلاصه اموال
enabled
آیا گسترش تبلیغات فعال است یا غیرفعال است.
مثال

جاوا اسکریپت

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

جاوا اسکریپت (میراث)

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

TypeScript

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

enabled

googletag config . ComponentAuctionConfig

یک شیء که یک حراج مؤلفه واحد را در یک حراج تبلیغ در دستگاه ارائه می دهد.

خلاصه اموال
auctionConfig
یک شی پیکربندی حراج برای این حراج مؤلفه.
configKey
کلید پیکربندی مرتبط با این حراج مؤلفه.
همچنین ببینید

auctionConfig

  • auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }

  • یک شی پیکربندی حراج برای این حراج مؤلفه.

    اگر این مقدار null تنظیم شود ، هر پیکربندی موجود برای configKey مشخص حذف می شود.

  • مثال

    جاوا اسکریپت

    const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

    جاوا اسکریپت (میراث)

    var componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

    TypeScript

    const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});
    همچنین ببینید

configKey

  • configKey: string

  • کلید پیکربندی مرتبط با این حراج مؤلفه.

    این مقدار باید غیر خالی باشد و باید بی نظیر باشد. اگر دو اشیاء ComponentAuctionConfig همان مقدار کلید پیکربندی را به اشتراک بگذارند ، آخرین مورد تنظیم شده ، تنظیمات قبلی را بازنویسی می کند.

googletag config . InterstitialConfig

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

خلاصه اموال
triggers
پیکربندی ماشه بینابینی برای این تبلیغ بینابینی.

triggers

  • triggers: Partial<Record< InterstitialTrigger , boolean>>

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

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

  • مثال

    جاوا اسکریپت

    // Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

    جاوا اسکریپت (میراث)

    // Define a GPT managed web interstitial ad slot.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
var enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

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

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

اجازه می دهد تا چندین ویژگی را با یک تماس API تنظیم کنید.

کلیه خصوصیات ذکر شده در زیر نمونه هایی هستند و ویژگی های واقعی استفاده از SetConfig را منعکس نمی کنند. برای مجموعه ویژگی ها ، قسمتهای موجود در نوع PagesettingsConfig را در زیر مشاهده کنید.

مثال ها:

  • فقط ویژگی های مشخص شده در تماس setConfig اصلاح شده است. 
      // Configure feature alpha.
  googletag.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });
  • تمام تنظیمات برای یک ویژگی معین با هر تماس برای 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
تنظیمات برای کنترل گسترش تبلیغ.
pps
تنظیمات برای کنترل ناشر سیگنال ها (PPS) را ارائه داد.
privacyTreatments
تنظیمات برای کنترل درمان های حریم خصوصی ناشر.

adExpansion

  • adExpansion: null | AdExpansionConfig

  • تنظیمات برای کنترل گسترش تبلیغ.

pps

privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig

  • تنظیمات برای کنترل درمان های حریم خصوصی ناشر.

googletag config . PrivacyTreatmentsConfig

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

خلاصه اموال
treatments
مجموعه ای از درمان های حریم خصوصی ناشر برای فعال کردن.

treatments

  • treatments: "disablePersonalization"[]

  • مجموعه ای از درمان های حریم خصوصی ناشر برای فعال کردن.

  • مثال

    جاوا اسکریپت

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

    جاوا اسکریپت (میراث)

    // 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
یک شیء حاوی نقشه های طبقه بندی .
مثال

جاوا اسکریپت

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

جاوا اسکریپت (میراث)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '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 | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
همچنین ببینید

taxonomies

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
تنظیمات برای کنترل گسترش تبلیغ.
componentAuction
مجموعه ای از حراج های مؤلفه که در حراج تبلیغاتی در دستگاه قرار می گیرند.
interstitial
تنظیماتی که رفتار شکاف AD را کنترل می کنند.

adExpansion

  • adExpansion: AdExpansionConfig

  • تنظیمات برای کنترل گسترش تبلیغ.

componentAuction

  • componentAuction: ComponentAuctionConfig []

  • مجموعه ای از حراج های مؤلفه که در حراج تبلیغاتی در دستگاه قرار می گیرند.

interstitial

  • interstitial: InterstitialConfig

  • تنظیماتی که رفتار شکاف AD را کنترل می کنند.

googletag config . TaxonomyData

یک شیء حاوی مقادیر برای یک طبقه بندی واحد.

خلاصه اموال
values
لیستی از ارزشهای طبقه بندی .

values

googletag events . Event

رابط پایه برای همه رویدادهای GPT. تمام رویدادهای GPT در زیر زمینه های زیر را دارند.

خلاصه اموال
serviceName
نام خدماتی که باعث ایجاد این رویداد شد.
slot
شکافی که باعث ایجاد این رویداد شد.
همچنین ببینید

serviceName

  • serviceName: string

  • نام خدماتی که باعث ایجاد این رویداد شد.

slot

  • slot: Slot

  • شکافی که باعث ایجاد این رویداد شد.

googletag events . EventTypeMap

این یک نوع شبه است که یک نام رویداد را به نوع شیء رویداد مربوطه برای Service.addEventListener و Service.removeEventListener ترسیم می کند. این فقط برای اهداف مرجع و نوع ایمنی ثبت شده است.

خلاصه اموال
impressionViewable
rewardedSlotClosed
نام مستعار برای events.RewardedSlotClosedEvent .
rewardedSlotGranted
نام مستعار برای events.RewardedSlotGrantedEvent .
rewardedSlotReady
نام مستعار برای events.RewardedSlotReadyEvent .
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
نام مستعار برای events.SlotResponseReceived .
slotVisibilityChanged
نام مستعار برای events.SlotVisibilityChangedEvent .

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

googletag events . ImpressionViewableEvent

Event می یابد

این رویداد با توجه به معیارهای دید فعال ، هنگامی که یک تصور قابل مشاهده باشد ، اخراج می شود.

خلاصه اموال
serviceName
نام خدماتی که باعث ایجاد این رویداد شد.
slot
شکافی که باعث ایجاد این رویداد شد.
مثال

جاوا اسکریپت

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

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

جاوا اسکریپت (میراث)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

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

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
شکافی که باعث ایجاد این رویداد شد.
مثال

جاوا اسکریپت

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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.
  }
});

جاوا اسکریپت (میراث)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

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

TypeScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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
شکافی که باعث ایجاد این رویداد شد.
مثال

جاوا اسکریپت

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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.
  }
});

جاوا اسکریپت (میراث)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
  var _a, _b;
  var slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
  console.log(
    "Reward amount:",
    (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount
  );
  console.groupEnd();

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

TypeScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

  • payload: null | RewardedPayload

  • یک شیء حاوی اطلاعاتی در مورد پاداش اعطا شده است.

googletag events . RewardedSlotReadyEvent

Event می یابد

این رویداد هنگامی اخراج می شود که یک تبلیغ پاداش آماده نمایش باشد. ناشر وظیفه دارد قبل از نمایش آن گزینه ای را برای مشاهده آگهی به کاربر ارائه دهد.

خلاصه اموال
serviceName
نام خدماتی که باعث ایجاد این رویداد شد.
slot
شکافی که باعث ایجاد این رویداد شد.
خلاصه روش
makeRewardedVisible
تبلیغ پاداش را نشان می دهد.
مثال

جاوا اسکریپت

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  const userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

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

جاوا اسکریپت (میراث)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  var userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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(): void

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

googletag events . SlotOnloadEvent

Event می یابد

این رویداد هنگامی اخراج می شود که Iframe Creative رویداد بار خود را شلیک کند. هنگام ارائه تبلیغات رسانه ای غنی در حالت ارائه همگام سازی ، از Iframe استفاده نمی شود تا هیچ SlotOnloadEvent اخراج شود.

خلاصه اموال
serviceName
نام خدماتی که باعث ایجاد این رویداد شد.
slot
شکافی که باعث ایجاد این رویداد شد.
مثال

جاوا اسکریپت

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

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

جاوا اسکریپت (میراث)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

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

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
شناسه مورد خط آگهی رزرواسیون ارائه شده.
serviceName
نام خدماتی که باعث ایجاد این رویداد شد.
size
اندازه پیکسل خلاق ارائه شده را نشان می دهد.
slot
شکافی که باعث ایجاد این رویداد شد.
slotContentChanged
آیا محتوای شکاف با تبلیغ ارائه شده تغییر کرده است.
sourceAgnosticCreativeId
شناسه خلاقانه رزرو یا تبلیغات برگشتی.
sourceAgnosticLineItemId
شناسه آیتم خط از رزرو یا تبلیغات برگشتی.
yieldGroupIds
شناسه گروههای بازده برای تبلیغات برگشتی ارائه شده.
مثال

جاوا اسکریپت

// 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("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

جاوا اسکریپت (میراث)

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  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("Label IDs:", event.labelIds);
  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: null | number

  • آگهی تبلیغاتی آگهی ارائه شده. مقدار برای شکافهای خالی ، تبلیغات برگشتی و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

campaignId

  • campaignId: null | number

  • شناسه تبلیغاتی تبلیغات ارائه شده. مقدار برای شکافهای خالی ، تبلیغات برگشتی و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

companyIds

  • companyIds: null | number[]

  • شناسه شرکتهایی که در تبلیغات پشتیبان ارائه شده پیشنهاد می کنند. ارزش برای شکافهای خالی ، تبلیغات رزرو و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

creativeId

  • creativeId: null | number

  • شناسه خلاق آگهی رزرواسیون ارائه شده. مقدار برای شکافهای خالی ، تبلیغات برگشتی و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

creativeTemplateId

  • creativeTemplateId: null | number

  • شناسه الگوی خلاق آگهی رزرواسیون ارائه شده. مقدار برای شکافهای خالی ، تبلیغات برگشتی و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

isBackfill

  • isBackfill: boolean

  • این که آیا یک آگهی تبلیغاتی بود. اگر آگهی یک تبلیغ پشتی بود ، در false این صورت ، مقدار true است.

isEmpty

  • isEmpty: boolean

  • آیا یک تبلیغ برای شکاف بازگردانده شده است. اگر هیچ AD بازگردانده نشده باشد ، در false این صورت مقدار true است.

labelIds

  • labelIds: null | number[]

  • شناسه های برچسب تبلیغات ارائه شده. مقدار برای شکافهای خالی ، تبلیغات برگشتی و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

lineItemId

  • lineItemId: null | number

  • شناسه مورد خط آگهی رزرواسیون ارائه شده. مقدار برای شکافهای خالی ، تبلیغات برگشتی و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

size

  • size: null | string | number[]

  • اندازه پیکسل خلاق ارائه شده را نشان می دهد. مثال: [728, 90] . مقدار برای شکافهای تبلیغاتی null است.

slotContentChanged

  • slotContentChanged: boolean

  • آیا محتوای شکاف با تبلیغ ارائه شده تغییر کرده است. در صورت تغییر محتوا ، مقدار true است ، در غیر این صورت false .

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

  • شناسه خلاقانه رزرو یا تبلیغات برگشتی. اگر آگهی یک رزرو یا خط برگه خطی نباشد ، یا خلاقیت توسط خدمات غیر از PubAdsService ارائه می شود ، مقدار null است.

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

  • شناسه آیتم خط از رزرو یا تبلیغات برگشتی. اگر آگهی یک رزرو یا خط برگه خطی نباشد ، یا خلاقیت توسط خدمات غیر از PubAdsService ارائه می شود ، مقدار null است.

yieldGroupIds

  • yieldGroupIds: null | number[]

  • شناسه گروههای بازده برای تبلیغات برگشتی ارائه شده. ارزش برای شکافهای خالی ، تبلیغات رزرو و خلاقانی که توسط خدمات غیر از PubAdsService ارائه می شوند null است.

googletag events . SlotRequestedEvent

Event می یابد

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

خلاصه اموال
serviceName
نام خدماتی که باعث ایجاد این رویداد شد.
slot
شکافی که باعث ایجاد این رویداد شد.
مثال

جاوا اسکریپت

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

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

جاوا اسکریپت (میراث)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

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

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
شکافی که باعث ایجاد این رویداد شد.
مثال

جاوا اسکریپت

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

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

جاوا اسکریپت (میراث)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

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

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 می یابد

این رویداد هر زمان که درصد روی صفحه نمایش از منطقه یک آگهی تغییر می کند ، اخراج می شود. این رویداد مورد فشار قرار می گیرد و بیشتر از هر یک بار در هر 200 متر آتش نمی گیرد.

خلاصه اموال
inViewPercentage
درصد منطقه AD قابل مشاهده است.
serviceName
نام خدماتی که باعث ایجاد این رویداد شد.
slot
شکافی که باعث ایجاد این رویداد شد.
مثال

جاوا اسکریپت

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

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

جاوا اسکریپت (میراث)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

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

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

  • درصد منطقه AD قابل مشاهده است. مقدار بین 0 تا 100 است.

googletag secureSignals . BidderSignalProvider

یک سیگنال امن را برای یک پیشنهاد دهنده خاص برمی گرداند.

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

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

خلاصه اموال
collectorFunction
.
id
یک شناسه منحصر به فرد برای جمع کننده مرتبط با این سیگنال امن ، همانطور که در Google AD Manager ثبت شده است.
مثال

جاوا اسکریپت

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

جاوا اسکریپت (میراث)

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

TypeScript

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

collectorFunction

  • collectorFunction: () => Promise<string>

id

  • id: string

  • یک شناسه منحصر به فرد برای جمع کننده مرتبط با این سیگنال امن ، همانطور که در Google AD Manager ثبت شده است.

googletag secureSignals . PublisherSignalProvider

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

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

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

خلاصه اموال
collectorFunction
.
networkCode
کد شبکه (همانطور که در مسیر واحد تبلیغ مشاهده می شود) برای ناشر مرتبط با این سیگنال امن.
مثال

جاوا اسکریپت

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

جاوا اسکریپت (میراث)

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

TypeScript

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

collectorFunction

  • collectorFunction: () => Promise<string>

networkCode

  • networkCode: string

  • کد شبکه (همانطور که در مسیر واحد تبلیغ مشاهده می شود) برای ناشر مرتبط با این سیگنال امن.

googletag secureSignals . SecureSignalProvidersArray

رابط برای مدیریت سیگنال های امن.

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

clearAllCache

  • clearAllCache(): void

  • تمام سیگنال های ذخیره شده را از ذخیره محلی پاک می کند.

push