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

הגדרות סוג

סוגים
SingleSize | MultiSize

הגדרת גודל חוקית לחריץ, שיכול להיות בגודל אחד או יותר.
SingleSize[]

רשימה של מידות חוקיות בודדות.
"fluid" | ["fluid"]

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

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

גודל חוקי אחד לחריץ.
[number, number]

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

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

רשימה של מיפויי גדלים.
"unhideWindow" | "navBar"

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

תמיכה בטיפולי פרטיות של בעלי תוכן דיגיטלי.
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
BidderSignalProvider | PublisherSignalProvider

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

סוגי Enum

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

googletag.enums.OutOfPageFormat

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

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

googletag.enums.TrafficSource

  • מקורות תנועה שנתמכים על ידי GPT.

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

googletag

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

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

googletag.apiReady

  • apiReady: boolean | undefined

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

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

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

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

googletag.cmd

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

  • הפניה לתור הפקודות הגלובלי להפעלה אסינכרונית של קריאות שקשורות ל-GPT.

    המשתנה googletag.cmd מאותחל למערך 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());
});

googletag.pubadsReady

  • pubadsReady: boolean | undefined

  • סימון שמציין ש-PubAdsService מופעל, נטען ופעיל באופן מלא. הנכס הזה יהיה פשוט undefined עד שתתבצע קריאה ל-enableServices ו-PubAdsService ייטען ויופעל.

googletag.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");
  },
});
    עוד באותו הקשר

googletag.companionAds

googletag.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
    נתיב יחידת המודעות מלא עם קוד הרשת וקוד יחידת המודעות.
    div?: string | OutOfPageFormat
    המזהה של ה-div שתכיל את יחידת המודעות הזו או את OutOfPageFormat.
  • החזרות
    Slot | null
    משבצת הזמן החדשה שנוצרה, או null אם אי אפשר ליצור משבצת זמן.

googletag.defineSlot

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

  • בונה מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות ומשייך אותו למזהה של רכיב div בדף שיכיל את המודעה.

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

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

googletag.destroySlots

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

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

googletag.disablePublisherConsole

  • disablePublisherConsole(): void

  • משבית את Google Publisher Console.

  • עוד באותו הקשר

googletag.display

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

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

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

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    עוד באותו הקשר
  • פרמטרים
    divOrSlot: string | Element | Slot
    המזהה של רכיב ה-div שמכיל את מיקום המודעה או את הרכיב div, או את האובייקט של מיקום המודעה. אם מספקים רכיב div, הוא צריך לכלול מאפיין 'id' שתואם למזהה שנשלח אל defineSlot.

googletag.enableServices

  • enableServices(): void

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

googletag.getVersion

  • getVersion(): string

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

  • עוד באותו הקשר
  • החזרות
    string
    מחרוזת גרסת ה-GPT שרצה כרגע.

googletag.openConsole

  • openConsole(div?: string): void

  • ייפתחו Google Publisher Console.

  • דוגמה

    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();
    עוד באותו הקשר
  • פרמטרים
    div?: string
    מזהה div של מיקום מודעה. הערך הזה הוא אופציונלי. כשיסופק, ה-Publisher Console ינסה לפתוח את הפרטים של מיקום המודעה שצוין בתצוגה.

googletag.pubads

googletag.setAdIframeTitle

  • setAdIframeTitle(title: string): void

  • הגדרת הכותרת לכל מסגרות ה-iframe של מאגרי המודעות שנוצרו על ידי PubAdsService, מנקודה זו ואילך.

  • דוגמה

    JavaScript

    googletag.setAdIframeTitle("title");

    JavaScript (מדור קודם)

    googletag.setAdIframeTitle("title");

    TypeScript

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

googletag.setConfig

googletag.sizeMapping

googletag.CommandArray

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

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

push

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

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

  • דוגמה

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

googletag.CompanionAdsService

הרחבה Service

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

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

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
מאפשרת להציג מודעות במצב מודעות מוגבלות (LTD) כדי לעזור לבעלי תוכן דיגיטלי לציית לתקנות.
nonPersonalizedAds
מאפשרת להציג מודעות במצב מודעות ללא התאמה אישית כדי לעזור לבעלי התוכן הדיגיטלי לציית לתקנות.
restrictDataProcessing
מאפשרת להציג מודעות במצב עיבוד מוגבל כדי לעזור לבעלי תוכן דיגיטלי לציית לתקנות.
trafficSource
מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית.
underAgeOfConsent
מציין אם לסמן בקשות להצגת מודעות כבקשות ממשתמשים מתחת לגיל ההסכמה.
עוד באותו הקשר

childDirectedTreatment

limitedAds

  • limitedAds: boolean

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

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

    • באופן אוטומטי, באמצעות אות מפלטפורמת IAB TCF גרסה 2.0.
    • באופן ידני, על ידי הגדרת הערך בשדה הזה ל-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,
});
    עוד באותו הקשר

nonPersonalizedAds

restrictDataProcessing

  • restrictDataProcessing: boolean

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

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

underAgeOfConsent

  • underAgeOfConsent: null | boolean

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

googletag.PubAdsService

הרחבה Service

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

סיכום השיטה
addEventListener
רושם אוזן שמאפשר להגדיר פונקציית JavaScript ולהפעיל אותה כשמתרחש אירוע GPT ספציפי בדף.
clear
הסרת המודעות מהמשבצות הנתונים והחלפתן בתוכן ריק.
clearCategoryExclusions
ניקוי כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף.
clearTargeting
ניקוי פרמטרים מותאמים אישית של טירגוט למפתח ספציפי או לכל המפתחות.
collapseEmptyDivs
מאפשרת לכווץ את התשובות של מיקומי המודעות כך שלא יתפסו מקום כלשהו בדף כשאין תוכן של מודעה להצגה.
disableInitialLoad
ההגדרה משביתה בקשות להצגת מודעות בזמן טעינת הדף, אבל מאפשרת שליחת בקשה להצגת מודעות באמצעות קריאה ל-PubAdsService.refresh.
display
בונה ומציג מיקום מודעה עם הנתיב והגודל הנתונים של יחידת המודעות.
enableLazyLoad
הפעלת טעינה מדורגת ב-GPT בהתאם להגדרה באובייקט config.
enableSingleRequest
הפעלת מצב בקשה יחידה לאחזור מספר מודעות בו-זמנית.
enableVideoAds
אותות ל-GPT על כך שמודעות וידאו יוצגו בדף.
get
הפונקציה מחזירה את הערך של המאפיין AdSense שמשויך למפתח הנתון.
getAttributeKeys
מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
getSlots
לקבל את רשימת המשבצות שמשויכות לשירות הזה.
getTargeting
הפונקציה מחזירה פרמטר טירגוט ספציפי מותאם אישית ברמת השירות, שהוגדר.
getTargetingKeys
מחזירה את הרשימה של כל מפתחות הטירגוט ברמת השירות בהתאמה אישית שהוגדרו.
isInitialLoadDisabled
הפונקציה מחזירה אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי הפעלת PubAdsService.disableInitialLoad קודמת.
refresh
מאחזר ומציג מודעות חדשות עבור מיקומי מודעות ספציפיים או עבור כל המיקומים בדף.
removeEventListener
הסרת מאזינים שנרשמו בעבר.
set
מגדיר ערכים למאפייני AdSense שיחולו על כל מיקומי המודעות בשירות המודעות לבעלי תוכן דיגיטלי.
setCategoryExclusion
מגדיר החרגה של קטגוריית מודעות ברמת הדף עבור שם התווית הנתון.
setCentering
המתג מפעיל או משבית את מרכוז המודעות לרוחב.
setForceSafeFrame
המדיניות הזו מגדירה אם לאלץ את העיבוד של כל המודעות בדף באמצעות מאגר של SafeFrame.
setLocation
העברה של פרטי מיקום מאתרים כדי שתוכלו לטרגט פריטים לפי מיקום גיאוגרפי למיקומים ספציפיים.
setPrivacySettings
מאפשרת לקבוע את כל הגדרות הפרטיות מ-API יחיד באמצעות אובייקט config.
setPublisherProvidedId
מגדיר את הערך של המזהה שסופק על ידי בעל האפליקציה.
setSafeFrameConfig
מגדיר את ההעדפות ברמת הדף להגדרת SafeFrame.
setTargeting
מגדיר פרמטרים של טירגוט בהתאמה אישית למפתח נתון, שחלים על כל מיקומי המודעות בשירות מודעות של בעלי תוכן דיגיטלי.
setVideoContent
מגדיר את המידע על תוכן הסרטון שיישלח יחד עם הבקשות להצגת מודעות למטרות טירגוט והחרגת תוכן.
updateCorrelator
שינוי המתאם שנשלח עם בקשות להצגת מודעות, וכתוצאה מכך מתחיל ביעילות צפייה חדשה בדף.

clear

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

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

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

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

disableInitialLoad

  • disableInitialLoad(): void

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

  • עוד באותו הקשר

display

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

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

    הערה:כשהשיטה הזו מופעלת, נוצרת תמונת מצב של מיקום הדף ומצב הדף כדי להבטיח עקביות בעת שליחת הבקשה להצגת מודעה ועיבוד התגובה. כל שינוי שיבוצע במיקום או במצב הדף לאחר הקריאה לשיטה הזו (כולל טירגוט, הגדרות פרטיות, אילוץ 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
    הרוחב והגובה של החריץ.
    div?: string | Element
    מזהה ה-div שמכיל את המשבצת או את רכיב div עצמו.
    clickUrl?: string
    כתובת ה-URL לקליקים שתשמש במשבצת הזו.

enableLazyLoad

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

  • הפעלת טעינה מדורגת ב-GPT בהתאם להגדרה באובייקט config. לדוגמאות מפורטות יותר, ראו טעינה מושהית.

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

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

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

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

enableSingleRequest

  • enableSingleRequest(): boolean

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

  • עוד באותו הקשר
  • החזרות
    boolean
    הפונקציה מחזירה את הערך true אם מצב בקשה יחידה הופעל, ואת הערך false אם לא ניתן להפעיל מצב בקשה יחידה (SSO) כי בוצעה קריאה ל-method אחרי הפעלת השירות.

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

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

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

refresh

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

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

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

set

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

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

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

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    עוד באותו הקשר
  • פרמטרים
    key: string
    שם המאפיין.
    value: string
    ערך מאפיין.
  • החזרות
    PubAdsService
    אובייקט השירות שבו הופעלה ה-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 הזה, כי הוא עלול להשפיע על ההתנהגות של קריאייטיבים שמנסים לפרוץ מה-iFrames שלהם או להסתמך על כך שהם עוברים עיבוד ישירות בדף של בעלי תוכן דיגיטלי.

  • דוגמה

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    JavaScript (מדור קודם)

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
    עוד באותו הקשר
  • פרמטרים
    forceSafeFrame: boolean
    true לאלץ את כל המודעות בדף לעבור עיבוד ב-SafeFrames ו-false לשנות את ההגדרה הקודמת ל-False. אם הערך לא צוין קודם לכן, הערך false לא ישתנה, שום דבר לא ישתנה.
  • החזרות
    PubAdsService
    אובייקט השירות שבו הופעלה הפונקציה.

setLocation

  • setLocation(address: string): PubAdsService

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

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

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

setPrivacySettings

  • setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

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

  • דוגמה

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

    העדפות ברמת הדף יבוטלו על ידי ההעדפות ברמת המיקום, אם הן יצוינו.

  • דוגמה

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

    JavaScript (מדור קודם)

    googletag.pubads().setForceSafeFrame(true);

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

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

setTargeting

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

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

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

advertiserId

  • advertiserId: null | number

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

campaignId

  • campaignId: null | number

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

creativeId

  • creativeId: null | number

  • מזהה הקריאייטיב.

creativeTemplateId

  • creativeTemplateId: null | number

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

lineItemId

  • lineItemId: null | number

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

googletag.RewardedPayload

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

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

amount

  • amount: number

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

type

  • type: string

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

googletag.SafeFrameConfig

אובייקט הגדרה של קונטיינרים של SafeFrame.

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

allowOverlayExpansion

  • allowOverlayExpansion: boolean

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

allowPushExpansion

  • allowPushExpansion: boolean

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

sandbox

  • sandbox: boolean

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

useUniqueDomain

  • useUniqueDomain: null | boolean

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

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

  • עוד באותו הקשר

googletag.Service

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

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

addEventListener

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

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

    אובייקט מסוג האירוע המתאים מועבר אל ה-listener כשהוא מופעל.

  • דוגמה

    JavaScript

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

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

    JavaScript (מדור קודם)

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

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

    TypeScript

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

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});
    עוד באותו הקשר
  • פרמטרים
    eventType: K
    מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות.
    listener: (arg: EventTypeMap[K]) => void
    פונקציה שלוקחת ארגומנט של אובייקט אירוע יחיד.
  • החזרות
    Service
    אובייקט השירות שבו הופעלה ה-method.

getSlots

  • getSlots(): Slot[]

  • לקבל את רשימת המשבצות שמשויכות לשירות הזה.

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

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

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

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

סיכום השיטה
addService
הוספת Service למשבצת הזו.
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.

addService

  • addService(service: Service): Slot

  • הוספת Service למשבצת הזו.

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

    googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
    עוד באותו הקשר
  • פרמטרים
    service: Service
    השירות שרוצים להוסיף.
  • החזרות
    Slot
    האובייקט של יחידת הקיבולת (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
    האובייקט של יחידת הקיבולת (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.
    עוד באותו הקשר
  • פרמטרים
    key?: string
    מפתח של פרמטר טירגוט. המפתח הוא אופציונלי. כל הפרמטרים של הטירגוט יימחקו אם הוא לא יצוין.
  • החזרות
    Slot
    האובייקט של יחידת הקיבולת (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
    האובייקט של יחידת הקיבולת (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'.
    עוד באותו הקשר
  • פרמטרים
    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 במיקום המודעה הזה. הפעולה הזו תבטל את כל הערכים שהוגדרו ברמת השירות למפתח הזה.

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

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
    עוד באותו הקשר
  • פרמטרים
    key: string
    שם המאפיין.
    value: string
    ערך מאפיין.
  • החזרות
    Slot
    האובייקט של יחידת הקיבולת (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
    האובייקט של יחידת הקיבולת (Slot) שבו הופעלה ה-method.

setClickUrl

  • setClickUrl(value: string): Slot

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

    השרתים של Google Ad Manager עדיין מתעדים קליק, גם אם כתובת ה-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
    האובייקט של יחידת הקיבולת (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
    הגדרה שקובעת אם לכווץ את המיקום אם לא מוחזרת מודעה.
    collapseBeforeAdFetch?: boolean
    הגדרה שקובעת אם לכווץ את המיקום עוד לפני אחזור מודעה. המערכת תתעלם אם הכיווץ הוא לא true.
  • החזרות
    Slot
    האובייקט של יחידת הקיבולת (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 הזה, כי הוא עלול להשפיע על ההתנהגות של קריאייטיבים שמנסים לפרוץ מה-iFrames שלהם או להסתמך על כך שהם עוברים עיבוד ישירות בדף של בעלי תוכן דיגיטלי.

  • דוגמה

    JavaScript

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

    JavaScript (מדור קודם)

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

    TypeScript

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

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot

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

    ההעדפות האלה ברמת המיקום, אם הן יצוינו, יבטלו את ההעדפות ברמת הדף.

  • דוגמה

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    JavaScript (מדור קודם)

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
    עוד באותו הקשר
  • פרמטרים
    config: null | SafeFrameConfig
    אובייקט ההגדרה.
  • החזרות
    Slot
    האובייקט של יחידת הקיבולת (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
    האובייקט של יחידת הקיבולת (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[] }
    מפת key:value של פרמטר הטירגוט.
  • החזרות
    Slot
    האובייקט של יחידת הקיבולת (Slot) שבו הופעלה ה-method.

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

enabled

googletag.config.ComponentAuctionConfig

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

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

auctionConfig

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

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

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

  • דוגמה

    JavaScript

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

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

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

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

    JavaScript (מדור קודם)

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

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

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

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

    TypeScript

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

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

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

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});
    עוד באותו הקשר

configKey

  • configKey: string

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

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

googletag.config.InterstitialConfig

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

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

triggers

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

  • הגדרת הטריגר של מודעת המעברון הזו.

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

  • דוגמה

    JavaScript

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

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

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

    JavaScript (מדור קודם)

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

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

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

    TypeScript

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

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

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});
    עוד באותו הקשר

googletag.config.PageSettingsConfig

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

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

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

דוגמאות:

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

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

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

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

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

adExpansion

  • adExpansion: null | AdExpansionConfig

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

pps

privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig

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

googletag.config.PrivacyTreatmentsConfig

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

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

treatments

  • treatments: "disablePersonalization"[]

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

  • דוגמה

    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 | 18-20'
      // '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 | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

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

taxonomies

googletag.config.SlotSettingsConfig

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

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

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

דוגמאות:

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

adExpansion

  • adExpansion: AdExpansionConfig

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

componentAuction

  • componentAuction: ComponentAuctionConfig[]

  • מגוון מכרזים של רכיבים שייכללו במכרז של מודעות במכשיר.

interstitial

  • interstitial: InterstitialConfig

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

googletag.config.TaxonomyData

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

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

values

googletag.events.Event

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

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

serviceName

  • serviceName: string

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

slot

  • slot: Slot

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

googletag.events.EventTypeMap

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

סיכום הנכס
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
slotOnload
כינוי של events.SlotOnloadEvent.
slotRenderEnded
כינוי של events.SlotRenderEndedEvent.
slotRequested
כינוי של events.SlotRequestedEvent.
slotResponseReceived
כינוי של events.SlotResponseReceived.
slotVisibilityChanged

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

googletag.events.ImpressionViewableEvent

הרחבה Event

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

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

JavaScript

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

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

JavaScript (מדור קודם)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

googletag.events.RewardedSlotClosedEvent

הרחבה Event

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

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

JavaScript

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

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

JavaScript (מדור קודם)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

googletag.events.RewardedSlotGrantedEvent

הרחבה Event

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

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

JavaScript

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

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

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

JavaScript (מדור קודם)

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

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

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

payload

  • payload: null | RewardedPayload

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

googletag.events.RewardedSlotReadyEvent

הרחבה Event

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

סיכום הנכס
serviceName
שם השירות שהפעיל את האירוע.
slot
המיקום שהפעיל את האירוע.
סיכום השיטה
makeRewardedVisible
הצגת המודעה המתגמלת.
דוגמה

JavaScript

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

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

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

JavaScript (מדור קודם)

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

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

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

makeRewardedVisible

  • makeRewardedVisible(): void

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

googletag.events.SlotOnloadEvent

הרחבה Event

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

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

JavaScript

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

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

JavaScript (מדור קודם)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

googletag.events.SlotRenderEndedEvent

הרחבה Event

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

סיכום הנכס
advertiserId
מזהה המפרסם של המודעה שעברה עיבוד.
campaignId
מזהה הקמפיין של המודעה שעברה עיבוד.
companyIds
מזהים של החברות שמגישים הצעות מחיר על מודעת המילוי החוזר המעובדת.
creativeId
מזהה הקריאייטיב של המודעה בהזמנה שעברה רינדור.
creativeTemplateId
מזהה תבנית הקריאייטיב של המודעה בהזמנה שעברה רינדור.
isBackfill
האם מודעה הייתה מודעת גיבוי.
isEmpty
האם הוחזרה מודעה עבור מיקום המודעה.
labelIds
מזהי התוויות של המודעה שעברה עיבוד.
lineItemId
מזהה הפריט של המודעה בהזמנה שעברה רינדור.
serviceName
שם השירות שהפעיל את האירוע.
size
מציין את גודל הפיקסלים של הקריאייטיב שעבר עיבוד.
slot
המיקום שהפעיל את האירוע.
slotContentChanged
האם תוכן המיקום השתנה במודעה שעברה עיבוד.
sourceAgnosticCreativeId
מזהה הקריאייטיב של המודעה בהזמנה או למילוי חוסרים (backfill) שעברה רינדור.
sourceAgnosticLineItemId
מזהה הפריט במודעה המעובדת או במודעה למילוי חוסרים (backfill).
yieldGroupIds
המזהים של קבוצות התפוקה עבור מודעת המילוי החוסרים (backfill) שעברה רינדור.
דוגמה

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

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

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

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

TypeScript

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

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

advertiserId

  • advertiserId: null | number

  • מזהה המפרסם של המודעה שעברה עיבוד. הערך הוא 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 אם המודעה הייתה מודעה למילוי חוסרים (backfill). אחרת, false.

isEmpty

  • isEmpty: boolean

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

labelIds

  • labelIds: null | number[]

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

lineItemId

  • lineItemId: null | number

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

size

  • size: null | string | number[]

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

slotContentChanged

  • slotContentChanged: boolean

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

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

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

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

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

yieldGroupIds

  • yieldGroupIds: null | number[]

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

googletag.events.SlotRequestedEvent

הרחבה Event

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

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

JavaScript

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

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

JavaScript (מדור קודם)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

googletag.events.SlotResponseReceived

הרחבה Event

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

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

JavaScript

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

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

JavaScript (מדור קודם)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

googletag.events.SlotVisibilityChangedEvent

הרחבה Event

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

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

JavaScript

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

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

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

JavaScript (מדור קודם)

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

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

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
עוד באותו הקשר

inViewPercentage

  • inViewPercentage: number

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

googletag.secureSignals.BidderSignalProvider

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

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

  1. פונקציית קולקטור שמחזירה Promise שמפנה לאות מאובטח.
  2. id שמזהה את מגיש הצעות המחיר שמשויך לאות.
כדי להחזיר אות מאובטח לבעל אפליקציה, צריך להשתמש במקום זאת ב-secureSignals.PublisherSignalProvider.

סיכום הנכס
collectorFunction
.
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>

id

  • id: string

  • מזהה ייחודי של הקולקטור שמשויך לאות המאובטח הזה, כפי שרשום ב-Google Ad Manager.

googletag.secureSignals.PublisherSignalProvider

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

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

  1. פונקציית קולקטור שמחזירה Promise שמפנה לאות מאובטח.
  2. networkCode שמזהה את בעל התוכן הדיגיטלי שמשויך לאות.
כדי להחזיר אות מאובטח למגיש הצעות המחיר, צריך להשתמש במקום זאת ב-secureSignals.BidderSignalProvider.

סיכום הנכס
collectorFunction
.
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>

networkCode

  • networkCode: string

  • קוד הרשת (כפי שהוא מופיע בנתיב של יחידת המודעות) של בעל התוכן הדיגיטלי שמשויך לאות המאובטח הזה.

googletag.secureSignals.SecureSignalProvidersArray

ממשק לניהול אותות מאובטחים.

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

clearAllCache

  • clearAllCache(): void

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

push