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

---

googletag

מרחב השמות הגלובלי שבו Google Publisher Tag משתמש ל-API שלו.

מרחבי שמות
config	ממשק ההגדרות הראשי להגדרות ברמת הדף.
enums	זהו מרחב השמות שבו נעשה שימוש ב-GPT לסוגים של enum.
events	זהו מרחב השמות שבו GPT משתמש לאירועים.
secureSignals	זהו מרחב השמות שבו GPT משתמש לניהול אותות מאובטחים.

ממשקים
CommandArray	מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר.
CompanionAdsService	שירות המודעות הנלווים.
PrivacySettingsConfig	אובייקט תצורה של הגדרות הפרטיות.
PubAdsService	שירות מודעות של בעלי תוכן דיגיטלי.
ResponseInformation	אובייקט שמייצג תגובה יחידה למודעה.
RewardedPayload	אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת.
SafeFrameConfig	אובייקט תצורה לקונטיינרים של SafeFrame.
Service	סוג שירות בסיסי שמכיל שיטות שקיימות בכל השירותים.
SizeMappingBuilder	ה-builder של אובייקטים של מפרטי מיפוי גדלים.
Slot	משבצת היא אובייקט שמייצג משבצת מודעה אחת בדף.

כינויים מסוג טקסט
GeneralSize	הגדרת גודל תקינה של חריץ, שיכולה להיות גודל אחד או כמה גדלים.
MultiSize	רשימה של גדלים חוקיים בודדים.
NamedSize	גדלים מוגדרים שיכולים להיות לשקע.
SingleSize	גודל חוקי אחד למשבצת.
SingleSizeArray	מערך של שני מספרים שמייצגים את [width, height].
SizeMapping	מיפוי של גודל אזור התצוגה לגדלי מודעות.
SizeMappingArray	רשימה של מיפויים של גדלים.

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

פונקציות
companionAds	הפונקציה מחזירה הפניה ל-CompanionAdsService.
defineOutOfPageSlot	יצירת מיקום מודעה מחוץ לדף לפי נתיב יחידת המודעות שצוין.
defineSlot	היצירה של מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות, ושיוכה למזהה של רכיב div בדף שיכיל את המודעה.
destroySlots	הפונקציה משמידה את ה-slots שצוינו, ומסירה את כל האובייקטים וההפניות שקשורים ל-slots האלה מ-GPT.
disablePublisherConsole	השבתת Google Publisher Console.
display	נותן הוראות לשירותי יצירת המודעות להציג את המודעות במודעות הווידאו.
enableServices	הפעלת כל שירותי ה-GPT שהוגדרו למיקומי המודעות בדף.
getVersion	הפונקציה מחזירה את הגרסה הנוכחית של GPT.
openConsole	פותח את מסוף Google Publisher.
pubads	הפונקציה מחזירה הפניה ל-PubAdsService.
setAdIframeTitle	הגדרת הכותרת לכל תגי iframe של מאגרי מודעות שנוצרו על ידי PubAdsService, החל מנקודה זו ואילך.
setConfig	הגדרת אפשרויות תצורה כלליות לדף.
sizeMapping	יצירת SizeMappingBuilder חדש.

כינויים מסוג טקסט

---

GeneralSize

GeneralSize: SingleSize | MultiSize

הגדרת גודל תקינה של חריץ, שיכולה להיות גודל אחד או כמה גדלים.

---

MultiSize

MultiSize: SingleSize[]

רשימה של גדלים חוקיים בודדים.

---

NamedSize

NamedSize: "fluid" | ["fluid"]

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

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

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

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

---

SingleSizeArray

SingleSizeArray: [number, number]

מערך של שני מספרים שמייצגים את [width, height].

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

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

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

רשימה של מיפויים של גדלים.

משתנים

---

Const apiReady

apiReady: boolean | undefined

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

הערה: הדרך המומלצת לטיפול באירועים אסינכרונים היא להשתמש ב-googletag.cmd כדי להוסיף לתור קריאות חזרה (callbacks) שיופעלו כש-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");

ראה גם

• תחילת העבודה עם Google Publisher Tags

פרמטרים
adUnitPath: string	נתיב יחידת המודעות המלא, עם קוד הרשת וקוד היחידה.
size: GeneralSize	הרוחב והגובה של המיקום שנוסף. זהו הגודל שבו נעשה שימוש בבקשה להצגת מודעה אם לא סופק מיפוי של גדלים רספונסיביים או אם גודל שדה התצוגה קטן מהגודל הקטן ביותר שסופק במיפוי.
Optional div: string	המזהה של ה-div שיכיל את יחידת המודעות הזו.

החזרות
Slot | null	המשבצת החדשה שנוצרה, או null אם לא ניתן ליצור משבצת.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

הפונקציה משמידה את ה-slots שצוינו, ומסירה את כל האובייקטים וההפניות שקשורים ל-slots האלה מ-GPT. ה-API הזה לא תומך במודעות 'העברה אוטומטית (passback)' ובמודעות 'מודעות נלווה'.

קריאה ל-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 אם ה-slots הושמדו, false אחרת.

---

disablePublisherConsole

disablePublisherConsole(): void

השבתת Google Publisher Console.

ראה גם

• Google Publisher Console

---

display

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

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

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

ראה גם

• תחילת העבודה עם Google Publisher Tags
• הצגת מודעת בדיקה
• שליטה בטעינת המודעות וברענון שלהן

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

---

enableServices

enableServices(): void

הפעלת כל שירותי ה-GPT שהוגדרו למיקומי המודעות בדף.

---

getVersion

getVersion(): string

הפונקציה מחזירה את הגרסה הנוכחית של GPT.

ראה גם

• היסטוריית הגרסאות של GPT

החזרות
string	מחרוזת הגרסה של GPT שפועלת כרגע.

---

openConsole

openConsole(div?: string): void

פותח את מסוף Google Publisher.

דוגמה

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

ראה גם

• Google Publisher Console

פרמטרים
Optional div: string	מזהה div של מיקום מודעה. הערך הזה הוא אופציונלי. אם תספקו את הפרטים, מערכת Publisher Console תנסה לפתוח את הדף עם הפרטים של מיקום המודעה שצוין.

---

pubads

pubads(): PubAdsService

הפונקציה מחזירה הפניה ל-PubAdsService.

החזרות
PubAdsService	השירות 'מודעות בתכנים של בעלי תוכן דיגיטלי'.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

הגדרת השם של כל תגי iframe של מאגרי מודעות שנוצרו על ידי 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	ה-builder החדש.

---

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	הרשמה של מאזין שמאפשר להגדיר פונקציית JavaScript ולקרוא לה כשאירוע GPT ספציפי מתרחש בדף. הועברה בירושה מ-Service.addEventListener
getSlots	הצגת רשימת המקומות שמשויכים לשירות הזה. הועברה בירושה מ-Service.getSlots
removeEventListener	הסרת מעבד אירועים שרשום בעבר. הועברה בירושה מ-Service.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?: null | boolean

מציין אם הדף צריך להיחשב כתוכן לילדים. מגדירים את הערך null כדי למחוק את ההגדרה.

---

Optional limitedAds

limitedAds?: boolean

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

יש שתי דרכים להורות ל-GPT לבקש מודעות מוגבלות:

• באופן אוטומטי, באמצעות אות מפלטפורמה לניהול הסכמה של TCF בגרסה 2.0 של IAB.
• באופן ידני, על ידי הגדרת הערך של השדה הזה כ-true.

אפשר להגדיר מודעות מוגבלות באופן ידני רק כש-GPT נטען מכתובת ה-URL של המודעות המוגבלות. ניסיון לשנות את ההגדרה הזו כש-GPT נטען מכתובת ה-URL הרגילה יגרום לאזהרה ב-Publisher Console.

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

דוגמה

JavaScript

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

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?: null | boolean

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

---

googletag.PubAdsService

הארכה של Service

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

Methods
addEventListener	הרשמה של מאזין שמאפשר להגדיר פונקציית JavaScript ולקרוא לה כשאירוע GPT ספציפי מתרחש בדף. הועברה בירושה מ-Service.addEventListener
clear	הסרת המודעות מהמשבצות הנתונות והחלפתן בתוכן ריק.
clearCategoryExclusions	מחיקת כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף.
clearTargeting	מחיקת פרמטרים של טירגוט מותאם אישית למפתח ספציפי או לכל המפתחות.
collapseEmptyDivs	מאפשרת לכווץ divs של משבצות כדי שהן לא יתפסו מקום בדף כשאין תוכן של מודעות להצגה.
disableInitialLoad	ההגדרה משביתה בקשות להצגת מודעות במהלך טעינת הדף, אבל מאפשרת לבקש הצגת מודעות באמצעות קריאה ל-PubAdsService.refresh.
display	יצירת מקום מודעה והצגתו עם הנתיב והגודל של יחידת המודעות שצוינו.
enableLazyLoad	הפעלת טעינה איטית ב-GPT כפי שהוגדרה באובייקט התצורה.
enableSingleRequest	הפעלת מצב בקשה יחידה לאחזור כמה מודעות בו-זמנית.
enableVideoAds	האותות מסמנים ל-GPT שמודעות וידאו יופיעו בדף.
get	הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון.
getAttributeKeys	הפונקציה מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
getSlots	הצגת רשימת המקומות שמשויכים לשירות הזה. הועברה בירושה מ-Service.getSlots
getTargeting	הפונקציה מחזירה פרמטר טירגוט מותאם אישית ספציפי ברמת השירות שהוגדר.
getTargetingKeys	הפונקציה מחזירה רשימה של כל מפתחות הטירגוט בהתאמה אישית ברמת השירות שהוגדרו.
isInitialLoadDisabled	הפונקציה מחזירה את הערך 'true' אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad, או את הערך 'false' אם לא.
refresh	אחזור והצגה של מודעות חדשות במיקומים ספציפיים בדף או בכל המיקומים בדף.
removeEventListener	הסרת מעבד אירועים שרשום בעבר. הועברה בירושה מ-Service.removeEventListener
set	הגדרת ערכים למאפייני AdSense שחלים על כל שטחי המודעות בשירות 'מודעות של בעלי תוכן דיגיטלי'.
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	אובייקט השירות שאליו הופעל ה-method.

---

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	אובייקט השירות שאליו הופעל ה-method.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

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

ראה גם

• כיווץ של מיקומי מודעות ריקים
• צמצום השינויים בפריסת המודעות

פרמטרים
Optional collapseBeforeAdFetch: boolean	האם לכווץ את המיקומים עוד לפני אחזור המודעות. הפרמטר הזה הוא אופציונלי. אם לא מציינים אותו, הערך false ישמש כערך ברירת המחדל.

החזרות
boolean	הפונקציה מחזירה את הערך true אם מצב הכיווץ של div הופעל, ואת הערך false אם אי אפשר להפעיל את מצב הכיווץ כי השיטה הוזמנה אחרי שהשירות הופעל.

---

disableInitialLoad

disableInitialLoad(): void

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

ראה גם

• שליטה בטעינת המודעות וברענון שלהן
• שליטה בקיבוץ של מודעות RSA

---

display

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

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

הערה: כשקוראים לשיטה הזו, נוצרת תמונת מצב של המיקום והדף כדי להבטיח עקביות בשליחת הבקשה להצגת מודעה ובעיבוד התגובה. שינויים שיתבצעו במצב של היחידה או הדף אחרי הקריאה ל-method הזה (כולל טירגוט, הגדרות פרטיות, אילוץ 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 שמכיל את ה-slot או רכיב ה-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 פירושו 'כשהמודעה נמצאת במרחק 1 שטח תצוגה' וכן הלאה. renderMarginPercent המרחק המינימלי מהאזור המוצג הנוכחי שבו צריך להיות מיקום מודעה לפני שאנחנו מריצים רינדור של מודעה. כך אפשר לבצע אחסון מראש של המודעה, אבל להמתין לעיבוד ולהורדה של משאבי משנה אחרים. הערך פועל בדיוק כמו fetchMarginPercent כאחוז מחלון התצוגה. mobileScaling מכפיל שמוחל על השוליים במכשירים ניידים. כך אפשר להגדיר שוליים שונים בניידים ובמחשבים. לדוגמה, ערך של 2.0 יגרום להכפלת כל השוליים פי 2 במכשירים ניידים, וכך יגדל המרחק המינימלי שיכול להיות בין חריץ לבין אחזור ורינדור.

---

enableSingleRequest

enableSingleRequest(): boolean

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

ראה גם

• שיטות מומלצות ב-Google Ads: שימוש נכון בארכיטקטורה של בקשה יחידה
• שליטה בקיבוץ של מודעות RSA

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

---

enableVideoAds

enableVideoAds(): void

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

---

get

get(key: string): null | 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'.

ראה גם

• מאפייני AdSense

פרמטרים
key: string	שם המאפיין שרוצים לחפש.

החזרות
null | 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

הפונקציה מחזירה את הערך 'true' אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad, או את הערך 'false' אם לא.

החזרות
boolean	הפונקציה מחזירה את הערך true אם קריאה קודמת ל-PubAdsService.disableInitialLoad הייתה מוצלחת, ואת הערך false במקרים אחרים.

---

רענון

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

---

set

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

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

קריאה ל-setAdSenseAttributes יותר מפעם אחת עבור אותו מפתח תחליף את הערכים שהוגדרו קודם לכן למפתח הזה. צריך להגדיר את כל הערכים לפני שמפעילים את 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");

ראה גם

• מאפייני AdSense

פרמטרים
key: string	שם המאפיין.
value: string	ערך המאפיין.

החזרות
PubAdsService	אובייקט השירות שאליו הופעל ה-method.

---

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	אובייקט השירות שאליו הופעל ה-method.

---

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

ראה גם

• עיבוד נכסי קריאייטיב באמצעות SafeFrame

פרמטרים
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	אובייקט השירות שאליו הופעל ה-method.

---

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	אובייקט השירות שאליו הופעל ה-method.

---

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

ראה גם

• עיבוד נכסי קריאייטיב באמצעות SafeFrame

פרמטרים
config: SafeFrameConfig	אובייקט התצורה.

החזרות
PubAdsService	אובייקט השירות שאליו הופעל ה-method.

---

setTargeting

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

הגדרת פרמטרים מותאמים אישית של טירגוט למפתח נתון שחלים על כל שטחי הפרסום בשירות Publisher Ads. קריאה ל-setMultiple פעמים לאותו מפתח תגרום להחליף את הערכים הישנים. המפתחות האלה מוגדרים בחשבון 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	אובייקט השירות שאליו הופעל ה-method.

---

setVideoContent

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

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

ראה גם

• פרמטרים של כתובות URL של תגי מודעות VAST

פרמטרים
videoContentId: string	מזהה התוכן של הסרטון.
videoCmsId: string	מזהה ה-CMS של הסרטון.

---

updateCorrelator

updateCorrelator(): PubAdsService

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

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

דוגמה

JavaScript

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

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

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

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	המזהה של הפריט.

ראה גם

• Slot.getResponseInformation

מאפיינים

---

advertiserId

advertiserId: null | number

המזהה של המפרסם.

---

campaignId

campaignId: null | number

המזהה של הקמפיין.

---

creativeId

creativeId: null | number

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

---

creativeTemplateId

creativeTemplateId: null | number

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

---

lineItemId

lineItemId: null | number

המזהה של הפריט.

---

googletag.RewardedPayload

אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת

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

ראה גם

• הצגת מודעה מתגמלת

מאפיינים

---

amount

amount: number

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

---

type

type: string

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

---

googletag.SafeFrameConfig

אובייקט תצורה לקונטיינרים של SafeFrame.

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

ראה גם

• PubAdsService.setSafeFrameConfig

מאפיינים

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

האם SafeFrame יאפשר לתוכן המודעה להתרחב על ידי שכבת-על של תוכן הדף.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

האם SafeFrame יאפשר לתוכן המודעה להתרחב על ידי דחיפת תוכן הדף.

---

Optional sandbox

sandbox?: boolean

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

---

Optional useUniqueDomain

useUniqueDomain?: null | boolean

אם מערכת SafeFrame תשתמש בתת-דומיינים אקראיים לנכסי קריאייטיב במכירה ישירה לא פרוגרמטית. מעבירים את הערך null כדי לנקות את הערך השמור.

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

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

ראה גם

• עיבוד נכסי קריאייטיב באמצעות SafeFrame

---

googletag.Service

סוג שירות בסיסי שמכיל שיטות שקיימות בכל השירותים.

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

Methods

---

addEventListener

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

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

• events.GameManualInterstitialSlotClosedEvent
• events.GameManualInterstitialSlotReadyEvent
• events.ImpressionViewableEvent
• events.RewardedSlotClosedEvent
• events.RewardedSlotGrantedEvent
• events.RewardedSlotReadyEvent
• events.SlotOnloadEvent
• events.SlotRenderEndedEvent
• events.SlotRequestedEvent
• events.SlotResponseReceived
• events.SlotVisibilityChangedEvent

אובייקט מסוג האירוע המתאים מועבר ל-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.
  }
});

ראה גם

• פונקציות מסוג Event Listener של מודעות

פרמטרים
eventType: K	מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות.
listener: ((arg: EventTypeMap[K]) => void)	פונקציה שמקבלת ארגומנט של אובייקט אירוע יחיד.

החזרות
Service	אובייקט השירות שאליו הופעל ה-method.

---

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

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

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 < 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 < 640x480
  .build();

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

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

TypeScript

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

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

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

פרמטרים
viewportSize: SingleSizeArray	הגודל של אזור התצוגה של רשומת המיפוי הזו.
slotSize: GeneralSize	הגדלים של החריץ של רשומת המיפוי הזו.

החזרות
SizeMappingBuilder	הפניה ל-builder הזה.

---

build

build(): null | SizeMappingArray

יצירת מפרט של מפת גודל מהמיפויים שנוספו ל-builder הזה.

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

הערה: ההתנהגות של ה-builder אחרי הקריאה לשיטה הזו לא מוגדרת.

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

---

googletag.Slot

משבצת היא אובייקט שמייצג משבצת מודעה אחת בדף.

Methods
addService	הוספת שירות למשבצת הזו.
clearCategoryExclusions	הפונקציה מנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת המיקום המודעה.
clearTargeting	מחיקת פרמטרים ספציפיים או את כל הפרמטרים של טירגוט מותאם אישית ברמת המיקום המודעה עבור המיקום הזה.
defineSizeMapping	הגדרת מערך של מיפויים מגודל מינימלי של אזור תצוגה לגודל חריץ עבור החריץ הזה.
get	הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון עבור המשבצת הזו.
getAdUnitPath	הפונקציה מחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת ונתיב יחידת המודעות.
getAttributeKeys	הפונקציה מחזירה את רשימת מפתחות המאפיינים שהוגדרו בחריץ הזה.
getCategoryExclusions	הפונקציה מחזירה את תוויות ההחרגה של קטגוריות המודעות עבור המיקום הזה.
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());

ראה גם

• תחילת העבודה עם Google Publisher Tags
• הצגת מודעת בדיקה

פרמטרים
service: Service	השירות שרוצים להוסיף.

החזרות
Slot	אובייקט החריץ שאליו ה-method נקרא.

---

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	אובייקט החריץ שאליו ה-method נקרא.

---

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	אובייקט החריץ שאליו ה-method נקרא.

---

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	אובייקט השקע שאליו ה-method נקרא.

---

get

get(key: string): null | 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'.

ראה גם

• מאפייני AdSense

פרמטרים
key: string	שם המאפיין שרוצים לחפש.

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

---

getResponseInformation

getResponseInformation(): null | ResponseInformation

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

החזרות
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

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

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

קריאה ל-method הזה יותר מפעם אחת עבור אותו מפתח תבטל את הערכים שהוגדרו בעבר למפתח הזה. צריך להגדיר את כל הערכים לפני שמפעילים את 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());

ראה גם

• מאפייני AdSense

פרמטרים
key: string	שם המאפיין.
value: string	ערך המאפיין.

החזרות
Slot	אובייקט השקע שאליו ה-method נקרא.

---

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	אובייקט השקע שאליו ה-method נקרא.

---

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	אובייקט השקע שאליו ה-method נקרא.

---

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	אובייקט השקע שאליו ה-method נקרא.

---

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

ראה גם

• עיבוד נכסי קריאייטיב באמצעות SafeFrame

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

החזרות
Slot	אובייקט השקע שאליו ה-method נקרא.

---

setSafeFrameConfig

setSafeFrameConfig(config: null | 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");

ראה גם

• עיבוד נכסי קריאייטיב באמצעות SafeFrame

פרמטרים
config: null | SafeFrameConfig	אובייקט התצורה.

החזרות
Slot	אובייקט השקע שאליו ה-method נקרא.

---

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	אובייקט החריץ שאליו ה-method נקרא.

---

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	אובייקט החריץ שאליו ה-method נקרא.

---

googletag.config

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

ממשקים
AdExpansionConfig	הגדרות לשלוט בהרחבת המודעות.
ComponentAuctionConfig	אובייקט שמייצג מכרז של רכיב יחיד במכרז מודעות במכשיר.
InterstitialConfig	אובייקט שמגדיר את ההתנהגות של משבצת מודעה אחת מסוג מעברון.
PageSettingsConfig	ממשק ההגדרות הראשי להגדרות ברמת הדף.
PrivacyTreatmentsConfig	הגדרות לניהול הטיפול בפרטיות של בעלי תוכן דיגיטלי.
PublisherProvidedSignalsConfig	אובייקט תצורה של אותות שמספקים בעלי תוכן דיגיטלי (PPS).
SlotSettingsConfig	ממשק התצורה הראשי להגדרות ברמת השקע.
TaxonomyData	אובייקט שמכיל את הערכים של טקסונומיה אחת.

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

כינויים מסוג טקסט

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"

טריגרים נתמכים של מודעות מעברון.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

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

---

טקסונומיה

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

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

ראה גם

• טקסונומיית הקהלים של IAB 1.1
• טקסונומיית התוכן של IAB 2.2

---

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?: null | boolean

מצב ההפעלה של התכונה 'הרחבת מודעות'.

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

ראה גם

• הרחבת המודעות במחשב ובטאבלט
• הרחבת מודעות באתרים לנייד (מסך חלקי)

---

googletag.config.ComponentAuctionConfig

אובייקט שמייצג מכרז של רכיב יחיד במכרז מודעות במכשיר.

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

ראה גם

• מדריך למוכרים ב-Protected Audience API: הפעלת מכרזים של מודעות

מאפיינים

---

auctionConfig

auctionConfig: null | {
  auctionSignals?: unknown;
  decisionLogicURL: string;
  interestGroupBuyers?: string[];
  perBuyerExperimentGroupIds?: {
    [buyer: string]: number;
  };
  perBuyerGroupLimits?: {
    [buyer: string]: number;
  };
  perBuyerSignals?: {
    [buyer: string]: unknown;
  };
  perBuyerTimeouts?: {
    [buyer: string]: number;
  };
  seller: string;
  sellerExperimentGroupId?: number;
  sellerSignals?: unknown;
  sellerTimeout?: number;
  trustedScoringSignalsURL?: string;
}

אובייקט של הגדרת מכרז למכרז הרכיב הזה.

אם הערך הזה מוגדר כ-null, כל הגדרה קיימת של configKey שצוין תימחק.

דוגמה

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

ראה גם

• Protected Audience API: הפעלת מכרז במכשיר

---

configKey

configKey: string

מפתח התצורה שמשויך למכרז הרכיב הזה.

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

---

googletag.config.InterstitialConfig

אובייקט שמגדיר את ההתנהגות של משבצת מודעה אחת מסוג מעברון.

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

מאפיינים

---

Optional requireStorageAccess

requireStorageAccess?: null | 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?: null | 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.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?	הגדרות לשלוט בהרחבת המודעות.
adYield?	הוצא משימוש.
pps?	הגדרות לניהול אותות שמספקים בעלי תוכן דיגיטלי (PPS).
privacyTreatments?	הגדרות לניהול הטיפול בפרטיות של בעלי תוכן דיגיטלי.
threadYield?	הגדרה שמאפשרת לקבוע אם GPT יספק את שרשור ה-JS בזמן עיבוד הקריאייטיב.

מאפיינים

---

Optional adExpansion

adExpansion?: null | AdExpansionConfig

הגדרות לשלוט בהרחבת המודעות.

---

Optional adYield

adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

הוצאה משימוש: במקום זאת, צריך להשתמש ב-threadYield. האפשרות הזו תוסר בעתיד הקרוב.

---

Optional pps

pps?: null | PublisherProvidedSignalsConfig

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

---

Optional privacyTreatments

privacyTreatments?: null | PrivacyTreatmentsConfig

הגדרות לניהול הטיפול בפרטיות של בעלי תוכן דיגיטלי.

---

Optional threadYield

threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

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

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

הערכים הנתמכים:

• null (ברירת המחדל): GPT יספק את שרשור ה-JS למיקומים מחוץ לאזור התצוגה.
• ENABLED_ALL_SLOTS: GPT יעביר את שרשור ה-JS לכל המודעות, גם אם הן לא נמצאות בחלון התצוגה.
• DISABLED: GPT לא יניב את שרשור ה-JS.

דוגמה

JavaScript

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

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

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

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

ראה גם

• Scheduler

---

googletag.config.PrivacyTreatmentsConfig

הגדרות לניהול הטיפול בפרטיות של בעלי תוכן דיגיטלי.

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

מאפיינים

---

טיפולים

treatments: null | "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	אובייקט שמכיל מיפויים של טקסונומיה.

דוגמה

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

ראה גם

• מידע על אותות שמספקים בעלי תוכן דיגיטלי (בטא)
• טקסונומיית הקהלים של IAB 1.1
• טקסונומיית התוכן של IAB 2.2

מאפיינים

---

טקסונומיות

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

אובייקט שמכיל מיפויים של טקסונומיה.

---

googletag.config.SlotSettingsConfig

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

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

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

דוגמאות:

• רק התכונות שצוינו בקריאה Slot.setConfig משתנות.

    const slot = googletag.defineSlot("/1234567/example", [160, 600]);
  
    // Configure feature alpha.
    slot.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    slot.setConfig({
       bravo: {...}
    });

• כל ההגדרות של תכונה מסוימת מתעדכנות בכל קריאה ל-Slot.setConfig.

    // Configure feature charlie to echo = 1, foxtrot = true.
    slot.setConfig({
        charlie: {
            echo: 1,
            foxtrot: true,
        }
    });
  
    // Update feature charlie to echo = 2. Since foxtrot was not specified,
    // the value is cleared.
    slot.setConfig({
        charlie: {
            echo: 2
        }
    });

• כדי לנקות את כל ההגדרות של תכונה מסוימת, מעבירים את הערך null.

    // Configure features delta, golf, and hotel.
    slot.setConfig({
        delta: {...},
        golf: {...},
        hotel: {...},
    });
  
    // Feature delta and hotel are cleared, but feature golf remains set.
    slot.setConfig({
        delta: null,
        hotel: null,
    });

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

מאפיינים

---

Optional adExpansion

adExpansion?: null | AdExpansionConfig

הגדרות לשלוט בהרחבת המודעות.

---

Optional componentAuction

componentAuction?: null | ComponentAuctionConfig[]

מערך של מכרזי רכיבים שכלולים במכרז של מודעה במכשיר.

---

Optional מודעות מעבר

interstitial?: null | InterstitialConfig

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

---

googletag.config.TaxonomyData

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

מאפיינים
values	רשימה של ערכים של Taxonomy.

מאפיינים

---

values

values: string[]

רשימה של ערכים של Taxonomy.

---

googletag.enums

זהו מרחב השמות שבו נעשה שימוש ב-GPT לסוגים של enum.

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

ערכים מספריים

---

OutOfPageFormat

OutOfPageFormat

פורמטים מחוץ לדף שנתמכים ב-GPT.

ראה גם

• defineOutOfPageSlot

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

---

TrafficSource

TrafficSource

מקורות תנועה שנתמכים ב-GPT.

ראה גם

• PrivacySettingsConfig.trafficSource

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

---

googletag.events

זהו מרחב השמות שבו GPT משתמש לאירועים. הקוד יכול להגיב לאירועים האלה באמצעות Service.addEventListener.

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

---

googletag.events.Event

ממשק בסיס לכל אירועי ה-GPT. כל האירועים הבאים של GPT יכללו את השדות הבאים.

מאפיינים
serviceName	שם השירות שהפעיל את האירוע.
slot	השקע שהפעיל את האירוע.

ראה גם

• פונקציות מסוג Event Listener של מודעות

מאפיינים

---

serviceName

serviceName: string

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

---

slot

slot: Slot

השקע שהפעיל את האירוע.

---

googletag.events.EventTypeMap

זהו פסאודו-סוג שממפה שם אירוע לסוג אובייקט האירוע התואם שלו עבור Service.addEventListener ו-Service.removeEventListener. הוא מתועד למטרות עיון ובטיחות סוג בלבד.

מאפיינים
gameManualInterstitialSlotClosed	כינוי ל-events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	כינוי ל-events.GameManualInterstitialSlotReadyEvent.
impressionViewable	כינוי ל-events.ImpressionViewableEvent.
rewardedSlotClosed	כינוי ל-events.RewardedSlotClosedEvent.
rewardedSlotGranted	כינוי ל-events.RewardedSlotGrantedEvent.
rewardedSlotReady	כינוי ל-events.RewardedSlotReadyEvent.
slotOnload	כינוי ל-events.SlotOnloadEvent.
slotRenderEnded	כינוי ל-events.SlotRenderEndedEvent.
slotRequested	כינוי ל-events.SlotRequestedEvent.
slotResponseReceived	כינוי ל-events.SlotResponseReceived.
slotVisibilityChanged	כינוי ל-events.SlotVisibilityChangedEvent.

מאפיינים

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

כינוי ל-events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

כינוי ל-events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

כינוי ל-events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

כינוי ל-events.RewardedSlotClosedEvent.

---

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

כינוי ל-events.RewardedSlotGrantedEvent.

---

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

כינוי ל-events.RewardedSlotReadyEvent.

---

slotOnload

slotOnload: SlotOnloadEvent

כינוי ל-events.SlotOnloadEvent.

---

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

כינוי ל-events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

כינוי ל-events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

כינוי ל-events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

כינוי ל-events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

הארכה של Event

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

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

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
    }
  });
}

ראה גם

• פונקציות מסוג Event Listener של מודעות
• הצגת מודעה מעברון עם מדריך למשחק

---

googletag.events.GameManualInterstitialSlotReadyEvent

הארכה של Event

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

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

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
    }
  });
}

ראה גם

• פונקציות מסוג Event Listener של מודעות
• הצגת מודעה מעברון עם מדריך למשחק

Methods

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void

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

---

googletag.events.ImpressionViewableEvent

הארכה של Event

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

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
  }
});

ראה גם

• פונקציות מסוג Event Listener של מודעות

---

googletag.events.RewardedSlotClosedEvent

הארכה של Event

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

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
    }
  });
}

ראה גם

• פונקציות מסוג Event Listener של מודעות
• הצגת מודעה מתגמלת

---

googletag.events.RewardedSlotGrantedEvent

הארכה של Event

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

מאפיינים
payload	אובייקט שמכיל מידע על התגמול שהוענק.
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
    }
  });
}

ראה גם

• פונקציות מסוג Event Listener של מודעות
• הצגת מודעה מתגמלת

מאפיינים

---

payload

payload: null | RewardedPayload

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

---

googletag.events.RewardedSlotReadyEvent

הארכה של Event

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

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
    }
  });
}

ראה גם

• פונקציות מסוג Event Listener של מודעות
• הצגת מודעה מתגמלת

Methods

---

makeRewardedVisible

makeRewardedVisible(): void

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

---

googletag.events.SlotOnloadEvent

הארכה של Event

האירוע הזה מופעל כשה-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. כשמריצים מודעות מדיה עשירה במצב עיבוד מסונכרן, לא נעשה שימוש ב-iframe ולכן לא יופעל SlotOnloadEvent.

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
  }
});

ראה גם

• פונקציות מסוג Event Listener של מודעות

---

googletag.events.SlotRenderEndedEvent

הארכה של Event

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

מאפיינים
advertiserId	מזהה המפרסם של המודעה שעבר רינדור.
campaignId	מזהה הקמפיין של המודעה שעבר רינדור.
companyIds	המזהים של החברות שהגישו הצעות מחיר על המודעה למילוי החסר שעבר רינדור.
creativeId	מזהה הקריאייטיב של מודעה שהונפקה בהזמנה.
creativeTemplateId	מזהה תבנית הקריאייטיב של מודעת ההזמנה שעבר רינדור.
isBackfill	האם המודעה הייתה מודעת גיבוי.
isEmpty	האם הוחזרה מודעה למיקום המודעה.
labelIds	הוצא משימוש.
lineItemId	מזהה הפריט של המודעה שהונפקה בהזמנה.
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
size	מציין את גודל הפיקסלים של הקריאייטיב שעבר רינדור.
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.slot
slotContentChanged	האם תוכן המיקום השתנה עם המודעה שעבר רינדור.
sourceAgnosticCreativeId	מזהה הקריאייטיב של ההזמנה שעבר רינדור או של מודעה למילוי מקום.
sourceAgnosticLineItemId	מזהה הפריט של המודעה ששמורה או של המודעה למילוי חוסר (backfill) שעבר רינדור.
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.
  }
});

ראה גם

• פונקציות מסוג Event Listener של מודעות

מאפיינים

---

advertiserId

advertiserId: null | number

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

---

campaignId

campaignId: null | number

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

---

companyIds

companyIds: null | number[]

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

---

creativeId

creativeId: null | number

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

---

creativeTemplateId

creativeTemplateId: null | number

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

---

isBackfill

isBackfill: boolean

האם המודעה הייתה מודעת גיבוי. הערך הוא true אם המודעה הייתה מודעה למילוי מקום, false אחרת.

---

isEmpty

isEmpty: boolean

האם הוחזרה מודעה למיקום המודעה. הערך הוא true אם לא הוחזרה מודעה, ו-false במקרים אחרים.

---

labelIds

labelIds: null | number[]

הוצא משימוש: השדה הזה לא מאוכלס יותר.

---

lineItemId

lineItemId: null | number

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

---

size

size: null | string | number[]

מציין את גודל הפיקסלים של הקריאייטיב שעבר רינדור. דוגמה: [728, 90] הערך הוא null עבור משבצות מודעות ריקות.

---

slotContentChanged

slotContentChanged: boolean

האם תוכן המיקום השתנה עם המודעה שעבר רינדור. הערך הוא true אם התוכן השתנה, false אחרת.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: null | number

מזהה הקריאייטיב של ההזמנה שעבר רינדור או של מודעה למילוי מקום. הערך הוא null אם המודעה היא לא הזמנה או מילוי חוסרים של פריט, או אם הקריאייטיב עבר רינדור על ידי שירותים שאינם PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: null | number

מזהה הפריט של המודעה ששמורה או של המודעה למילוי חוסר (backfill) שעבר רינדור. הערך הוא null אם המודעה היא לא הזמנה או מילוי חוסרים של פריט, או אם הקריאייטיב עבר רינדור על ידי שירותים שאינם PubAdsService.

---

yieldGroupIds

yieldGroupIds: null | number[]

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

---

googletag.events.SlotRequestedEvent

הארכה של Event

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

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
  }
});

ראה גם

• פונקציות מסוג Event Listener של מודעות

---

googletag.events.SlotResponseReceived

הארכה של Event

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

מאפיינים
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
  }
});

ראה גם

• פונקציות מסוג Event Listener של מודעות

---

googletag.events.SlotVisibilityChangedEvent

הארכה של Event

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

מאפיינים
inViewPercentage	אחוז האזור של המודעה שגלוי.
serviceName	שם השירות שהפעיל את האירוע. הועברה בירושה מ-Event.serviceName
slot	השקע שהפעיל את האירוע. הועברה בירושה מ-Event.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.
  }
});

ראה גם

• פונקציות מסוג Event Listener של מודעות

מאפיינים

---

inViewPercentage

inViewPercentage: number

אחוז האזור של המודעה שגלוי. הערך הוא מספר בין 0 ל-100.

---

googletag.secureSignals

זהו מרחב השמות שבו GPT משתמש לניהול אותות מאובטחים.

ממשקים
BidderSignalProvider	הפונקציה מחזירה אות מאובטח למגיש הצעות מחיר ספציפי.
PublisherSignalProvider	הפונקציה מחזירה אות מאובטח למוציא לאור ספציפי.
SecureSignalProvidersArray	ממשק לניהול אותות מאובטחים.

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

כינויים מסוג טקסט

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

ממשק להחזרת אות מאובטח עבור מציע מחיר או ספק ספציפיים. צריך לציין רק את id או את networkCode, אבל לא את שניהם.

---

googletag.secureSignals.BidderSignalProvider

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

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

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

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

ספק אותות של בעלי תוכן דיגיטלי מורכב משני חלקים:

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

ניקוי כל האותות של כל הקולקטורים מהמטמון.

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

---

push

push(provider: SecureSignalProvider): void

הקוד הזה מוסיף secureSignals.SecureSignalProvider חדש למערך של ספקי האותות ומתחיל את תהליך יצירת האות.

פרמטרים
provider: SecureSignalProvider	האובייקט secureSignals.SecureSignalProvider שרוצים להוסיף למערך.