חומרי עזר של GPT

במסמך הזה נעשה שימוש בסימון של TypeScript כדי לתאר סוגים. בטבלה הבאה מופיעות דוגמאות עם הסברים קצרים.

הקלדת ביטוי
string סוג המחרוזת הפרימיטיבית.
string[] סוג מערך, שבו הערכים יכולים להיות רק מחרוזות.
number | string סוג איחוד, שבו הערך יכול להיות מספר או מחרוזת.
Array<number | string> סוג מערך, שבו הערכים הם סוג מורכב (איחוד).
[number, string] סוג של tuple, שבו הערך הוא מערך עם שני רכיבים שחייבים להכיל מספר ומחרוזת, בסדר הזה.
Slot סוג אובייקט, שבו הערך הוא מופע של googletag.Slot.
() => void סוג פונקציה ללא ארגומנטים מוגדרים וללא ערך החזרה.

מידע נוסף על סוגים נתמכים וביטויי סוגים זמין ב מדריך TypeScript .

הוספת הערות על סוגים

נקודתיים אחרי משתנה, שם פרמטר, שם נכס או חתימת פונקציה מציינות הערת טיפוס. הערות לגבי סוגים מתארות את הסוגים שהרכיב משמאל לנקודתיים יכול לקבל או להחזיר. בטבלה הבאה מוצגות דוגמאות להערות על סוגים שאולי תראו במאמר הזה.

הערת טיפוס
param: string מציין שהפונקציה param מקבלת או מחזירה ערך מחרוזת. התחביר הזה משמש למשתנים, לפרמטרים, למאפיינים ולסוגי ערכים מוחזרים.
param?: number | string הסימון param מציין שהפרמטר אופציונלי, אבל אם מציינים אותו הוא יכול להיות מספר או מחרוזת. התחביר הזה משמש לפרמטרים ולמאפיינים.
...params: Array<() => void> מציין ש-params הוא פרמטר rest שמקבל פונקציות. פרמטרים מסוג rest מקבלים מספר בלתי מוגבל של ערכים מהסוג שצוין.

googletag

מרחב השמות הגלובלי ש-Google Publisher Tag משתמש בו עבור ה-API שלו.
מרחבי שמות
config
ממשק ההגדרות הראשי להגדרות ברמת הדף.
enums
זהו מרחב השמות שבו GPT משתמש לסוגי enum.
events
זהו מרחב השמות שבו GPT משתמש לאירועים.
secureSignals
זהו מרחב השמות שבו GPT משתמש לניהול אותות מאובטחים.
ממשקים
CommandArray
מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר.
CompanionAdsService
שירות המודעות הנלוות.
PrivacySettingsConfig
אובייקט הגדרות הפרטיות.
PubAdsService
שירות המודעות בתכנים של בעלי תוכן דיגיטלי.
ResponseInformation
אובייקט שמייצג תגובה יחידה לבקשה להצגת מודעה.
RewardedPayload
אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת.
Service
מחלקת שירות בסיסית שמכילה methods שמשותפים לכל השירותים.
SizeMappingBuilder
כלי ליצירת אובייקטים של מיפוי גדלים.
Slot
Slot הוא אובייקט שמייצג משבצת פרסום יחידה בדף.
סוג כינויים
FluidSize
מחרוזת הגודל שבה מאגר המודעות תופס 100% מהרוחב של תג ה-div של האב, ואז משנה את הגובה שלו כך שיתאים לתוכן הקריאייטיב.
GeneralSize
הגדרת גודל תקינה של משבצת, שיכולה להיות גודל אחד או כמה גדלים.
MultiSize
רשימה של גדלים תקינים.
NamedSize
גדלים בעלי שם שיכולים להיות במשבצת.
SingleSize
גודל תקין יחיד של משבצת.
SingleSizeArray
מערך של שני מספרים שמייצגים [רוחב, גובה].
SizeMapping
מיפוי של גודל אזור התצוגה לגדלי מודעות.
SizeMappingArray
רשימה של מיפויים של גדלים.
משתנים
apiReady
דגל שמציין שה-GPT API נטען ומוכן להפעלה.
cmd
הפניה לתור הפקודות הגלובלי לביצוע אסינכרוני של קריאות שקשורות ל-GPT.
pubadsReady
סימון שמציין ש-PubAdsService מופעל, נטען ופועל באופן מלא.
secureSignalProviders
הפניה למערך ספקי האותות המאובטחים.
פונקציות
companionAds
מחזירה הפניה אל CompanionAdsService.
defineOutOfPageSlot
יוצר משבצת מודעה מחוץ לדף עם הנתיב שצוין ליחידת המודעות.
defineSlot
יוצרת מיקום למודעה עם נתיב וגודל נתונים של יחידת מודעות, ומשייכת אותו למזהה של רכיב div בדף שיכיל את המודעה.
destroySlots
הפונקציה הזו משמידה את המשבצות שצוינו, ומסירה מ-GPT את כל האובייקטים וההפניות שקשורים למשבצות האלה.
disablePublisherConsole
משבית את Google Publisher Console.
display
הוראה לשירותי המשבצות לעבד את המשבצת.
enableServices
ההגדרה הזו מאפשרת להפעיל את כל שירותי GPT שהוגדרו עבור מיקומי מודעות בדף.
getConfig
מקבל אפשרויות הגדרה כלליות לדף שהוגדרו באמצעות setConfig.
getVersion
הפונקציה מחזירה את הגרסה הנוכחית של GPT.
openConsole
ייפתח Google Publisher Console.
pubads
מחזירה הפניה אל PubAdsService.
setAdIframeTitle
הפרמטר הזה מגדיר את הכותרת לכל ה-iframe של מאגרי המודעות שנוצרו על ידי PubAdsService, החל מנקודה זו ואילך.
setConfig
הגדרת אפשרויות כלליות של תצורה לדף.
sizeMapping
יוצרת אובייקט SizeMappingBuilder חדש.

סוג כינויים

FluidSize

FluidSize: "fluid"
מחרוזת הגודל שבה מאגר המודעות תופס 100% מהרוחב של תג ה-div של האב, ואז משנה את הגובה שלו כך שיתאים לתוכן הקריאייטיב. בדומה להתנהגות של רכיבי בלוק רגילים בדף. הפרמטר הזה משמש למודעות מותאמות (ראו מאמר שקשור לנושא).

GeneralSize

GeneralSize: SingleSize | MultiSize
הגדרת גודל תקינה של משבצת, שיכולה להיות גודל אחד או כמה גדלים.

MultiSize

MultiSize: SingleSize[]
רשימה של גדלים תקינים.

NamedSize

NamedSize: FluidSize | [FluidSize]
גדלים בעלי שם שיכולים להיות במשבצת. ברוב המקרים, הגודל הוא מלבן בגודל קבוע, אבל יש מקרים שבהם אנחנו צריכים סוגים אחרים של הגדרות גודל. אלה המידות עם השמות התקינים:
  • ‫fluid: הגורם המכיל של המודעה תופס 100% מהרוחב של תג ה-div של האב, ואז משנה את הגובה שלו כך שיתאים לתוכן הקריאייטיב. בדומה להתנהגות של רכיבי בלוק רגילים בדף. הפרמטר הזה משמש למודעות מותאמות (ראו מאמר שקשור לנושא). שימו לב שגם fluid וגם ['fluid'] הן צורות מקובלות להצהרה על גודל משתנה של משבצת.

SingleSize

גודל תקין יחיד של משבצת.

SingleSizeArray

SingleSizeArray: [number, number]
מערך של שני מספרים שמייצגים [רוחב, גובה].

SizeMapping

מיפוי של גודל אזור התצוגה לגדלי מודעות. העמודה הזו מיועדת למודעות רספונסיביות.

SizeMappingArray

SizeMappingArray: SizeMapping[]
רשימה של מיפויי גדלים.

משתנים

Const apiReady

apiReady: boolean | undefined
דגל שמציין שה-GPT API נטען ומוכן להפעלה. הערך של המאפיין הזה יהיה פשוט undefined עד שה-API יהיה מוכן.

הערה: הדרך המומלצת לטפל בפעולות אסינכרוניות היא להשתמש ב-googletag.cmd כדי להוסיף פונקציות קריאה חוזרת לתור, כך שהן יופעלו כש-GPT יהיה מוכן. אין צורך לבדוק את googletag.apiReady בפונקציות הקריאה החוזרת האלה, כי מובטח שהן יופעלו אחרי שמגדירים את ה-API.

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray
הפניה לתור הפקודות הגלובליות לביצוע אסינכרוני של קריאות שקשורות ל-GPT.

המשתנה googletag.cmd מאותחל למערך JavaScript ריק על ידי תחביר תג GPT בדף, ו-cmd.push היא השיטה הרגילה Array.push שמוסיפה רכיב לסוף המערך. כשקוד ה-JavaScript של GPT נטען, הוא סורק את המערך ומריץ את כל הפונקציות לפי הסדר. לאחר מכן הסקריפט מחליף את cmd באובייקט CommandArray שהמתודה push שלו מוגדרת להפעלה של ארגומנט הפונקציה שמועבר אליו. המנגנון הזה מאפשר ל-GPT לקצר את זמן האחזור הנתפס על ידי אחזור ה-JavaScript באופן אסינכרוני, תוך מתן אפשרות לדפדפן להמשיך לעבד את הדף.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

Const pubadsReady

pubadsReady: boolean | undefined
סימון שמציין ש-PubAdsService מופעל, נטען ופועל באופן מלא. הערך של המאפיין הזה יהיה פשוט undefined עד להפעלת הפונקציה enableServices, ועד שהשירות PubAdsService ייטען ויאותחל.

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
הפניה למערך ספקי האותות המאובטחים.

מערך ספקי האותות המאובטחים מקבל רצף של פונקציות ליצירת אותות ומפעיל אותן לפי הסדר. היא נועדה להחליף מערך רגיל שמשמש להוספה לתור של פונקציות ליצירת אותות, שיופעלו אחרי שטעינת GPT תושלם.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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");
  },
});
ראה גם

פונקציות

companionAds

companionAds(): CompanionAdsService
מחזירה הפניה אל CompanionAdsService.
החזרות
CompanionAdsServiceשירות המודעות הנלוות.

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
יוצר משבצת מודעה מחוץ לדף עם הנתיב שצוין ליחידת המודעות.

במקרה של מודעות מותאמות אישית מחוץ לדף, div הוא המזהה של רכיב ה-div שיכיל את המודעה. פרטים נוספים זמינים במאמר בנושא נכסי קריאייטיב מחוץ לדף.

במודעות מחוץ לדף שמנוהלות על ידי GPT, ‏ div הוא OutOfPageFormat נתמך.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
ראה גם
פרמטרים
adUnitPath: stringהנתיב המלא של יחידת המודעות עם קוד הרשת וקוד יחידת המודעות.
Optional div: string | OutOfPageFormatהמזהה של רכיב ה-div שיכיל את יחידת המודעות הזו או את OutOfPageFormat.
החזרות
Slot | nullהמשבצת החדשה שנוצרה, או null אם אי אפשר ליצור משבצת.

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
יוצרת מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות, ומשייכת אותו למזהה של רכיב div בדף שיכיל את המודעה.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
ראה גם
פרמטרים
adUnitPath: stringהנתיב המלא של יחידת המודעות עם קוד הרשת וקוד היחידה.
size: GeneralSizeהרוחב והגובה של מיקום המודעה שנוסף. זה הגודל שמשמש בבקשה להצגת מודעה אם לא מסופק מיפוי של גדלים רספונסיביים, או אם גודל אזור התצוגה קטן מהגודל הקטן ביותר שמופיע במיפוי.
Optional div: stringהמזהה של תג ה-div שיכיל את יחידת המודעות הזו.
החזרות
Slot | nullהמשבצת החדשה שנוצרה, או null אם אי אפשר ליצור משבצת.

destroySlots

destroySlots(slots?: Slot[]): boolean
הפונקציה הזו משמידה את המשבצות שצוינו, ומסירה מ-GPT את כל האובייקטים וההפניות שקשורים למשבצות האלה. ה-API הזה לא תומך במשבצות passback ובמשבצות companion.

קריאה ל-API הזה במשבצת מנקה את המודעה ומסירה את אובייקט המשבצת מהמצב הפנימי שמתנהל על ידי GPT. הפעלה של פונקציות נוספות באובייקט של משבצת המודעה תגרום להתנהגות לא מוגדרת. הערה: יכול להיות שהדפדפן עדיין לא ישחרר את הזיכרון שמשויך למשבצת הזו אם דף בעל האתר שומר הפניה אליה. הפעלת ה-API הזה מאפשרת שימוש חוזר ב-div שמשויך למיקום הזה.

בפרט, השמדה של מיקום מודעה מסירה את המודעה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות של מודעות מתחרות שקשורות למודעה הזו. אם לא תתבצע קריאה לפונקציה הזו לפני הסרת ה-div של משבצת מודעה מהדף, יתרחשו התנהגויות לא מוגדרות.
דוגמה

JavaScript

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

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

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

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

‫JavaScript (גרסה קודמת)

// 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();
פרמטרים
Optional slots: Slot[]מערך המשבצות שיוסר מהלוח. מערך הוא אופציונלי; אם לא מציינים מערך, כל המשבצות יושמדו.
החזרות
boolean‫true אם משבצות הפרסום נהרסו, false אחרת.

disablePublisherConsole

disablePublisherConsole(): void
משבית את Google Publisher Console.
ראה גם

תצוגה

display(divOrSlot: string | Element | Slot): void
הוראה לשירותי המשבצות לעבד את המשבצת. כל משבצת מודעות צריכה להופיע רק פעם אחת בכל דף. כדי שמשבצות יופיעו, צריך להגדיר את כולן ולשייך לכל אחת מהן שירות. אסור שהקריאה להצגה תתבצע לפני שהרכיב מופיע ב-DOM. הדרך הרגילה לעשות זאת היא להציב אותו בתוך בלוק סקריפט בתוך רכיב ה-div שצוין בקריאה לשיטה.

אם נעשה שימוש בארכיטקטורת בקשה יחידה (SRA), כל משבצות המודעות שלא אוחזרו בזמן הקריאה לשיטה הזו יאוחזרו בבת אחת. כדי לכפות על משבצת מודעה לא להציג מודעה, צריך להסיר את כל התג div.
ראה גם
פרמטרים
divOrSlot: string | Element | Slotהמזהה של רכיב ה-div שמכיל את מיקום המודעה או את רכיב ה-div, או את אובייקט מיקום המודעה. אם מסופק רכיב div, הוא חייב לכלול מאפיין id שתואם למזהה שמועבר אל defineSlot.

enableServices

enableServices(): void
ההגדרה הזו מאפשרת להפעיל את כל שירותי GPT שהוגדרו עבור מיקומי מודעות בדף.

getConfig

getConfig(keys: string | string[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">
מקבל את אפשרויות ההגדרה הכלליות של הדף שהוגדרו על ידי setConfig.

השיטה הזו לא תומכת בכל המאפיינים של setConfig(). המאפיינים הנתמכים הם:
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
פרמטרים
keys: string | string[]המפתחות של אפשרויות ההגדרה שרוצים לקבל.
החזרות
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">אפשרויות ההגדרה של משבצת המודעה.

getVersion

getVersion(): string
מחזירה את הגרסה הנוכחית של GPT.
ראה גם
החזרות
stringמחרוזת גרסת ה-GPT שמופעלת כרגע.

openConsole

openConsole(div?: string): void
פותח את Google Publisher Console.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

// Calling without div ID.
googletag.openConsole();
ראה גם
פרמטרים
Optional div: stringמזהה של תג div של מיקום מודעה. הערך הזה הוא אופציונלי. אם מספקים את הפרמטר הזה, מערכת Publisher Console תנסה להיפתח עם פרטים של מיקום המודעה שצוין.

pubads

pubads(): PubAdsService
מחזירה הפניה אל PubAdsService.
החזרות
PubAdsServiceשירות המודעות בתכנים של בעלי תוכן דיגיטלי.

setAdIframeTitle

setAdIframeTitle(title: string): void
הפונקציה מגדירה את הכותרת לכל ה-iframes של מאגרי המודעות שנוצרו על ידי PubAdsService, החל מנקודה זו ואילך.
דוגמה

JavaScript

googletag.setAdIframeTitle("title");

‫JavaScript (גרסה קודמת)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");
פרמטרים
title: stringהכותרת החדשה של כל מסגרות ה-iframe של מאגרי התגים של המודעות.

setConfig

setConfig(config: PageSettingsConfig): void
הגדרת אפשרויות כלליות של תצורה לדף.
פרמטרים
config: PageSettingsConfig

sizeMapping

sizeMapping(): SizeMappingBuilder
יוצר SizeMappingBuilder חדש.
ראה גם
החזרות
SizeMappingBuilderכלי בנייה חדש.

googletag.CommandArray

מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר. היא נועדה להחליף מערך רגיל שמשמש להוספת פונקציות לתור כדי להפעיל אותן אחרי שטעינת GPT מסתיימת.
Methods
push
מבצעת את רצף הפונקציות שצוין בארגומנטים לפי הסדר.

Methods

push

push(...f: ((this: typeof globalThis) => void)[]): number
מבצעת את רצף הפונקציות שצוין בארגומנטים לפי הסדר.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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());
});
פרמטרים
Rest ...f: ((this: typeof globalThis) => void)[]פונקציית JavaScript להרצה. הקישור בזמן הריצה תמיד יהיה globalThis. מומלץ להעביר פונקציית חץ כדי לשמור על הערך this של ההקשר הלקסיקלי המצורף.
החזרות
numberמספר הפקודות שעובדו עד עכשיו. הערך הזה תואם לערך ההחזרה של Array.push (האורך הנוכחי של המערך).

googletag.CompanionAdsService

הארכה Service
שירות המודעות הנלוות. השירות הזה משמש מודעות וידאו להצגת מודעות נלוות.
Methods
addEventListener
הפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף.
getSlots
אחזור רשימת המשבצות שמשויכות לשירות הזה.
removeEventListener
הסרה של מעבד אירוע שנרשם קודם.
setRefreshUnfilledSlots
ההגדרה קובעת אם משבצות של מודעות נלוות שלא מולאו ימולאו אוטומטית.
ראה גם

Methods

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void
השיטה הזו מגדירה אם משבצות של מודעות משלימות שלא מולאו ימולאו אוטומטית.

אפשר להפעיל את השיטה הזו כמה פעמים במהלך חיי הדף כדי להפעיל או להשבית את המילוי החוזר. רק משבצות שרשומות גם ב-PubAdsService ימולאו מחדש. עקב הגבלות מדיניות, השיטה הזו לא מיועדת למילוי משבצות ריקות של מודעות נלוות כשמוצגת מודעת וידאו ב-Ad Exchange.
דוגמה

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

‫JavaScript (גרסה קודמת)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);
פרמטרים
value: boolean‫true כדי למלא אוטומטית משבצות זמן שלא נבחרו, false כדי להשאיר אותן ללא שינוי.

googletag.PrivacySettingsConfig

אובייקט הגדרות הפרטיות.
מאפיינים
childDirectedTreatment?
מציין אם הדף צריך להיות מסווג כתוכן שמיועד לילדים.
limitedAds?
ההגדרה הזו מאפשרת להציג מודעות במצב מודעות מוגבלות כדי לעזור לבעלי תוכן דיגיטלי לעמוד בדרישות הרגולטוריות.
nonPersonalizedAds?
ההגדרה מאפשרת להציג מודעות במצב מודעות ללא התאמה אישית כדי לעזור לבעלי האתרים לעמוד בדרישות הרגולטוריות.
restrictDataProcessing?
ההגדרה הזו מאפשרת להציג מודעות במצב עיבוד מוגבל כדי לעזור לבעלי תוכן דיגיטלי לעמוד בדרישות הרגולטוריות.
trafficSource?
השדה מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית.
underAgeOfConsent?
מציין אם לסמן בקשות להצגת מודעות כבקשות שמגיעות ממשתמשים מתחת לגיל ההסכמה.
ראה גם

מאפיינים

‫Optional childDirectedTreatment

childDirectedTreatment?: boolean
מציין אם הדף צריך להיות מסווג כתוכן שמיועד לילדים. מגדירים את הערך null כדי למחוק את ההגדרה.

Optional limitedAds

limitedAds?: boolean
ההגדרה הזו מאפשרת להציג מודעות במצב מודעות מוגבלות כדי לעזור לבעלי תוכן דיגיטלי לעמוד בדרישות הרגולטוריות.

יש שתי דרכים להגדיר ב-GPT בקשה להצגת מודעות מוגבלות:
  • באופן אוטומטי, באמצעות אות ממערכת לניהול הסכמה (CMP) של IAB TCF בגרסה 2.0.
  • באופן ידני, על ידי הגדרת הערך של השדה הזה כ-true.
אפשר להגדיר מודעות מוגבלות באופן ידני רק כש-GPT נטען מכתובת ה-URL של המודעות המוגבלות. ניסיון לשנות את ההגדרה הזו אחרי ש-GPT נטען מכתובת ה-URL הרגילה יגרום להצגת אזהרה ב-Publisher Console.

חשוב לזכור שלא צריך להפעיל מודעות מוגבלות באופן ידני כשמשתמשים בפלטפורמה לניהול הסכמה.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

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

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean
ההגדרה מאפשרת להציג מודעות במצב מודעות ללא התאמה אישית כדי לעזור לבעלי האתרים לעמוד בדרישות הרגולטוריות.

Optional restrictDataProcessing

restrictDataProcessing?: boolean
ההגדרה הזו מאפשרת להציג מודעות במצב עיבוד מוגבל כדי לעזור לבעלי תוכן דיגיטלי לעמוד בדרישות הרגולטוריות.

Optional trafficSource

trafficSource?: TrafficSource
השדה מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית. הערך הזה מאכלס את מאפיין מקור התנועה בדוחות של Ad Manager. אם לא מגדירים את הפרמטר הזה, מקור התנועה בדוחות יהיה undefined.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

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

‫Optional underAgeOfConsent

underAgeOfConsent?: boolean
מציין אם לסמן בקשות להצגת מודעות כבקשות שמגיעות ממשתמשים מתחת לגיל ההסכמה. מגדירים את הערך null כדי למחוק את ההגדרה.

googletag.PubAdsService

הארכה Service
שירות המודעות בתכנים של בעלי תוכן דיגיטלי. השירות הזה משמש לאחזור ולהצגה של מודעות מחשבון Google Ad Manager שלכם.
Methods
addEventListener
הפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע 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
הוצא משימוש. הגדרת פרמטרים מותאמים אישית לטירגוט של מודעות למפתח נתון, שיחולו על כל מיקומי המודעות בשירות Publisher Ads.
setVideoContent
הוצא משימוש. הגדרת פרטי תוכן הווידאו שיישלחו עם בקשות להצגת מודעות למטרות טירגוט והחרגת תוכן.
updateCorrelator
הפונקציה משנה את הקורלטור שנשלח עם בקשות להצגת מודעות, ובעצם מתחילה צפייה חדשה בדף.

Methods

ניקוי

clear(slots?: Slot[]): boolean
המודעות יוסרו מהמשבצות שצוינו ויוחלפו בתוכן ריק. המשבצות יסומנו כמשבצות שלא נשלפו.

בפרט, ניקוי משבצת מסיר את המודעה מהצגת הדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות של מודעות מתחרות שקשורות למודעה הזו.
דוגמה

JavaScript

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

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

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

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

‫JavaScript (גרסה קודמת)

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();
פרמטרים
Optional slots: Slot[]מערך המשבצות לניקוי. מערך הוא אופציונלי. אם לא מציינים מערך, כל המשבצות ינוקו.
החזרות
booleanהפונקציה מחזירה true אם המשבצות פונו, אחרת היא מחזירה false.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService
מנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. האפשרות הזו שימושית אם רוצים לרענן את מיקום המודעה.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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
מנקה פרמטרים מותאמים אישית של טירגוט למפתח ספציפי או לכל המפתחות.
דוגמה

JavaScript

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.

‫JavaScript (גרסה קודמת)

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.
ראה גם
פרמטרים
Optional key: stringמפתח פרמטר לטירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל פרמטרי הטירגוט ינוקו.
החזרות
PubAdsServiceאובייקט השירות שבו בוצעה הקריאה לשיטה.

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
ההגדרה הזו מאפשרת לכווץ את תגי ה-div של מיקומי המודעות כך שהם לא יתפסו מקום בדף כשאין תוכן מודעה להצגה. צריך להגדיר את המצב הזה לפני שמפעילים את השירות.
ראה גם
פרמטרים
Optional collapseBeforeAdFetch: booleanהאם לכווץ את משבצות המודעות עוד לפני שליפת המודעות. הפרמטר הזה הוא אופציונלי. אם לא תספקו ערך, המערכת תשתמש בערך ברירת המחדל false.
החזרות
booleanמחזירה true אם מצב הכיווץ של רכיב ה-div הופעל, ו-false אם אי אפשר להפעיל את מצב הכיווץ כי השיטה נקראה אחרי שהשירות הופעל.

disableInitialLoad

disableInitialLoad(): void
משבית את הבקשות להצגת מודעות במהלך טעינת הדף, אבל מאפשר לשלוח בקשות להצגת מודעות באמצעות קריאה ל-PubAdsService.refresh. צריך להגדיר את זה לפני שמפעילים את השירות. חובה להשתמש במצב אסינכרוני, אחרת לא ניתן יהיה לבקש מודעות באמצעות refresh.
ראה גם

תצוגה

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
הפונקציה יוצרת משבצת פרסום ומציגה אותה עם הנתיב והגודל של יחידת המודעות שצוינו.

הפונקציה הזו היא קיצור דרך ששווה לקריאה לפונקציה googletag.defineSlot ואחריה קריאה לפונקציה googletag.display.

ההתנהגות של הפונקציה הזו תלויה בהפעלה של ארכיטקטורת בקשה יחידה (SRA):
  • SRA מופעל: כל משבצות המודעות שהוגדרו עד לנקודה שבה מתבצעת הקריאה הזו יצורפו לבקשה אחת.
  • הגדרת SRA מושבתת (ברירת מחדל): הבקשה לשטח הפרסום תישלח בנפרד.
הערה: כשקוראים לשיטה הזו, נוצרת תמונת מצב של מצב המשבצת והדף כדי להבטיח עקביות כששולחים את הבקשה למודעה ומעבדים את התגובה. כל שינוי שמתבצע במצב של משבצת או דף אחרי הקריאה לשיטה הזו (כולל טירגוט, הגדרות פרטיות, הפעלה של SafeFrame וכו') יחול רק על בקשות עתידיות של display() או refresh().
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
ראה גם
פרמטרים
adUnitPath: stringנתיב יחידת המודעות של מיקום המודעה שיוצג.
size: GeneralSizeהרוחב והגובה של משבצת המודעה.
Optional div: string | Elementהמזהה של תג ה-div שמכיל את מיקום המודעה או את רכיב ה-div עצמו.
Optional clickUrl: stringכתובת ה-URL של הקליק לשימוש במשבצת הזו.

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void
הפעלת טעינה עצלה ב-GPT בהתאם להגדרות של אובייקט ההגדרות. דוגמאות מפורטות נוספות זמינות בדוגמה של טעינה עצלה.

הערה: אחזור עצל ב-SRA פועל רק אם כל המשבצות נמצאות מחוץ למרווח האחזור.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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,
});
ראה גם
פרמטרים
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}		אובייקט ההגדרה מאפשר התאמה אישית של התנהגות עצלה. אם לא תגדירו הגדרות מסוימות, המערכת תשתמש בהגדרות ברירת מחדל שנקבעו על ידי Google, והן ישתנו עם הזמן. כדי להשבית הגדרה מסוימת, כמו מרווח אחזור, מגדירים את הערך ל--1.
  • fetchMarginPercent

    המרחק המינימלי מאזור התצוגה הנוכחי שצריך להיות בין מיקום מודעה לבין קבלת המודעה, כאחוז מגודל אזור התצוגה. ערך של 0 פירושו 'כשהמשבצת נכנסת לאזור התצוגה', ערך של 100 פירושו 'כשהמודעה נמצאת במרחק של אזור תצוגה אחד' וכן הלאה.
  • renderMarginPercent

    המרחק המינימלי מהאזור הנוכחי של חלון התצוגה שנדרש כדי שמשבצת תהיה מוכנה להצגת מודעה. כך אפשר לבצע אחזור מראש של המודעה, אבל להמתין עם העיבוד וההורדה של משאבי משנה אחרים. הערך פועל בדיוק כמו fetchMarginPercent כאחוז משטח התצוגה.
  • mobileScaling

    מכפיל שמוחל על שוליים במכשירים ניידים. כך אפשר להגדיר שוליים שונים בנייד ובמחשב. לדוגמה, אם תגדירו ערך של 2.0, כל השוליים יוכפלו ב-2 במכשירים ניידים, והמרחק המינימלי בין מיקום מודעה לבין אחזור והצגה יגדל.

enableSingleRequest

enableSingleRequest(): boolean
ההגדרה הזו מפעילה מצב של בקשה יחידה לאחזור של כמה מודעות בו-זמנית. לשם כך, צריך להגדיר את כל מיקומי המודעות של בעלי האתרים ולהוסיף אותם ל-PubAdsService לפני שמפעילים את השירות. צריך להגדיר את מצב הבקשה הבודדת לפני שמפעילים את השירות.
ראה גם
החזרות
booleanהפונקציה מחזירה true אם הופעל מצב בקשה יחידה, ו-false אם אי אפשר להפעיל מצב בקשה יחידה כי הפונקציה נקראה אחרי שהשירות הופעל.

enableVideoAds

enableVideoAds(): void
אותות ל-GPT שמודעות וידאו יוצגו בדף. ההגדרה הזו מאפשרת להגדיר אילוצים של החרגת מודעות מתחרות במודעות לרשת המדיה ובמודעות וידאו. אם תוכן הווידאו ידוע, צריך להתקשר אל PubAdsService.setVideoContent כדי להשתמש בהחרגת תוכן למודעות לרשת המדיה.

להוריד

get(key: string): string
מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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שם המאפיין שרוצים לחפש.
החזרות
stringהערך הנוכחי של מפתח המאפיין, או null אם המפתח לא קיים.

getAttributeKeys

getAttributeKeys(): string[]
מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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[]
הפונקציה מחזירה פרמטר ספציפי של טירגוט ברמת השירות שהוגדר.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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[]
מחזירה את רשימת כל מפתחות הטירגוט המותאמים אישית ברמת השירות שהוגדרו.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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הפונקציה מחזירה true אם שיחה קודמת אל PubAdsService.disableInitialLoad הצליחה, אחרת היא מחזירה false.

רענון

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void
מאחזר ומציג מודעות חדשות למיקומים ספציפיים או לכל המיקומים בדף. הפונקציה פועלת רק במצב עיבוד אסינכרוני.

כדי שהפונקציה תפעל בצורה תקינה בכל הדפדפנים, צריך להוסיף קריאה ל-refresh לפני הקריאה ל-display של מיקום המודעה. אם לא תכללו את השיחה אל display, יכול להיות שהרענון לא יפעל כמו שצריך. אם רוצים, אפשר להשתמש בשיטה PubAdsService.disableInitialLoad כדי למנוע מ-display לאחזר מודעה.

רענון של משבצת מסיר את המודעה הישנה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות של מודעות מתחרות שקשורות למודעה הזו.
דוגמה

JavaScript

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

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

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

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

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

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

‫JavaScript (גרסה קודמת)

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 });
ראה גם
פרמטרים
Optional slots: Slot[]המשבצות לרענון. מערך הוא אופציונלי. אם לא מציינים מערך, כל המשבצות ירועננו.
Optional options: {
  changeCorrelator: boolean;
}		אפשרויות ההגדרה שמשויכות לקריאת הרענון הזו.
  • ‫changeCorrelator

    מציין אם ליצור קורלטור חדש לאחזור מודעות. שרתי המודעות שלנו שומרים את ערך המתאם הזה לזמן קצר (נכון לעכשיו למשך 30 שניות, אבל זה עשוי להשתנות), כך שבקשות עם אותו מתאם שמתקבלות בסמיכות ייחשבו כצפייה אחת בדף. כברירת מחדל, נוצר מתאם חדש בכל רענון.

    הערה: לאפשרות הזו אין השפעה על הצגת דף לזמן ארוך ב-GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות כרגע בדף ואין לה זמן תפוגה.

הגדרה

set(key: string, value: string): PubAdsService
הפונקציה הזו מגדירה ערכים למאפייני AdSense שחלים על כל שטחי הפרסום במסגרת השירות Publisher Ads.

אם קוראים לפונקציה הזו יותר מפעם אחת עבור אותו מפתח, הערכים שהוגדרו קודם עבור המפתח הזה יוחלפו. צריך להגדיר את כל הערכים לפני שמפעילים את display או refresh.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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
מגדיר החרגה של קטגוריית מודעות ברמת הדף עבור שם התווית שצוין.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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, כי רק מודעות שנשלחה לגביהן בקשה אחרי הפעלת המתודה הזו יוצבו במרכז.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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 או לא מוגדר, המודעה תוצג באמצעות מאגר SafeFrame, בהתאם לסוג הקריאייטיב ולבחירה שנעשתה בממשק המשתמש של Google Ad Manager.
  • חשוב להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של נכסי קריאייטיב שמנסים לצאת ממסגרות ה-iframe שלהם או שמסתמכים על כך שהם יוצגו ישירות בדף של בעל האתר.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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
הפונקציה מעבירה מידע על מיקום מאתרים, כדי שתוכלו לבצע טירגוט גיאוגרפי של פריטי תנועה למיקומים ספציפיים.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

// Postal code:
googletag.pubads().setLocation("10001,US");
פרמטרים
address: stringכתובת בפורמט חופשי.
החזרות
PubAdsServiceאובייקט השירות שבו בוצעה הקריאה לשיטה.

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
אפשר להגדיר את כל הגדרות הפרטיות באמצעות API יחיד, באמצעות אובייקט הגדרה.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});
ראה גם
פרמטרים
privacySettings: PrivacySettingsConfigאובייקט שמכיל את הגדרות הפרטיות.
החזרות
PubAdsServiceאובייקט השירות שהפונקציה נקראה בו.

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService
מגדיר את הערך של המזהה שסופק על ידי בעל האתר.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
ראה גם
פרמטרים
ppid: stringמזהה אלפאנומרי שסופק על ידי בעל האתר. הסיסמה צריכה לכלול בין 32 ל-150 תווים.
החזרות
PubAdsServiceאובייקט השירות שבו בוצעה הקריאה לשיטה.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
המדיניות הזו מגדירה את ההעדפות ברמת הדף להגדרת SafeFrame. המערכת תתעלם ממפתחות לא מזוהים באובייקט ההגדרות. המערכת תתעלם מכל ההגדרות אם יועבר ערך לא תקין למפתח מוכר.

העדפות ברמת הדף יוחלפו בהעדפות ברמת משבצת המודעה, אם הן צוינו.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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
הגדרת פרמטרים מותאמים אישית של טירגוט למפתח נתון, שחלים על כל משבצות הפרסום בשירות Publisher Ads. אם קוראים לפונקציה הזו כמה פעמים לאותו מפתח, הערכים הישנים יימחקו. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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מזהה מערכת ניהול התוכן של הסרטון.

updateCorrelator

updateCorrelator(): PubAdsService
הפונקציה משנה את הקורלטור שנשלח עם בקשות להצגת מודעות, ובעצם מתחילה צפייה חדשה בדף. הערך של פרמטר הקורלציה זהה לכל בקשות המודעות שמגיעות מצפייה אחת בדף, והוא ייחודי לכל צפייה בדף. ההגדרה רלוונטית רק למצב אסינכרוני.

הערה: ההגדרה הזו לא משפיעה על צפייה בדף לטווח ארוך ב-GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות בפועל בדף ואין לה תוקף.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.
החזרות
PubAdsServiceאובייקט השירות שהפונקציה נקראה בו.

googletag.ResponseInformation

אובייקט שמייצג תגובה יחידה לבקשה להצגת מודעה.
מאפיינים
advertiserId
המזהה של המפרסם.
campaignId
מזהה הקמפיין.
creativeId
המזהה של הקריאייטיב.
creativeTemplateId
מזהה התבנית של המודעה.
lineItemId
המזהה של פריט ההזמנה.
ראה גם

מאפיינים

advertiserId

advertiserId: number
המזהה של המפרסם.

campaignId

campaignId: number
מזהה הקמפיין.

creativeId

creativeId: number
המזהה של הקריאייטיב.

creativeTemplateId

creativeTemplateId: number
מזהה התבנית של המודעה.

lineItemId

lineItemId: number
המזהה של פריט ההזמנה.

googletag.RewardedPayload

אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת
מאפיינים
amount
מספר הפריטים שכלולים בתגמול.
type
סוג הפריט שכלול בתגמול (לדוגמה, 'מטבע').
ראה גם

מאפיינים

amount

amount: number
מספר הפריטים שכלולים בתגמול.

type

type: string
סוג הפריט שכלול בתגמול (לדוגמה, 'מטבע').

googletag.Service

מחלקת שירות בסיסית שמכילה methods שמשותפים לכל השירותים.
Methods
addEventListener
הפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף.
getSlots
אחזור רשימת המשבצות שמשויכות לשירות הזה.
removeEventListener
הסרה של מעבד אירוע שנרשם קודם.

Methods

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
הפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. יש תמיכה באירועים הבאים: אובייקט מסוג האירוע המתאים מועבר אל ה-listener כשהוא נקרא.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

// 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
מסירה מעבד אירוע שנרשם קודם.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

כלי ליצירת אובייקטים של מיפוי גדלים. הכלי הזה נועד לעזור לכם ליצור בקלות מפרטים של גדלים.
Methods
addSize
הוספת מיפוי ממערך בגודל יחיד (שמייצג את אזור התצוגה) למערך בגודל יחיד או בגדלים מרובים שמייצג את מיקום המודעה.
build
יוצר מפרט של מפת גודל מהמיפויים שנוספו לכלי הזה.
ראה גם

Methods

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
הפונקציה מוסיפה מיפוי ממערך בגודל יחיד (שמייצג את אזור התצוגה) למערך בגודל יחיד או בגדלים מרובים שמייצג את מיקום המודעה.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
פרמטרים
viewportSize: SingleSizeArrayהגודל של אזור התצוגה עבור רשומת המיפוי הזו.
slotSize: GeneralSizeהגדלים של משבצת המיקום לרשומה הזו של מיפוי.
החזרות
SizeMappingBuilderהפניה ל-builder הזה.

build

build(): SizeMappingArray
יוצר מפרט של מפת מידות מהמיפויים שנוספו לבונה הזה.

אם סופקו מיפויים לא תקינים, השיטה הזו תחזיר null. אחרת, היא מחזירה מפרט בפורמט הנכון כדי להעביר אותו אל Slot.defineSizeMapping.

הערה: ההתנהגות של הכלי לבניית מודעות אחרי קריאה לשיטה הזו לא מוגדרת.
החזרות
SizeMappingArrayהתוצאה שנוצרה על ידי ה-builder הזה. יכול להיות null אם סופקו מיפויים לא תקינים של גדלים.

googletag.Slot

Slot הוא אובייקט שמייצג משבצת פרסום יחידה בדף.
Methods
addService
הוספת שירות למשבצת הזו.
clearCategoryExclusions
הוצא משימוש. מנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת המשבצת עבור המשבצת הזו.
clearTargeting
הוצא משימוש. מנקה פרמטרים ספציפיים או את כל פרמטרים לטירגוט ברמת משבצת המודעה עבור המשבצת הזו.
defineSizeMapping
מגדיר מערך של מיפויים מגודל מינימלי של אזור התצוגה לגודל של משבצת המודעה הזו.
get
הוצא משימוש. הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון של משבצת המודעה הזו.
getAdUnitPath
הפונקציה מחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת והנתיב של יחידת המודעות.
getAttributeKeys
הוצא משימוש. מחזירה את רשימת מפתחות המאפיינים שהוגדרו במשבצת הזו.
getCategoryExclusions
הוצא משימוש. הפונקציה מחזירה את התוויות להחרגת קטגוריות של מודעות במשבצת הזו.
getConfig
מקבל את אפשרויות ההגדרה הכלליות של משבצת שהוגדרה באמצעות setConfig.
getResponseInformation
מחזירה את פרטי התגובה של המודעה.
getSlotElementId
הפונקציה מחזירה את המזהה של משבצת div שצוין כשהמשבצת הוגדרה.
getTargeting
הוצא משימוש. הפונקציה מחזירה פרמטר ספציפי של טירגוט מותאם אישית שהוגדר במשבצת הזו.
getTargetingKeys
הוצא משימוש. הפונקציה מחזירה את רשימת כל מפתחות הטירגוט בהתאמה אישית שהוגדרו במשבצת הזו.
set
הוצא משימוש. מגדיר ערך למאפיין AdSense במשבצת המודעה הזו.
setCategoryExclusion
הוצא משימוש. מגדיר תווית להחרגת קטגוריות של מודעות ברמת משבצת המודעה במשבצת הזו.
setClickUrl
הוצא משימוש. מגדיר את כתובת ה-URL של הקליק שאליה המשתמשים יופנו אחרי שהם ילחצו על המודעה.
setCollapseEmptyDiv
הוצא משימוש. הגדרה שקובעת אם מיקום המודעה div יוסתר כשאין מודעה במיקום.
setConfig
הגדרת אפשרויות כלליות של חריץ הזמן הזה.
setForceSafeFrame
הוצא משימוש. ההגדרה קובעת אם המודעות במשבצת הזו יוצגו בכוח באמצעות מאגר SafeFrame.
setSafeFrameConfig
הוצא משימוש. הגדרת ההעדפות ברמת משבצת המודעה לגבי ההגדרה של SafeFrame.
setTargeting
הוצא משימוש. מגדיר פרמטר מותאם אישית לטירגוט במשבצת הזו.
updateTargetingFromMap
הוצא משימוש. מגדיר פרמטרים מותאמים אישית של טירגוט למשבצת הזו, ממפת מפתח:ערך באובייקט JSON.

Methods

addService

addService(service: Service): Slot
הוספת שירות למשבצת הזו.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
ראה גם
פרמטרים
service: Serviceהשירות שרוצים להוסיף.
החזרות
Slotאובייקט המשבצת שעליו בוצעה הקריאה לשיטה.

clearCategoryExclusions

clearCategoryExclusions(): Slot
מנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת המשבצת עבור המשבצת הזו.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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
מנקה פרמטרים ספציפיים או את כל פרמטרים מותאמים אישית של טירגוט ברמת משבצת התוכן.
דוגמה

JavaScript

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.

‫JavaScript (גרסה קודמת)

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.
ראה גם
פרמטרים
Optional key: stringמפתח פרמטר לטירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל פרמטרי הטירגוט ינוקו.
החזרות
Slotאובייקט המשבצת שעליו בוצעה הקריאה לשיטה.

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot
ההגדרה הזו קובעת מערך של מיפויים מגודל מינימלי של אזור התצוגה לגודל של משבצת המודעה.
דוגמה

JavaScript

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

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

slot.defineSizeMapping(mapping);

‫JavaScript (גרסה קודמת)

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(key: string): string
הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון של משבצת הפרסום הזו. כדי לראות את המאפיינים ברמת השירות שמועברים לחריץ הזה, משתמשים ב-PubAdsService.get.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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שם המאפיין שרוצים לחפש.
החזרות
stringהערך הנוכחי של מפתח המאפיין, או null אם המפתח לא קיים.

getAdUnitPath

getAdUnitPath(): string
מחזירה את הנתיב המלא של יחידת המודעות, כולל קוד הרשת והנתיב של יחידת המודעות.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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.
דוגמה

JavaScript

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'].

‫JavaScript (גרסה קודמת)

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[]
הפונקציה מחזירה את התוויות של החרגות קטגוריות המודעות עבור מיקום המודעה הזה.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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[]תוויות ההחרגה של קטגוריית המודעות במשבצת הזו, או מערך ריק אם לא הוגדרו תוויות.

getConfig

getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">
מקבל אפשרויות הגדרה כלליות לחריץ שהוגדר על ידי setConfig.

השיטה הזו לא תומכת בכל המאפיינים של setConfig(). המאפיינים הנתמכים הם:
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
פרמטרים
keys: string | string[]המפתחות של אפשרויות ההגדרה שרוצים לקבל.
החזרות
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">אפשרויות ההגדרה של משבצת המודעה.

getResponseInformation

getResponseInformation(): ResponseInformation
מחזירה את פרטי התגובה של המודעה. הנתון הזה מבוסס על התגובה האחרונה של המודעה למשבצת. אם הפונקציה הזו נקראת כשאין מודעה במשבצת, המערכת תחזיר את הערך null.
החזרות
ResponseInformationהמידע העדכני ביותר על תגובת המודעה, או null אם אין מודעה במשבצת.

getSlotElementId

getSlotElementId(): string
מחזירה את המזהה של משבצת div שסופקה כשהמשבצת הוגדרה.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

slot.getSlotElementId();
// Returns 'div'.
החזרות
stringמזהה מיקום מודעה div.

getTargeting

getTargeting(key: string): string[]
הפונקציה מחזירה פרמטר מותאם אישית ספציפי לטירגוט שהוגדר במשבצת הזו. פרמטרים של טירגוט ברמת השירות לא נכללים.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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[]
מחזירה את רשימת כל מפתחות הטירגוט בהתאמה אישית שהוגדרו במשבצת הזו. לא נכללים מפתחות לטירגוט ברמת השירות.
דוגמה

JavaScript

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'].

‫JavaScript (גרסה קודמת)

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(key: string, value: string): Slot
התג הזה מגדיר ערך למאפיין AdSense במשבצת המודעה הזו. הפעולה הזו תבטל את כל הערכים שהוגדרו ברמת השירות עבור המפתח הזה.

קריאה לשיטה הזו יותר מפעם אחת עבור אותו מפתח תבטל את הערכים שהוגדרו קודם למפתח הזה. צריך להגדיר את כל הערכים לפני שמבצעים קריאה ל-display או ל-refresh.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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
מגדיר תווית להחרגת קטגוריות של מודעות ברמת מיקום המודעה במיקום המודעה הזה.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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התווית להחרגת קטגוריות של מודעות שרוצים להוסיף.
החזרות
Slotאובייקט המשבצת שעליו בוצעה הקריאה לשיטה.

setClickUrl

setClickUrl(value: string): Slot
מגדיר את כתובת ה-URL של הקליק שאליה המשתמשים יופנו אחרי שהם ילחצו על המודעה.

השרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת ה-URL של הקליק מוחלפת. כל כתובת URL של דף נחיתה שמשויכת לקריאייטיב שמוצג מתווספת לערך שצוין. שיחות שיתבצעו לאחר מכן יחליפו את הערך. האפשרות הזו פועלת רק בבקשות שלא קשורות ל-SRA.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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 תוסתר כשאין מודעה במשבצת. ההגדרה הזו מחליפה את ההגדרות ברמת השירות.
דוגמה

JavaScript

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.

‫JavaScript (גרסה קודמת)

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האם לכווץ את מיקום המודעה אם לא מוחזרת מודעה.
Optional collapseBeforeAdFetch: booleanהאם לכווץ את מיקום המודעה עוד לפני שליפת המודעה. המערכת מתעלמת מהמאפיין אם הערך של collapse הוא לא true.
החזרות
Slotאובייקט המשבצת שעליו בוצעה הקריאה לשיטה.

setConfig

setConfig(slotConfig: SlotSettingsConfig): void
הגדרת אפשרויות כלליות של חריץ הזמן הזה.
פרמטרים
slotConfig: SlotSettingsConfigאובייקט ההגדרה.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
ההגדרה הזו קובעת אם המערכת צריכה להציג את המודעות במשבצת הזו באמצעות מאגר SafeFrame.

חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:
  • ההגדרה הזו תיכנס לתוקף רק לגבי בקשות להצגת מודעות עתידיות שיישלחו לגבי המשבצות הרלוונטיות.
  • אם מציינים הגדרה ברמת המשבצת, היא תמיד תבטל את ההגדרה ברמת הדף.
  • אם ההגדרה היא true (ברמת משבצת המודעה או ברמת הדף), המודעה תמיד תוצג באמצעות מאגר SafeFrame, ללא קשר לבחירה שנעשתה בממשק המשתמש של Google Ad Manager.
  • עם זאת, אם הערך מוגדר כ-false או לא מוגדר, המודעה תוצג באמצעות מאגר SafeFrame, בהתאם לסוג הקריאייטיב ולבחירה שנעשתה בממשק המשתמש של Google Ad Manager.
  • חשוב להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של נכסי קריאייטיב שמנסים לצאת ממסגרות ה-iframe שלהם או שמסתמכים על כך שהם יוצגו ישירות בדף של בעל האתר.
    • ‫
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());
ראה גם
פרמטרים
forceSafeFrame: boolean‫true כדי לחייב את כל המודעות במשבצת הזו לעבור עיבוד ב-SafeFrame, ו-false כדי לבטל את ההסכמה להגדרה ברמת הדף (אם קיימת). הגדרת הערך false כשלא מציינים אותו ברמת הדף לא תשנה שום דבר.
החזרות
Slotאובייקט המשבצת שעליו בוצעה הקריאה לשיטה.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot
ההגדרה הזו קובעת את ההעדפות ברמת משבצת המודעה להגדרת SafeFrame. המערכת תתעלם ממפתחות לא מזוהים באובייקט ההגדרות. המערכת תתעלם מכל ההגדרות אם יועבר ערך לא תקין למפתח מוכר.

אם מציינים העדפות ברמת משבצת התצוגה, הן יחליפו את ההעדפות ברמת הדף.
דוגמה

JavaScript

googletag.pubads().setForceSafeFrame(true);

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

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

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

‫JavaScript (גרסה קודמת)

googletag.pubads().setForceSafeFrame(true);

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

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

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

TypeScript

googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
ראה גם
פרמטרים
config: SafeFrameConfigאובייקט ההגדרה.
החזרות
Slotאובייקט המשבצת שעליו בוצעה הקריאה לשיטה.

setTargeting

setTargeting(key: string, value: string | string[]): Slot
הגדרת פרמטר מותאם אישית לטירגוט במשבצת הזו. אם קוראים לשיטה הזו כמה פעמים עבור אותו מפתח, הערכים הישנים יימחקו. ערכים שמוגדרים כאן יחליפו פרמטרים לטירגוט שהוגדרו ברמת השירות. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
דוגמה

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .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"]);

‫JavaScript (גרסה קודמת)

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
הפונקציה מגדירה פרמטרים מותאמים אישית לטירגוט במשבצת הזו, ממיפוי של מפתח:ערך באובייקט JSON. הפעולה הזו זהה לקריאה לפונקציה Slot.setTargeting לכל ערכי המפתח של האובייקט. המפתחות האלה מוגדרים בחשבון Google Ad Manager.

הערות:
  • במקרה של החלפה, רק הערך האחרון יישמר.
  • אם הערך הוא מערך, כל ערך קודם יוחלף ולא ימוזג.
  • ערכים שמוגדרים כאן יחליפו פרמטרים לטירגוט שהוגדרו ברמת השירות.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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
הגדרות לשליטה בהרחבת המודעות.
AdSenseAttributesConfig
הגדרות לשליטה בהתנהגות של מודעות AdSense.
ComponentAuctionConfig
אובייקט שמייצג מכירה פומבית של רכיב יחיד במכירה פומבית של מודעות במכשיר.
InterstitialConfig
אובייקט שמגדיר את ההתנהגות של משבצת אחת של מודעת מעברון.
LazyLoadConfig
הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT.
PageSettingsConfig
ממשק ההגדרות הראשי להגדרות ברמת הדף.
PrivacyTreatmentsConfig
הגדרות לשליטה בטיפול בפרטיות של בעלי אתרים.
PublisherProvidedSignalsConfig
אובייקט ההגדרה של אותות שמספקים בעלי תוכן דיגיטלי (PPS).
SafeFrameConfig
הגדרות לשליטה ב-SafeFrame ב-GPT.
SlotSettingsConfig
ממשק ההגדרה הראשי להגדרות ברמת המשבצת.
TaxonomyData
אובייקט שמכיל את הערכים של Taxonomy יחיד.
VideoAdsConfig
הגדרות לקביעת הגדרות שקשורות למודעות וידאו.
סוג כינויים
CollapseDivBehavior
ערכים נתמכים לשליטה בהתנהגות של צמצום משבצות מודעות.
InterstitialTrigger
טריגרים נתמכים להצגת מודעות מעברון.
PrivacyTreatment
אמצעי הגנה על פרטיות שנתמכים ב-AdMob.
Taxonomy

סוג כינויים

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"
ערכים נתמכים לשליטה בהתנהגות של כיווץ משבצות מודעה.
ראה גם

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "backward" | "endOfArticle"
טריגרים נתמכים להצגת מודעות מעברון.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
אמצעי הגנה על פרטיות שנתמכים ב-AdMob.

טקסונומיה

googletag.config.AdExpansionConfig

הגדרות לשליטה בהרחבת המודעות.
מאפיינים
enabled?
האם הרחבת המודעות מופעלת או מושבתת.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

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

מאפיינים

Optional מופעל

enabled?: boolean
האם הרחבת המודעות מופעלת או מושבתת.

הגדרת הערך הזה מבטלת את ברירת המחדל שהוגדרה ב-Google Ad Manager.
ראה גם

googletag.config.AdSenseAttributesConfig

הגדרות לשליטה בהתנהגות של מודעות AdSense.

אפשר להשתמש במאפיינים האלה כדי לשנות הגדרות בצד השרת על בסיס כל בקשה.
מאפיינים
adsense_ad_format?
פורמט מודעה ב-AdSense.
adsense_channel_ids?
מזהי ערוצים ב-AdSense.
adsense_test_mode?
האם מצב הבדיקה מופעל או לא.
document_language?
השפה של הדף שבו מוצגות המודעות.
page_url?
כתובת ה-URL של הדף שבו מוצגות המודעות.
ראה גם

מאפיינים

Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"
פורמט מודעה ב-AdSense.

Optional adsense_channel_ids

adsense_channel_ids?: string
מזהי ערוצים ב-AdSense.

הערכים המותרים הם מזהי ערוצים שמופרדים באמצעות '+'.

דוגמה: 271828183+314159265
ראה גם

Optional adsense_test_mode

adsense_test_mode?: "on"
האם מצב הבדיקה מופעל או לא.

אם הערך הוא on, המודעות מסומנות כמודעות לבדיקה בלבד, והן לא ייכללו בספירה או בחיוב. ההגדרה הזו צריכה להיות לא מוגדרת בסביבת ייצור, בתנועה שלא מיועדת לבדיקה.

Optional document_language

document_language?: string
השפה של הדף שבו מוצגות המודעות.

הערכים המותרים הם קודי שפה תקינים לפי תקן ISO 639-1.

דוגמה: en
ראה גם

Optional page_url

page_url?: string
כתובת ה-URL של הדף שבו מוצגות המודעות.

הערכים המותרים הם כתובות URL תקינות.

דוגמה: http://www.example.com

googletag.config.ComponentAuctionConfig

אובייקט שמייצג מכירה פומבית של רכיב יחיד במכירה פומבית של מודעות במכשיר.
מאפיינים
auctionConfig
אובייקט של הגדרת מכרז לרכיב הזה.
configKey
מפתח ההגדרה שמשויך למרכיב הזה של המכרז.
ראה גם

מאפיינים

auctionConfig

auctionConfig: {
  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 שצוין תימחק.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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 יש אותו ערך configKey, האובייקט האחרון שהוגדר יחליף את ההגדרות הקודמות.

googletag.config.InterstitialConfig

אובייקט שמגדיר את ההתנהגות של משבצת אחת של מודעת מעברון.
מאפיינים
requireStorageAccess?
האם נדרשת הסכמה לאחסון מקומי כדי להציג את מודעת המעברון הזו.
triggers?
הגדרת הטריגר של מודעת המעברון הזו.

מאפיינים

Optional requireStorageAccess

requireStorageAccess?: boolean
האם נדרשת הסכמה לאחסון מקומי כדי להציג את מודעת המעברון הזו.

‫GPT משתמש באחסון מקומי כדי לאכוף מכסת תדירות למודעות מעברון. עם זאת, משתמשים שלא הביעו הסכמה לאחסון מקומי עדיין עומדים בדרישות להצגת מודעות מעברון. הגדרת המאפיין הזה לערך true משביתה את התנהגות ברירת המחדל, ומבטיחה שמודעות מעברון יוצגו רק למשתמשים שנתנו הסכמה לאחסון מקומי.
דוגמה

JavaScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

‫JavaScript (גרסה קודמת)

// Opt out of showing interstitials to users
// without local storage consent.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});
ראה גם

Optional טריגרים

triggers?: Partial<Record<InterstitialTrigger, boolean>>
הגדרת הטריגר של המודעה הבין-דףית הזו.

הגדרת הערך של טריגר למודעה בין-דףית כ-true תפעיל אותו, והגדרת הערך כ-false תשבית אותו. הפעולה הזו תבטל את ערכי ברירת המחדל שהוגדרו ב-Google Ad Manager.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT.
מאפיינים
fetchMarginPercent?
המרחק המינימלי מהאזור הנוכחי של חלון התצוגה שנדרש כדי שמשבצת תהיה כשירה לשליחת בקשה להצגת מודעה, בערך שמוצג כאחוז מגודל חלון התצוגה.
mobileScaling?
מכפיל שמוחל על שוליים במכשירים ניידים.
renderMarginPercent?
המרחק המינימלי מאזור התצוגה הנוכחי שנדרש כדי שמשבצת תהיה מוכנה להצגת מודעה, מבוטא כאחוז מגודל אזור התצוגה.
ראה גם

מאפיינים

Optional fetchMarginPercent

fetchMarginPercent?: number
המרחק המינימלי מהאזור הנוכחי של חלון התצוגה שצריך להיות בין מיקום מודעה לבין בקשה להצגת מודעה, מבוטא כאחוז מגודל חלון התצוגה.

ההגדרה הזו משמשת בשילוב עם renderMarginPercent, ומאפשרת אחזור מראש של מודעה, אבל המתנה להצגה ולהורדה של משאבי משנה אחרים. לכן, הערך הזה תמיד צריך להיות גדול מ-renderMarginPercent או שווה לו.

ערך של 0 פירושו 'כשהמשבצת נכנסת לאזור התצוגה', ערך של 100 פירושו 'כשהמודעה נמצאת במרחק של אזור תצוגה אחד' וכן הלאה.

‫Optional mobileScaling

mobileScaling?: number
מכפיל שמוחל על שוליים במכשירים ניידים. המכפיל הזה חל על fetchMarginPercent וגם על renderMarginPercent.

כך אפשר להגדיר שוליים שונים בנייד ובמחשב, כי גדלי אזור התצוגה ומהירויות הגלילה עשויים להיות שונים. לדוגמה, ערך של 2.0 יכפיל את כל השוליים בניידים, ויגדיל את המרחק המינימלי שבו מיקום מודעה יכול להיות מחוץ לאזור התצוגה לפני שליפה ועיבוד.

Optional renderMarginPercent

renderMarginPercent?: number
המרחק המינימלי מהאזור הנוכחי של חלון התצוגה שצריך להיות בין מיקום מודעה לבין רגע הצגת המודעה, מבוטא כאחוז מגודל חלון התצוגה.

ההגדרה הזו משמשת בשילוב עם fetchMarginPercent, ומאפשרת אחזור מראש של מודעה, אבל המתנה להצגה ולהורדה של משאבי משנה אחרים. לכן, הערך הזה תמיד צריך להיות קטן מהערך של fetchMarginPercent או שווה לו.

ערך של 0 פירושו 'כשהמשבצת נכנסת לאזור התצוגה', ערך של 100 פירושו 'כשהמודעה נמצאת במרחק של אזור תצוגה אחד' וכן הלאה.

googletag.config.PageSettingsConfig

ממשק ההגדרה הראשי להגדרות ברמת הדף.

אפשר להגדיר כמה תכונות באמצעות קריאת API אחת.

כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. לרשימת התכונות, אפשר לעיין בשדות בסוג PageSettingsConfig שבהמשך.

דוגמאות:
  • רק תכונות שמצוינות בקריאה googletag.setConfig משתנות. 
      // Configure feature alpha.
  googletag.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });
  • כל ההגדרות של תכונה מסוימת מתעדכנות בכל קריאה ל-googletag.setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });
  • אפשר להעביר את הערך null כדי לנקות את כל ההגדרות של תכונה מסוימת. 
      // Configure features delta, golf, and hotel.
  googletag.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  googletag.setConfig({
      delta: null,
      hotel: null,
  });
מאפיינים
adExpansion?
הגדרות לשליטה בהרחבת המודעות.
adsenseAttributes?
הגדרה לקביעת מאפייני AdSense.
adYield?
הוצא משימוש. 
categoryExclusion?
הגדרה להחרגת קטגוריות של מודעות.
centering?
הגדרה לשליטה במיקום המודעות במרכז המסך לרוחב.
collapseDiv?
הגדרה לשליטה בהתנהגות של כיווץ מיקומי מודעות.
disableInitialLoad?
הגדרה לשליטה במועד שליחת הבקשות להצגת מודעות.
lazyLoad?
הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT.
location?
הגדרה לטירגוט גיאוגרפי של פריטי מידע למיקומים גיאוגרפיים.
pps?
הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS).
privacyTreatments?
הגדרות לשליטה בטיפול בפרטיות של בעלי אתרים.
safeFrame?
הגדרות לשליטה בשימוש ב-SafeFrame ב-GPT.
singleRequest?
הגדרה להפעלה או להשבתה של ארכיטקטורת בקשה בודדת (SRA).
targeting?
הגדרה לשליטה בטירגוט של צמדי מפתח/ערך.
threadYield?
הגדרה שקובעת אם GPT צריך להעביר את השרשור של JavaScript כשמבקשים קריאייטיבים ומעבדים אותם.
videoAds?
הגדרות לשליטה במודעות וידאו.

מאפיינים

Optional adExpansion

adExpansion?: AdExpansionConfig
הגדרות לשליטה בהרחבת המודעות.

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
הגדרה לקביעת מאפייני AdSense.

מאפייני AdSense שמוגדרים באמצעות ההגדרה הזו יחולו על כל מיקומי המודעות בדף. אפשר לקרוא להגדרה הזו כמה פעמים כדי להגדיר כמה ערכים של מאפיינים, או כדי להחליף ערכים קיימים.

שינויים במאפייני AdSense חלים רק על מודעות שהבקשה להצגתן נשלחה אחרי שהופעלה השיטה הזו. לכן מומלץ להפעיל את ה-method הזו לפני כל קריאה ל-googletag.display או ל-PubAdsService.refresh.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

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

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

‫Optional categoryExclusion

categoryExclusion?: string[]
הגדרה להחרגת קטגוריות של מודעות.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });
ראה גם

Optional centering

centering?: boolean
הגדרה לשליטה במיקום המודעות במרכז המסך לרוחב. ההגדרה 'מרכוז' מושבתת כברירת מחדל.

שינויים במרכוז אופקי חלים רק על מודעות שהבקשה להצגתן נשלחה אחרי שהופעלה השיטה הזו. לכן מומלץ להפעיל את ה-method הזו לפני כל קריאה ל-googletag.display או ל-PubAdsService.refresh.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

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

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
הגדרה לשליטה בהתנהגות של כיווץ מיקומי מודעות.

מיקום מודעה מכווץ לא תופס מקום בדף.

ערכים נתמכים:
  • ‫null (ברירת מחדל): המשבצת לא תכווץ.
  • ‫DISABLED: המיקום לא יתכווץ, גם אם מוחזרת מודעה וגם אם לא.
  • ‫BEFORE_FETCH: המיקום יתחיל במצב מכווץ, ויתרחב כשמודעה תוחזר.
  • ‫ON_NO_FILL: המיקום יתחיל כמוצג במצב מורחב, ויתכווץ אם לא תוחזר מודעה.
דוגמה

JavaScript

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

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

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

TypeScript

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

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

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

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });
ראה גם

Optional disableInitialLoad

disableInitialLoad?: boolean
הגדרה שקובעת מתי נשלחת בקשה להצגת מודעות.

כברירת מחדל, השיטה googletag.display רושמת משבצות פרסום ושולחת בקשות להצגת מודעות במשבצות האלה. עם זאת, יש מקרים שבהם עדיף להפריד בין הפעולות האלה, כדי לשלוט בצורה מדויקת יותר במועד הטעינה של תוכן המודעה.

אם מפעילים את ההגדרה הזו, לא תוגש בקשה להצגת מודעות במשבצות רשומות כשקוראים לפונקציה display(). במקום זאת, צריך לבצע קריאה נפרדת ל-PubAdsService.refresh כדי ליזום בקשה להצגת מודעה.

חובה לקרוא לשיטה הזו לפני שקוראים ל-googletag.enableServices.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

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

Optional lazyLoad

lazyLoad?: LazyLoadConfig
הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT.

טעינה מדורגת היא טכניקה לעיכוב הבקשה להצגת מודעות והעיבוד שלהן עד שהן מתקרבות לאזור התצוגה של המשתמש. דוגמה מפורטת יותר מופיעה בדוגמה של טעינה עצלה.

הערה: אם האפשרות singleRequest מופעלת, אחזור עצלני פועל רק כשכל המשבצות נמצאות מחוץ למרווח האחזור.

כל הגדרות הטעינה העצלה שלא צוינו כשקוראים ל-setConfig() ישתמשו בערך ברירת מחדל שהוגדר על ידי Google. יכול להיות שברירות המחדל האלה ישתנו עם הזמן. כדי להשבית הגדרה מסוימת, מגדירים את הערך ל-null.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });
ראה גם

Optional מיקום

location?: string
הגדרה של טירגוט גיאוגרפי של פריטי מידע למיקומים גיאוגרפיים.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

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

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

TypeScript

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

// Clear the location setting.
googletag.setConfig({ location: null });
ראה גם

Optional pps

הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS).

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig
הגדרות לשליטה בטיפול בפרטיות של בעלי אתרים.

Optional safeFrame

safeFrame?: SafeFrameConfig
הגדרות לשליטה בשימוש ב-SafeFrame ב-GPT.

הערכים שמוגדרים באמצעות ההגדרה הזו יחולו על כל שטחי הפרסום בדף. אפשר לשנות את הערכים האלה באמצעות SlotSettingsConfig.safeFrame עבור משבצות פרסום ספציפיות.
דוגמה

JavaScript

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

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

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

TypeScript

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

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

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

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

Optional singleRequest

singleRequest?: boolean
הגדרה להפעלה או להשבתה של ארכיטקטורת בקשות יחידות (SRA).

כש-SRA מופעלת, כל משבצות המודעות שהוגדרו לפני קריאה ל-googletag.display או ל-PubAdsService.refresh יצורפו לבקשה אחת להצגת מודעה. השיטה הזו משפרת את הביצועים, אבל היא גם נחוצה כדי לוודא שהמערכת מכבדת את ההגבלות על חסימת מודעות ואת ההחרגות התחרותיות.

כש-SRA מושבת, כל משבצת פרסום מקבלת בקשה בנפרד. זוהי התנהגות ברירת המחדל של GPT.

חובה להפעיל את השיטה הזו לפני שמפעילים את googletag.enableServices.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });
ראה גם

Optional טירגוט

targeting?: Record<string, string | string[]>
הגדרה לשליטה בטירגוט לפי צמד מפתח/ערך.

הטירגוט שמוגדר באמצעות ההגדרה הזו יחול על כל שטחי הפרסום בדף. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה צמדים של מפתח/ערך לטירגוט, או כדי להחליף ערכים קיימים. מגדירים את מפתחות הטירגוט בחשבון Google Ad Manager.
דוגמה

JavaScript

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

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

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

TypeScript

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

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

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

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });
ראה גם

‫Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
הגדרה שקובעת אם GPT צריך להעביר את השרשור של JavaScript כשמבקשים נכסי קריאייטיב ומעבדים אותם.

GPT יעביר את השרשור רק בדפדפנים שתומכים ב-API‏ Scheduler.postTask או Scheduler.yield.

ערכים נתמכים:
  • ‫null (default): GPT will yield the JS thread for slots outside of the viewport.
  • ‫ENABLED_ALL_SLOTS: ‏ GPT יפנה את השרשור של JavaScript לכל מיקומי המודעות, בלי קשר לשאלה אם מיקום המודעה נמצא באזור התצוגה.
  • ‫DISABLED: GPT לא יחזיר את שרשור ה-JS.
דוגמה

JavaScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

‫JavaScript (גרסה קודמת)

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

TypeScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });
ראה גם

Optional videoAds

videoAds?: VideoAdsConfig
הגדרות לשליטה במודעות וידאו.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

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

googletag.config.PrivacyTreatmentsConfig

הגדרות לשליטה בטיפול בפרטיות של בעלי אתרים.
מאפיינים
treatments
מערך של אמצעים לשמירה על פרטיות בעלי תוכן דיגיטלי שאפשר להפעיל.

מאפיינים

טיפולים

treatments: "disablePersonalization"[]
מערך של אמצעי הגנה על הפרטיות של בעלי תוכן דיגיטלי שאפשר להפעיל.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

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

googletag.config.PublisherProvidedSignalsConfig

אובייקט ההגדרה של אותות שמספקים בעלי תוכן דיגיטלי (PPS).
מאפיינים
taxonomies
אובייקט שמכיל מיפויים של Taxonomy או null כדי לנקות את ההגדרה.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

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

TypeScript

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

מאפיינים

טקסונומיות

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
אובייקט שמכיל מיפויים של Taxonomy או null כדי לנקות את ההגדרה.

googletag.config.SafeFrameConfig

הגדרות לשליטה ב-SafeFrame ב-GPT.
מאפיינים
allowOverlayExpansion?
האם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי כיסוי תוכן הדף.
allowPushExpansion?
האם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי דחיפת תוכן הדף.
forceSafeFrame?
האם צריך לכפות הצגה של מודעות באמצעות מאגר SafeFrame.
sandbox?
האם SafeFrame צריך להשתמש במאפיין ארגז החול של HTML5 כדי למנוע ניווט ברמה העליונה ללא אינטראקציה של המשתמש.
useUniqueDomain?
הוצא משימוש. האם SafeFrame צריך להשתמש בתת-דומיינים אקראיים עבור נכסי קריאייטיב במכירה ישירה לא פרוגרמטית.
ראה גם

מאפיינים

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean
האם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי כיסוי תוכן הדף.

Optional allowPushExpansion

allowPushExpansion?: boolean
האם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי דחיפת תוכן הדף.

Optional forceSafeFrame

forceSafeFrame?: boolean
האם צריך לכפות הצגה של מודעות באמצעות מאגר SafeFrame.

Optional ארגז חול

sandbox?: boolean
האם SafeFrame צריך להשתמש במאפיין ארגז החול של HTML5 כדי למנוע ניווט ברמה העליונה ללא אינטראקציה של המשתמש. הערך התקין היחיד הוא true (אי אפשר להגדיר אותו כ-false). שימו לב שהמאפיין sandbox משבית תוספים (לדוגמה, Flash).

Optional useUniqueDomain

useUniqueDomain?: boolean
האם SafeFrame צריך להשתמש בתת-דומיינים אקראיים עבור נכסי קריאייטיב במכירה ישירה לא פרוגרמטית. מעבירים את הערך null כדי לנקות את הערך המאוחסן.

הערה: התכונה הזו מופעלת כברירת מחדל.
ראה גם

googletag.config.SlotSettingsConfig

ממשק ההגדרה הראשי להגדרות ברמת משבצת המודעה.

אפשר להגדיר כמה תכונות באמצעות קריאת API אחת למשבצת מודעה אחת.

כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. לרשימת התכונות, אפשר לעיין בשדות בסוג SlotSettingsConfig שבהמשך.

דוגמאות:
  • רק תכונות שמצוינות בקריאה Slot.setConfig משתנות. 
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);

  // Configure feature alpha.
  slot.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });
  • כל ההגדרות של תכונה נתונה מתעדכנות בכל קריאה ל-Slot.setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  slot.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  slot.setConfig({
      charlie: {
          echo: 2
      }
  });
  • אפשר להעביר את הערך null כדי לנקות את כל ההגדרות של תכונה מסוימת. 
      // Configure features delta, golf, and hotel.
  slot.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  slot.setConfig({
      delta: null,
      hotel: null,
  });
מאפיינים
adExpansion?
הגדרות להרחבת המודעות.
adsenseAttributes?
הגדרה לקביעת מאפייני AdSense.
categoryExclusion?
הגדרה להחרגת קטגוריות של מודעות.
clickUrl?
הגדרה לקביעת כתובת ה-URL שאליה המשתמשים יופנו אחרי שהם ילחצו על המודעה.
collapseDiv?
הגדרה לקביעת אופן הכיווץ של משבצת המודעה.
componentAuction?
מערך של מכרזים של רכיבים שייכללו במכרז של מודעות במכשיר.
interstitial?
הגדרות שקובעות את אופן הפעולה של משבצת למודעת מעברון.
safeFrame?
הגדרות לקביעת השימוש ב-SafeFrame ב-GPT.
targeting?
הגדרה לקביעת טירגוט לפי זוגות מפתח/ערך.

מאפיינים

Optional adExpansion

adExpansion?: AdExpansionConfig
הגדרות להרחבת המודעות.
ראה גם

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
הגדרה לקביעת מאפייני AdSense.

מאפייני AdSense שמוגדרים באמצעות ההגדרה הזו יחולו רק על מיקום המודעה. אפשר לקרוא להגדרה הזו כמה פעמים כדי להגדיר כמה ערכים של מאפיינים, או כדי להחליף ערכים קיימים.

שינויים במאפייני AdSense חלים רק על מודעות שהבקשה להצגתן נשלחה אחרי הקריאה לשיטה הזו. לכן מומלץ להפעיל את ה-method הזו לפני כל קריאה ל-googletag.display או ל-PubAdsService.refresh.
דוגמה

JavaScript

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

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

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

TypeScript

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

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

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

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

‫Optional categoryExclusion

categoryExclusion?: string[]
הגדרה להחרגת קטגוריות של מודעות.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });
ראה גם

Optional clickUrl

clickUrl?: string
הגדרה לקביעת כתובת ה-URL שאליה המשתמשים יופנו אחרי שהם ילחצו על המודעה.

השרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת ה-URL של הקליק מוחלפת. כל כתובת URL של דף נחיתה שמשויכת לקריאייטיב שמוצג מתווספת לערך שצוין. אם תגדירו את הערך הזה יותר מפעם אחת, הוא יחליף את הערך שהוגדר קודם. העברת הערך null תנקה את הערך.

הערה: ההגדרה הזו חלה רק על בקשות שאינן SRA.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

TypeScript

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

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

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

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
הגדרה לקביעת אופן ההסתרה של מיקום המודעה.

מיקום מודעה מוסתר לא תופס מקום בדף.

ערכים נתמכים:
  • ‫null (ברירת מחדל): המשבצת לא תכווץ.
  • ‫DISABLED: המיקום לא יתכווץ, גם אם מוחזרת מודעה וגם אם לא.
  • ‫BEFORE_FETCH: המיקום יתחיל במצב מכווץ, ויתרחב כשמודעה תוחזר.
  • ‫ON_NO_FILL: המיקום יתחיל כמוצג במצב מורחב, ויתכווץ אם לא תוחזר מודעה.
דוגמה

JavaScript

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

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

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

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

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

TypeScript

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

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

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

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

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});
ראה גם

Optional componentAuction

componentAuction?: ComponentAuctionConfig[]
מערך של מכרזים של רכיבים שייכללו במכרז של מודעות במכשיר.

Optional interstitial

interstitial?: InterstitialConfig
הגדרות שקובעות את אופן הפעולה של משבצת למודעת מעברון.
ראה גם

Optional safeFrame

safeFrame?: SafeFrameConfig
הגדרות לקביעת אופן השימוש ב-SafeFrame ב-GPT.

הערכים שמוגדרים באמצעות ההגדרה הזו יחולו רק על מיקום המודעה, ויגברו על הערכים שמוגדרים באמצעות PageSettingsConfig.safeFrame.
דוגמה

JavaScript

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

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

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

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

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

TypeScript

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

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

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

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

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

Optional טירגוט

targeting?: Record<string, string | string[]>
הגדרה לקביעת טירגוט לפי מפתח וערך.

הטירגוט שמוגדר באמצעות ההגדרה הזו יחול רק על משבצת הפרסום. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה צמדים של מפתח/ערך לטירגוט, או כדי להחליף ערכים קיימים. מגדירים את מפתחות הטירגוט בחשבון Google Ad Manager.
דוגמה

JavaScript

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

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

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

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

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

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

‫JavaScript (גרסה קודמת)

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

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

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

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

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

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

TypeScript

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

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

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

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

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

// Clear all targeting keys.
slot.setConfig({ targeting: null });
ראה גם

googletag.config.TaxonomyData

אובייקט שמכיל את הערכים של Taxonomy יחיד.
מאפיינים
values
רשימה של ערכים של טקסונומיה.

מאפיינים

ערכים

values: readonly string[]
רשימה של ערכים של טקסונומיה.

googletag.config.VideoAdsConfig

הגדרות לקביעת הגדרות שקשורות למודעות וידאו.
מאפיינים
enableVideoAds
האם מודעות וידאו יוצגו בדף.
videoCmsId?
מזהה מקור תוכן הווידאו.
videoContentId?
מזהה תוכן הווידאו.
ראה גם

מאפיינים

enableVideoAds

enableVideoAds: boolean
האם מודעות וידאו יוצגו בדף.

אם הערך הוא true, מופעלות הגבלות על החרגת תוכן במודעות לרשת המדיה ובמודעות וידאו.

אם תוכן הווידאו ידוע, צריך להגדיר את videoContentId ואת videoCmsId לערכים שסופקו לשירות הטמעת התוכן של Google Ad Manager כדי להשתמש בהחרגת תוכן במודעות לרשת המדיה.

Optional videoCmsId

videoCmsId?: string
מזהה המקור של תוכן הווידאו.

זהו ערך ייחודי שמוקצה על ידי שירות הטמעת התוכן של Google Ad Manager כדי לזהות את המקור של תוכן הווידאו שצוין על ידי videoContentId.
ראה גם

Optional videoContentId

videoContentId?: string
מזהה התוכן של הסרטון.

זהו ערך ייחודי שמזהה סרטון מסוים ממקור התוכן שצוין על ידי videoCmsId. הערך הזה מוקצה על ידי מערכת ניהול התוכן שמארחת את תוכן הווידאו שלכם.
ראה גם

googletag.enums

זהו מרחב השמות שבו GPT משתמש עבור סוגי enum.
ערכי ספירה
OutOfPageFormat
פורמטים של מודעות מחוץ לדף שנתמכים על ידי GPT.
TrafficSource
מקורות תנועה שנתמכים על ידי GPT.

ערכי ספירה

OutOfPageFormat

OutOfPageFormat
פורמטים של מודעות מחוץ לדף שנתמכים על ידי GPT.
ראה גם
חברים בספירה
AD_INTENTS
הפורמט 'הפניה לחיפושים עם מודעות'.
BOTTOM_ANCHOR
פורמט עוגן שבו מיקום המודעה מוצמד לתחתית אזור התצוגה.
GAME_MANUAL_INTERSTITIAL
פורמט של מודעת מעברון במשחק שמוצגת באופן ידני.

הערה: מודעת מעברון במשחק שמוצגת באופן ידני היא פורמט עם גישה מוגבלת.
INTERSTITIAL
פורמט של קריאייטיב של מעברון באתר.
LEFT_SIDE_RAIL
פורמט של מסילת צד ימנית.
REWARDED
פורמט מודעה מתגמלת.
RIGHT_SIDE_RAIL
פורמט של מעקה צד ימני.
TOP_ANCHOR
פורמט של מודעת עוגן שבה מיקום המודעה נשאר בחלק העליון של אזור התצוגה.

TrafficSource

TrafficSource
מקורות תנועה שנתמכים על ידי GPT.
ראה גם
חברים בספירה
ORGANIC
הזנה ישירה של כתובת URL, חיפוש באתר או הורדה של אפליקציה.
PURCHASED
תנועה שהופנתה מנכסים שאינם בבעלות בעל התוכן הדיגיטלי (פעילות נרכשת או מתומרצת בדרך אחרת).

googletag.events

זהו מרחב השמות שבו GPT משתמש לאירועים. הקוד יכול להגיב לאירועים האלה באמצעות Service.addEventListener.
ממשקים
Event
ממשק בסיסי לכל אירועי GPT.
EventTypeMap
זהו סוג פסאודו שממפה שם של אירוע לסוג האובייקט של האירוע התואם עבור Service.addEventListener ו-Service.removeEventListener.
GameManualInterstitialSlotClosedEvent
האירוע הזה מופעל כשמשתמש סוגר משבצת של מודעת מעברון במדריך למשחק.
GameManualInterstitialSlotReadyEvent
האירוע הזה מופעל כשמשבצת של מודעה מתגמלת במדריך למשחק מוכנה להצגה למשתמש.
ImpressionViewableEvent
האירוע הזה מופעל כשחשיפה הופכת לניתנת לצפייה, בהתאם לקריטריונים של Active View.
RewardedSlotClosedEvent
האירוע הזה מופעל כשמשתמש סוגר משבצת של מודעה מתגמלת.
RewardedSlotGrantedEvent
האירוע הזה מופעל כשמוענק תגמול על צפייה במודעה מתגמלת.
RewardedSlotReadyEvent
האירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה.
RewardedSlotVideoCompletedEvent
האירוע הזה מופעל כשמודעת וידאו מתגמלת מסיימת את ההפעלה.
SlotOnloadEvent
האירוע הזה מופעל כש-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו.
SlotRenderEndedEvent
האירוע הזה מופעל כשקוד הקריאייטיב מוחדר למקום להצגת מודעות.
SlotRequestedEvent
האירוע הזה מופעל כשמתבצעת בקשה להצגת מודעה במשבצת מסוימת.
SlotResponseReceived
האירוע הזה מופעל כשמתקבלת תגובה למודעה במשבצת מסוימת.
SlotVisibilityChangedEvent
האירוע הזה מופעל בכל פעם שמשתנה אחוז השטח של מיקום מודעה שמוצג על המסך.

googletag.events.Event

ממשק בסיסי לכל אירועי GPT. כל אירועי ה-GPT שמופיעים בהמשך יכללו את השדות הבאים.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
ראה גם

מאפיינים

serviceName

serviceName: string
שם השירות שהפעיל את האירוע.

‫slot

slot: Slot
המשבצת שהפעילה את האירוע.

googletag.events.EventTypeMap

זהו סוג פסאודו שממפה שם של אירוע לסוג האובייקט של האירוע התואם עבור Service.addEventListener ו-Service.removeEventListener. הוא מתועד למטרות עיון בלבד, ולמטרות בטיחות סוגים.
מאפיינים
gameManualInterstitialSlotClosed
gameManualInterstitialSlotReady
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
rewardedSlotVideoCompleted
slotOnload
כינוי ל-events.SlotOnloadEvent.
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

מאפיינים

gameManualInterstitialSlotClosed

gameManualInterstitialSlotReady

impressionViewable

impressionViewable: ImpressionViewableEvent
שם אחר ל-events.ImpressionViewableEvent.

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent
כינוי ל-events.RewardedSlotReadyEvent.

rewardedSlotVideoCompleted

slotOnload

slotOnload: SlotOnloadEvent
כינוי ל-events.SlotOnloadEvent.

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent
כינוי ל-events.SlotRenderEndedEvent.

slotRequested

slotRequested: SlotRequestedEvent
כינוי ל-events.SlotRequestedEvent.

slotResponseReceived

slotResponseReceived: SlotResponseReceived
כינוי ל-events.SlotResponseReceived.

slotVisibilityChanged

googletag.events.GameManualInterstitialSlotClosedEvent

הארכה Event
האירוע הזה מופעל כשמשתמש סוגר משבצת של מודעת מעברון עם הוראות למשחק.

הערה: מודעת מעברון עם הוראות למשחק היא פורמט עם גישה מוגבלת.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

‫JavaScript (גרסה קודמת)

// This listener is called when a game manual interstitial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
ראה גם

googletag.events.GameManualInterstitialSlotReadyEvent

הארכה Event
האירוע הזה מופעל כשמשבצת מודעת מעברון של מדריך למשחק מוכנה להצגה למשתמש.

הערה: מודעת מעברון של מדריך למשחק היא פורמט עם גישה מוגבלת.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
Methods
makeGameManualInterstitialVisible
הצגת מודעת מעברון של מדריך המשחק למשתמש.
דוגמה

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

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

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

‫JavaScript (גרסה קודמת)

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) {
    var slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

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

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

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

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

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
ראה גם

Methods

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean
הצגת מודעת מעברון של מדריך המשחק למשתמש. הפונקציה מחזירה את הערך true אם המודעה הוצגה בהצלחה.
החזרות
boolean

googletag.events.ImpressionViewableEvent

הארכה Event
האירוע הזה מופעל כשחשיפה הופכת לניתנת לצפייה, בהתאם לקריטריונים של Active View.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

// 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
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

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

‫JavaScript (גרסה קודמת)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
ראה גם

googletag.events.RewardedSlotGrantedEvent

הארכה Event
האירוע הזה מופעל כשמוענק תגמול על צפייה במודעה מתגמלת. אם המשתמש סוגר את המודעה לפני שהקריטריונים למתן תגמול מתקיימים, האירוע הזה לא יופעל.
מאפיינים
payload
אובייקט שמכיל מידע על התגמול שניתן.
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

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

‫JavaScript (גרסה קודמת)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
ראה גם

מאפיינים

payload

אובייקט שמכיל מידע על התגמול שניתן.

googletag.events.RewardedSlotReadyEvent

הארכה Event
האירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה. המוציא לאור אחראי להציג למשתמש אפשרות לצפות במודעה לפני שהוא מציג אותה.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
Methods
makeRewardedVisible
מציגה את המודעה המתגמלת.
דוגמה

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

‫JavaScript (גרסה קודמת)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
    var slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
ראה גם

Methods

makeRewardedVisible

makeRewardedVisible(): boolean
מציגה את המודעה המתגמלת. אין לקרוא לשיטה הזו עד שהמשתמש יביע הסכמה לצפייה במודעה.
החזרות
booleanהאם המודעה המתגמלת הוצגה בהצלחה.

googletag.events.RewardedSlotVideoCompletedEvent

הארכה Event
האירוע הזה מופעל כשמודעת וידאו מתגמלת מסיימת את ההפעלה.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

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

‫JavaScript (גרסה קודמת)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", function (event) {
    var slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
ראה גם

googletag.events.SlotOnloadEvent

הארכה Event
האירוע הזה מופעל כש-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. כשמעבדים מודעות מדיה עשירה במצב עיבוד סינכרוני, לא נעשה שימוש ב-iframe ולכן לא יופעל SlotOnloadEvent.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

// 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
מזהה הפריט של מודעת ההזמנה שהוצגה.
responseIdentifier
מזהה התגובה הוא מזהה ייחודי של התגובה לבקשת המודעה.
serviceName
שם השירות שהפעיל את האירוע.
size
גודל הקריאייטיב בפיקסלים לאחר העיבוד.
slot
המשבצת שהפעילה את האירוע.
slotContentChanged
אם תוכן המשבצת השתנה בעקבות המודעה שעברה רינדור.
sourceAgnosticCreativeId
מזהה הקריאייטיב של מודעת ההזמנה או המודעה למילוי חוסרים שעברה רינדור.
sourceAgnosticLineItemId
מזהה הפריט של המודעה שהוצגה (מודעה שמורה או מודעה למילוי חוסר).
yieldGroupIds
מזהים של קבוצות התפוקה של המודעה למילוי חוסר שהוצגה.
דוגמה

JavaScript

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

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

‫JavaScript (גרסה קודמת)

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

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

TypeScript

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

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
ראה גם

מאפיינים

advertiserId

advertiserId: number
מזהה המפרסם של המודעה שמוצגת. הערך הוא null למשבצות ריקות, למודעות למילוי חללים ולנכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.

campaignId

campaignId: number
מזהה הקמפיין של המודעה שמוצגת. הערך הוא null למשבצות ריקות, למודעות למילוי חללים ולנכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.

companyIds

companyIds: number[]
מזהים של החברות שהגישו הצעות מחיר על המודעה למילוי חוסרים שמוצגת. הערך הוא null עבור משבצות ריקות, מודעות הזמנה ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.

creativeId

creativeId: number
מזהה הקריאייטיב של מודעת ההזמנה שעברה רינדור. הערך הוא null למשבצות ריקות, למודעות למילוי חללים ולנכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.

creativeTemplateId

creativeTemplateId: number
מזהה תבנית הקריאייטיב של מודעת ההזמנה שעברה עיבוד. הערך הוא null למשבצות ריקות, למודעות למילוי חללים ולנכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.

isBackfill

isBackfill: boolean
האם המודעה הייתה מודעת גיבוי. הערך הוא true אם המודעה הייתה מודעת מילוי שטחי פרסום, ו-false אחרת.

isEmpty

isEmpty: boolean
האם הוחזרה מודעה למיקום המודעה. הערך הוא true אם לא הוחזרה מודעה, ו-false בכל מקרה אחר.

labelIds

labelIds: number[]

lineItemId

lineItemId: number
מזהה הפריט של מודעת ההזמנה שהוצגה. הערך הוא null למשבצות ריקות, למודעות למילוי חללים ולנכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.

responseIdentifier

responseIdentifier: string
מזהה התגובה הוא מזהה ייחודי של התגובה לבקשת המודעה. אפשר להשתמש בערך הזה כדי לזהות ולחסום את המודעה במרכז בקרת המודעות (ARC).

size

size: string | number[]
גודל הקריאייטיב בפיקסלים לאחר העיבוד. דוגמה: [728, 90] הערך הוא null אם משבצת המודעה ריקה.

slotContentChanged

slotContentChanged: boolean
אם תוכן המשבצת השתנה בעקבות המודעה שעברה רינדור. הערך הוא true אם התוכן השתנה, אחרת הערך הוא false.

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number
מזהה הקריאייטיב של מודעת ההזמנה או המודעה למילוי חוסרים שעברה רינדור. הערך הוא null אם המודעה לא מוצגת בהזמנה או במילוי חוסרים של פריט, או אם הקריאייטיב מוצג על ידי שירותים אחרים חוץ מ-PubAdsService.

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number
מזהה הפריט של המודעה שהוצגה (מודעה שמורה או מודעה למילוי חוסר). הערך הוא null אם המודעה לא מוצגת בהזמנה או במילוי חוסרים של פריט, או אם הקריאייטיב מוצג על ידי שירותים אחרים חוץ מ-PubAdsService.

yieldGroupIds

yieldGroupIds: number[]
מזהים של קבוצות התפוקה של המודעה למילוי חוסר שהוצגה. הערך הוא null עבור משבצות ריקות, מודעות הזמנה ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.

googletag.events.SlotRequestedEvent

הארכה Event
האירוע הזה מופעל כשמתבצעת בקשה להצגת מודעה במשבצת מסוימת.
מאפיינים
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
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
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

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

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

‫JavaScript (גרסה קודמת)

// 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
אחוז השטח של המודעה שגלוי למשתמש.
serviceName
שם השירות שהפעיל את האירוע.
slot
המשבצת שהפעילה את האירוע.
דוגמה

JavaScript

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

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

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

‫JavaScript (גרסה קודמת)

// 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
אחוז השטח של המודעה שגלוי למשתמש. הערך הוא מספר בין 0 ל-100.

googletag.secureSignals

זהו מרחב השמות שבו GPT משתמש לניהול אותות מאובטחים.
ממשקים
BidderSignalProvider
מחזירה אות מאובטח עבור משתתף ספציפי במכרז.
PublisherSignalProvider
מחזירה אות מאובטח למוציא לאור ספציפי.
SecureSignalProvidersArray
ממשק לניהול אותות מאובטחים.
סוג כינויים
SecureSignalProvider
ממשק להחזרת אות מאובטח למגיש הצעות מחיר או לספק ספציפיים.

סוג כינויים

SecureSignalProvider

ממשק להחזרת אות מאובטח למגיש הצעות מחיר או לספק ספציפיים. צריך לציין את id או את networkCode, אבל לא את שניהם.

googletag.secureSignals.BidderSignalProvider

מחזירה אות מאובטח למגיש הצעות מחיר ספציפי.

ספק אותות מאובטחים למגישי הצעות מחיר מורכב מ-2 חלקים:

  1. פונקציית איסוף שמחזירה Promise שמוביל לאות מאובטח.
  2. id שמזהה את המגיש של הצעת המחיר שמשויך לאות.
כדי להחזיר אות מאובטח לבעל תוכן דיגיטלי, צריך להשתמש במקום זאת ב-secureSignals.PublisherSignalProvider.
מאפיינים
collectorFunction
פונקציה שמחזירה Promise שמומר לאות מאובטח.
id
מזהה ייחודי של כלי האיסוף שמשויך לאות המאובטח הזה, כפי שנרשם ב-Google Ad Manager.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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>)
פונקציה שמחזירה Promise שמומר לאות מאובטח.

id

id: string
מזהה ייחודי של כלי האיסוף שמשויך לאות המאובטח הזה, כפי שנרשם ב-Google Ad Manager.

googletag.secureSignals.PublisherSignalProvider

מחזירה אות מאובטח למוציא לאור ספציפי.

ספק אותות של מוציא לאור מורכב מ-2 חלקים:

  1. פונקציית איסוף שמחזירה Promise שמוביל לאות מאובטח.
  2. networkCode שמזהה את בעל התוכן הדיגיטלי שמשויך לאות.
כדי להחזיר אות מאובטח למגיש הצעות מחיר, צריך להשתמש במקום זאת ב-secureSignals.BidderSignalProvider.
מאפיינים
collectorFunction
פונקציה שמחזירה Promise שמומר לאות מאובטח.
networkCode
קוד הרשת (כפי שמופיע בנתיב של יחידת המודעות) של בעל התוכן הדיגיטלי שמשויך לאות המאובטח הזה.
דוגמה

JavaScript

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

‫JavaScript (גרסה קודמת)

// 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>)
פונקציה שמחזירה Promise שמומר לאות מאובטח.

networkCode

networkCode: string
קוד הרשת (כפי שמופיע בנתיב של יחידת המודעות) של בעל התוכן הדיגיטלי שמשויך לאות המאובטח הזה.

googletag.secureSignals.SecureSignalProvidersArray

ממשק לניהול אותות מאובטחים.
Methods
clearAllCache
מנקה את כל האותות של כל האוספים מהמטמון.
push
מוסיפה secureSignals.SecureSignalProvider חדש למערך ספקי האותות ומתחילה את תהליך יצירת האותות.

Methods

clearAllCache

clearAllCache(): void
מחיקת כל האותות מכל אמצעי האיסוף מהמטמון.

הפעלת השיטה הזו עשויה להקטין את הסיכוי שאותות ייכללו בבקשות להצגת מודעות בתצוגות הדפים הנוכחיות ובתצוגות דפים עתידיות. לכן, צריך להפעיל את הפונקציה הזו רק כשמתרחשים שינויים משמעותיים במצב, כמו אירועים שמציינים משתמש חדש (כניסה, יציאה, הרשמה וכו').

push

push(provider: SecureSignalProvider): void
מוסיפה secureSignals.SecureSignalProvider חדש למערך ספקי האותות ומתחילה את תהליך יצירת האותות.
פרמטרים
provider: SecureSignalProviderהאובייקט secureSignals.SecureSignalProvider שרוצים להוסיף למערך.