במאמר הזה נעשה שימוש בסימון TypeScript כדי לתאר סוגים. בטבלה הבאה מופיע הסבר קצר באמצעות דוגמה.
| ביטוי סוג | |
|---|---|
string |
סוג המחרוזת הפרימיטיבית. |
string[] |
סוג מערך, שבו הערכים יכולים להיות רק מחרוזות. |
number | string |
סוג איחוד, שבו הערך יכול להיות מספר או מחרוזת. |
Array<number | string> |
סוג מערך, שבו הערכים הם מסוג מורכב (איחוד). |
[number, string] |
סוג של טופל, שבו הערך הוא מערך של שני רכיבים שחייב להכיל מספר ומחרוזת בסדר הזה. |
Slot |
סוג אובייקט, שבו הערך הוא מופע של googletag.Slot. |
() => void |
סוג פונקציה ללא ארגומנטים מוגדרים וללא ערך החזרה. |
מידע נוסף על סוגים וביטויי סוגים נתמכים זמין ב מדריך TypeScript .
הערות מסוג Type
נקודתיים אחרי משתנה, שם פרמטר, שם מאפיין או חתימת פונקציה מציינים הערת סוג. הערות הסוג מתארות את הסוגים שהרכיב שמשמאל לנקודתיים יכול לקבל או להחזיר. בטבלה הבאה מוצגות דוגמאות להערות מסוגים שונים שמופיעות במאמר הזה.
| הערת סוג | |
|---|---|
param: string |
מציין שהפונקציה param מקבלת או מחזירה ערך מחרוזת. התחביר הזה משמש למשתנים, לפרמטרים, למאפיינים ולסוגי החזרה.
|
param?: number | string |
מציין שהמאפיין param הוא אופציונלי, אבל מקבל מספר או מחרוזת
כשהוא מצוין. התחביר הזה משמש לפרמטרים ולמאפיינים.
|
...params: Array<() => void> |
מציין ש-params הוא
פרמטר rest
שמקבל פונקציות. פרמטרים מסוג Rest מקבלים מספר בלתי מוגבל של ערכים מהסוג שצוין.
|
googletag
מרחב השמות הגלובלי שבו Google Publisher Tag משתמש עבור ה-API שלו.
| מרחבי שמות | |
|---|---|
config | ממשק ההגדרות הראשי להגדרות ברמת הדף. |
enums | זהו מרחב השמות שבו GPT משתמש לסוגי enum. |
events | זהו מרחב השמות שבו GPT משתמש לאירועים. |
secure | זהו מרחב השמות שבו GPT משתמש כדי לנהל אותות מאובטחים. |
| ממשקים | |
|---|---|
Command | מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר. |
Companion | שירות מודעות נלוות. |
Privacy | אובייקט הגדרה של הגדרות הפרטיות. |
Pub | שירותי הפרסום של בעלי התוכן הדיגיטלי. |
Request | פונקציית קריאה חוזרת (callback) שמופעלת לפני כל בקשה להצגת מודעה כשהיא רשומה דרך PubAdsService.registerRequestHook. |
Response | אובייקט שמייצג תגובה אחת למודעה. |
Rewarded | אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת. |
Service | מחלקה בסיסית של שירות שמכילה שיטות שמשותפות לכל השירותים. |
Size | כלי ליצירת אובייקטים של מפרט מיפוי גודל. |
Slot | מיקום מודעה בדף הוא אובייקט שמייצג מיקום מודעה יחיד בדף. |
| כינויי סוגים | |
|---|---|
Fluid | מחרוזת הגודל שבה מאגר המודעות תופס 100% מהרוחב של רכיב ה-div ההורה שלו, ואז משנה את הגובה שלו כך שיתאים לתוכן הקריאייטיב. |
General | הגדרת גודל חוקית למיקום מודעה, שיכולה להיות גודל אחד או כמה גדלים. |
Multi | רשימה של מידות תקינות. |
Named | גדלים עם שמות שיכולים להיות למיקום מודעה. |
Single | גודל חוקי אחד למיקום מודעה. |
Single | מערך של שני מספרים שמייצגים את [הרוחב, הגובה]. |
Size | מיפוי של גודל אזור התצוגה לגודלי המודעות. |
Size | רשימה של מיפויים לפי גודל. |
| משתנים | |
|---|---|
api | סימון שמציין שה-API של GPT נטען ומוכן לקריאה. |
cmd | הפניה לתור הפקודות הגלובלי להפעלה אסינכרונית של קריאות שקשורות ל-GPT. |
pubads | סימון שמציין ש-PubAdsService מופעל, נטען ופועל באופן מלא. |
secure | הפניה למערך של ספקי האותות המאובטחים. |
| פונקציות | |
|---|---|
companion | מחזירה הפניה אל CompanionAdsService. |
define | יוצר מיקום מודעה מחוץ לדף עם הנתיב של יחידת המודעות שצוין. |
define | יוצר מיקום מודעה בדף עם נתיב וגודל נתונים של יחידת מודעות, ומשייך אותו למזהה של רכיב div בדף שיכיל את המודעה. |
destroy | הפונקציה הזו משמידה את מיקומי המודעות שצוינו, ומסירה מ-GPT את כל האובייקטים וההפניות שקשורים למיקומי המודעות האלה. |
disable | השבתה של Google Publisher Console. |
display | הוראה לשירותי המיקום להציג את המיקום. |
enable | מפעילה את כל שירותי GPT שהוגדרו למיקומי מודעות בדף. |
get | הפונקציה הזו מקבלת עותק קפוא של אפשרויות ההגדרה הכלליות של הדף שהוגדרו על ידי setConfig. |
get | הפונקציה מחזירה את הגרסה הנוכחית של GPT. |
open | פתיחת Google Publisher Console. |
pubads | הפונקציה מחזירה הפניה אל PubAdsService. |
set | מגדיר את הכותרת לכל רכיבי ה-iframe של מאגרי המודעות שנוצרו על ידי PubAdsService, מהנקודה הזו ואילך. |
set | הוראת המאקרו הזו מגדירה אפשרויות כלליות לדף. |
size | יוצרת SizeMappingBuilder חדש. |
כינויי סוגים
FluidSize
FluidSize: "fluid"GeneralSize
GeneralSize: SingleSize | MultiSizeMultiSize
MultiSize: SingleSize[]NamedSize
גדלים עם שמות שיכולים להיות למיקום מודעה. ברוב המקרים, הגודל הוא מלבן בגודל קבוע, אבל יש מקרים שבהם אנחנו צריכים סוגים אחרים של מפרטי גודל. רק הגדלים הבאים הם גדלים תקינים עם שם:
- fluid: מאגר המודעות תופס 100% מהרוחב של מאגר האב שלו, ואז הגובה שלו משתנה בהתאם לתוכן הקריאייטיב. בדומה לאופן שבו רכיבי בלוק רגילים מתנהגים בדף. משמש למודעות מותאמות ולמודעות באנר (ראו מאמר קשור). שימו לב שגם
fluidוגם['fluid']הן צורות מקובלות להצהרה על גודל גמיש של מיקום מודעה.
SingleSize
SingleSize: SingleSizeArray | NamedSizeSingleSizeArray
SingleSizeArray: [number, number]SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]SizeMappingArray
SizeMappingArray: SizeMapping[]משתנים
Const apiReady
apiReady: boolean | undefinedundefined עד שה-API יהיה מוכן.חשוב לזכור שהדרך המומלצת לטפל במצב אסינכרוני היא להשתמש ב-googletag.cmd כדי להוסיף קריאות חוזרות לתור כשה-GPT יהיה מוכן. הקריאות החוזרות האלה לא צריכות לבדוק את googletag.apiReady כי הן מובטחות לפעול ברגע שה-API מוגדר.
Const cmd
cmd: ((this: typeof globalThis) => void)[] | CommandArrayהמשתנה
googletag.cmd מאותחל למערך ריק ב-JavaScript על ידי תחביר תג ה-GPT בדף, ו-cmd.push היא השיטה הרגילה של Array.push שמוסיפה רכיב לסוף המערך. כשה-JavaScript של GPT נטען, הוא בודק את המערך ומפעיל את כל הפונקציות לפי הסדר. לאחר מכן, הסקריפט מחליף את cmd באובייקט CommandArray שה-push method שלו מוגדרת להפעיל את הארגומנט של הפונקציה שמועבר אליו. המנגנון הזה מאפשר ל-GPT להפחית את זמן האחזור הנתפס על ידי אחזור ה-JavaScript באופן אסינכרוני, תוך מתן אפשרות לדפדפן להמשיך לעבד את הדף.- דוגמה
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (דור קודם)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
Const pubadsReady
pubadsReady: boolean | undefinedundefined עד שמתבצעת קריאה ל-enableServices ו-PubAdsService נטען ומאותחל.secureSignalProviders
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefinedהמערך של ספקי האותות המאובטחים מקבל רצף של פונקציות ליצירת אותות ומפעיל אותן לפי הסדר. הוא נועד להחליף מערך סטנדרטי שמשמש להוספת פונקציות ליצירת אותות לתור, שיופעלו אחרי ש-GPT ייטען.
- דוגמה
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (דור קודם)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
פונקציות
companionAds
companionAds(): CompanionAdsServiceמחזירה הפניה אל CompanionAdsService.
| החזרות | |
|---|---|
CompanionAdsService | שירות המודעות הנלוות. |
defineOutOfPageSlot
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | nullהפונקציה הזו יוצרת מיקום מודעה מחוץ לדף עם הנתיב של יחידת המודעות שצוין.
במודעות מותאמות אישית מחוץ לדף,
במודעות מחוץ לדף שמנוהלות על ידי GPT,
במודעות מותאמות אישית מחוץ לדף,
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 שיכיל את יחידת המודעות הזו או OutOfPageFormat. |
| החזרות | |
|---|---|
Slot | null | המשבצת החדשה שנוצרה, או null אם אי אפשר ליצור משבצת. |
defineSlot
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | nullהפונקציה הזו יוצרת מיקום מודעה בדף עם נתיב וגודל נתונים של יחידת מודעות, ומשייכת אותו למזהה של רכיב div בדף שיכיל את המודעה.
- דוגמה
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (דור קודם)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
| פרמטרים | |
|---|---|
adUnitPath: string | הנתיב המלא של יחידת המודעות עם קוד הרשת וקוד היחידה. |
size: GeneralSize | הרוחב והגובה של מיקום המודעה שנוסף. זה הגודל שבו נעשה שימוש בבקשה להצגת מודעה אם לא צוין מיפוי גודל רספונסיבי, או אם הגודל של אזור התצוגה קטן מהגודל הקטן ביותר שצוין במיפוי. |
| המזהה של ה-div שיכיל את יחידת המודעות הזו. |
| החזרות | |
|---|---|
Slot | null | המשבצת החדשה שנוצרה, או null אם אי אפשר ליצור משבצת. |
destroySlots
destroySlots(slots?: Slot[]): booleanהפונקציה הזו משמידה את מיקומי המודעות שצוינו, ומסירה מ-GPT את כל האובייקטים וההפניות שקשורים למיקומי המודעות האלה. ה-API הזה לא תומך במיקומי מודעות חלופיים ובמיקומי מודעות נלוות.
קריאה ל-API הזה במיקום מודעה מנקה את המודעה ומסירה את אובייקט מיקום המודעה מהמצב הפנימי שמנוהל על ידי GPT. אם תפעילו פונקציות נוספות באובייקט של מיקום המודעה, התוצאה תהיה התנהגות לא מוגדרת. שימו לב: יכול להיות שהדפדפן עדיין לא יפנה את הזיכרון שמשויך למיקום המודעה הזה אם דף בעל האפליקציה שומר הפניה אליו. קריאה ל-API הזה הופכת את ה-div שמשויך למיקום המודעה הזה לזמין לשימוש חוזר.
באופן ספציפי, השמדה של מיקום מודעה מסירה את המודעה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות תחרותיות שקשורות למודעה הזו. אם לא תפעילו את הפונקציה הזו לפני שתסירו את ה-div של מיקום המודעה מהדף, התוצאה תהיה התנהגות לא מוגדרת.
קריאה ל-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();
| פרמטרים | |
|---|---|
| מערך המשבצות שיוסרו מהלוח. המערך הוא אופציונלי. אם הוא לא צוין, כל מיקומי המודעות יושמדו. |
| החזרות | |
|---|---|
boolean | true אם מיקומי המודעות הושמדו, אחרת false. |
disablePublisherConsole
disablePublisherConsole(): voidהשבתת Google Publisher Console.
- ראה גם
תצוגה
display(divOrSlot: string | Element | Slot): voidהוראה לשירותי המיקום להציג את המיקום. כל מיקום מודעה בדף צריך להופיע רק פעם אחת בכל דף. כדי שמשבצות זמן יוצגו, צריך להגדיר את כולן ולשייך להן שירות. הקריאה להצגת המודעה צריכה להתבצע רק אחרי שהרכיב קיים ב-DOM. הדרך הרגילה לעשות את זה היא להציב אותו בתוך בלוק סקריפט בתוך רכיב ה-div שנקרא בהפעלת ה-method.
אם משתמשים בארכיטקטורת בקשה בודדת (SRA), כל מיקומי המודעות בדף שלא אוחזרו בזמן שה-method הזו הופעלה יאוחזרו בבת אחת. כדי לאלץ מיקום מודעה בדף לא להופיע, צריך להסיר את כל ה-div.
אם משתמשים בארכיטקטורת בקשה בודדת (SRA), כל מיקומי המודעות בדף שלא אוחזרו בזמן שה-method הזו הופעלה יאוחזרו בבת אחת. כדי לאלץ מיקום מודעה בדף לא להופיע, צריך להסיר את כל ה-div.
| פרמטרים | |
|---|---|
divOrSlot: string | Element | Slot | המזהה של רכיב ה-div שמכיל את מיקום המודעה בדף, רכיב ה-div או אובייקט המיקום. אם מספקים רכיב div, צריך להיות לו מאפיין "id" שתואם למזהה שמועבר אל defineSlot. |
enableServices
enableServices(): voidמפעילה את כל שירותי GPT שהוגדרו למיקומי מודעות בדף.
getConfig
getConfig(keys: string | string[]): Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>הפונקציה מקבלת עותק קפוא של אפשרויות ההגדרה הכלליות של הדף שהוגדרו על ידי setConfig.
השיטה הזו לא תומכת בכל המאפיינים של
השיטה הזו לא תומכת בכל המאפיינים של
setConfig(). המאפיינים הנתמכים הם:- דוגמה
JavaScript
// Get the value of the `targeting` setting. const targetingConfig = googletag.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `disableInitialLoad` settings. const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
JavaScript (דור קודם)
// Get the value of the `targeting` setting. var targetingConfig = googletag.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `disableInitialLoad` settings. var config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
TypeScript
// Get the value of the `targeting` setting. const targetingConfig = googletag.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `disableInitialLoad` settings. const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
| פרמטרים | |
|---|---|
keys: string | string[] | המפתחות של אפשרויות ההגדרה שרוצים לקבל. |
| החזרות | |
|---|---|
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">> | עותק קפוא של אפשרויות ההגדרה של הדף. |
getVersion
getVersion(): stringהפונקציה מחזירה את הגרסה הנוכחית של GPT.
- ראה גם
| החזרות | |
|---|---|
string | מחרוזת הגרסה של GPT שפועלת כרגע. |
openConsole
openConsole(div?: string): voidפתיחת Google Publisher Console.
- דוגמה
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (דור קודם)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- ראה גם
| פרמטרים | |
|---|---|
| מזהה div של מיקום מודעה בדף. הערך הזה הוא אופציונלי. אם תציינו את הפרמטר הזה, מרכז המידע לבעלי תוכן דיגיטלי ינסה להיפתח עם פרטים על מיקום המודעה שציינתם. |
pubads
pubads(): PubAdsServiceהפונקציה מחזירה הפניה אל PubAdsService.
| החזרות | |
|---|---|
PubAdsService | שירות המודעות בתכנים של בעלי תוכן דיגיטלי. |
setAdIframeTitle
setAdIframeTitle(title: string): voidמגדיר את הכותרת לכל רכיבי ה-iframe של מאגרי המודעות שנוצרו על ידי PubAdsService, מהנקודה הזו ואילך.
- דוגמה
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (דור קודם)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
| פרמטרים | |
|---|---|
title: string | הכותרת החדשה של כל מאגרי המודעות ב-iframe. |
setConfig
setConfig(config: PageSettingsConfig): voidהוראת המאקרו הזו מגדירה אפשרויות כלליות לדף.
| פרמטרים | |
|---|---|
config: PageSettingsConfig | |
sizeMapping
sizeMapping(): SizeMappingBuilderיוצר SizeMappingBuilder חדש.
| החזרות | |
|---|---|
SizeMappingBuilder | כלי חדש ליצירת קמפיינים. |
googletag.CommandArray
מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר. הוא נועד להחליף מערך רגיל שמשמש להוספת פונקציות לתור, שיופעלו אחרי ש-GPT ייטען.
| Methods | |
|---|---|
push | מפעילה את רצף הפונקציות שצוינו בארגומנטים לפי הסדר. |
Methods
push
push(...f: ((this: typeof globalThis) => void)[]): numberמפעילה את רצף הפונקציות שצוינו בארגומנטים לפי הסדר.
- דוגמה
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (דור קודם)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
| פרמטרים | |
|---|---|
| פונקציית JavaScript להפעלה. קישור סביבת זמן הריצה תמיד יהיה globalThis. כדאי להעביר פונקציית חץ כדי לשמור על הערך this של ההקשר הלקסיקלי המקיף. |
| החזרות | |
|---|---|
number | מספר הפקודות שעובדו עד עכשיו. הפעולה הזו תואמת לערך המוחזר של Array.push (האורך הנוכחי של המערך). |
googletag.CompanionAdsService
הארכה של
Serviceשירות מודעות נלוות. השירות הזה משמש מודעות וידאו להצגת מודעות נלוות.
| Methods | |
|---|---|
add | רושמת פונקציית listener שמאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. עובר בירושה מהשיטה |
get | קבלת רשימת המשבצות שמשויכות לשירות הזה. עובר בירושה מהשיטה |
remove | הסרת מאזין שנרשם בעבר. עובר בירושה מהשיטה |
set | ההגדרה קובעת אם משבצות למודעות נלוות שלא מולאו ימולאו באופן אוטומטי. |
Methods
setRefreshUnfilledSlots
setRefreshUnfilledSlots(value: boolean): voidהשיטה הזו קובעת אם מיקומי מודעות נלוות שלא מולאו ימולאו באופן אוטומטי.
אפשר להפעיל את השיטה הזו כמה פעמים במהלך חיי הדף כדי להפעיל ולהשבית את המילוי החוזר. רק מיקומי מודעות שרשומים גם ב-PubAdsService ימולאו באופן אוטומטי. בגלל הגבלות המדיניות, השיטה הזו לא נועדה למלא משבצות ריקות של מודעות נלוות כשמוצג סרטון של Ad Exchange.
אפשר להפעיל את השיטה הזו כמה פעמים במהלך חיי הדף כדי להפעיל ולהשבית את המילוי החוזר. רק מיקומי מודעות שרשומים גם ב-PubAdsService ימולאו באופן אוטומטי. בגלל הגבלות המדיניות, השיטה הזו לא נועדה למלא משבצות ריקות של מודעות נלוות כשמוצג סרטון של Ad Exchange.
- דוגמה
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (דור קודם)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
| פרמטרים | |
|---|---|
value: boolean | true כדי למלא באופן אוטומטי משבצות שלא מולאו, false כדי להשאיר אותן ללא שינוי. |
googletag.PrivacySettingsConfig
אובייקט הגדרה של הגדרות הפרטיות.
| מאפיינים | |
|---|---|
child | מציין אם הדף צריך להיות מותאם לילדים. |
limited | מאפשרת להציג מודעות במצב מודעות מוגבלות כדי לעזור לבעלי התוכן הדיגיטלי לעמוד בדרישות הרגולטוריות. |
non | התכונה מאפשרת להציג מודעות בלי התאמה אישית כדי לעזור לבעלי האפליקציות לעמוד בדרישות הרגולטוריות. |
restrict | מאפשרת להפעיל את הצגת המודעות במצב עיבוד מוגבל כדי לעזור לבעלי האתרים לעמוד בדרישות הרגולטוריות. |
tag | הטיפול המותאם לגיל, שמציין אם הבקשה להצגת מודעה צריכה להיות מותאמת לילדים, לבני נוער או לא מוגדרת. |
traffic | השדה מציין אם הבקשות מייצגות תנועה אורגנית או תנועה שנרכשה. |
under | מציין אם לסמן בקשות להצגת מודעות ככאלה שמגיעות ממשתמשים מתחת לגיל ההסכמה. |
- ראה גם
מאפיינים
Optional childDirectedTreatment
childDirectedTreatment?: booleannull.Optional limitedAds
limitedAds?: booleanיש שתי דרכים להורות ל-GPT לבקש מודעות מוגבלות:
- באופן אוטומטי, באמצעות אות מפלטפורמה לניהול הסכמה (CMP) של IAB TCF בגרסה 2.0.
- באופן ידני, על ידי הגדרת הערך של השדה הזה בתור
true.
שימו לב: אין צורך להפעיל באופן ידני מודעות מוגבלות כשמשתמשים בפלטפורמה לניהול הסכמה (CMP).
- דוגמה
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (דור קודם)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- ראה גם
Optional nonPersonalizedAds
nonPersonalizedAds?: booleanOptional restrictDataProcessing
restrictDataProcessing?: booleanOptional tagForAgeTreatment
tagForAgeTreatment?: TagForAgeTreatmentכדאי להתייעץ עם היועצים המשפטיים שלכם כדי לקבוע את הגדרות ההגבלות שקשורות לגיל של המשתמשים שלכם, בהתאם לדרישות המשפטיות והרגולטוריות שלכם. מידע נוסף על ההגדרה הזו זמין במאמר הזה במרכז העזרה.
הגדרת המאפיין הזה מהווה אישור לכך שההודעה הזו מדויקת ושיש לך הרשאה לפעול בשם הבעלים של האתר. ברור לך שניצול לרעה של ההגדרה הזו עלול לגרום לסגירת חשבון Google שלך.
- דוגמה
JavaScript
// Enable teen privacy treatment. googletag.pubads().setPrivacySettings({ tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN, }); // Clear age treatment configuration. googletag.pubads().setPrivacySettings({ tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED, });
JavaScript (דור קודם)
// Enable teen privacy treatment. googletag.pubads().setPrivacySettings({ tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN, }); // Clear age treatment configuration. googletag.pubads().setPrivacySettings({ tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED, });
TypeScript
// Enable teen privacy treatment. googletag.pubads().setPrivacySettings({ tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN, }); // Clear age treatment configuration. googletag.pubads().setPrivacySettings({ tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED, });
Optional trafficSource
trafficSource?: TrafficSourceundefined.- דוגמה
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (דור קודם)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
Optional underAgeOfConsent
underAgeOfConsent?: booleannull.googletag.PubAdsService
הרחבה של
Serviceשירותי הפרסום של בעלי התוכן הדיגיטלי. השירות הזה משמש לאחזור ולהצגה של מודעות מחשבון Google Ad Manager שלכם.
| Methods | |
|---|---|
add | רושמת פונקציית listener שמאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. עובר בירושה מהשיטה |
clear | הפונקציה מסירה את המודעות ממיקומי המודעות שצוינו ומחליפה אותן בתוכן ריק. |
clear | הוצא משימוש. הפונקציה מסירה את כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. |
clear | הוצא משימוש. מנקה פרמטרים של טירגוט בהתאמה אישית למפתח ספציפי או לכל המפתחות. |
collapse | הוצא משימוש. הפונקציה הזו מאפשרת לכווץ את רכיבי ה-div של מיקומי המודעות, כך שהם לא יתפסו מקום בדף כשאין תוכן של מודעה להצגה. |
disable | הוצא משימוש. האפשרות הזו משביתה את הבקשות להצגת מודעות בזמן טעינת הדף, אבל מאפשרת לבקש מודעות באמצעות קריאה ל-PubAdsService.refresh. |
display | יוצר ומציג מיקום מודעה בדף עם הנתיב והגודל של יחידת המודעות שצוינו. |
enable | הוצא משימוש. מפעילה טעינה מדורגת ב-GPT, כפי שמוגדר באובייקט config. |
enable | הוצא משימוש. הפונקציה הזו מפעילה מצב בקשה בודדת כדי לאחזר כמה מודעות בו-זמנית. |
enable | הוצא משימוש. הפרמטר הזה מאותת ל-GPT שבדף יוצגו מודעות וידאו. |
get | הוצא משימוש. החזרת הערך של מאפיין AdSense שמשויך למפתח הנתון. |
get | הוצא משימוש. הפונקציה מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה. |
get | קבלת רשימת המשבצות שמשויכות לשירות הזה. עובר בירושה מהשיטה |
get | הוצא משימוש. הפונקציה מחזירה פרמטר טירגוט ספציפי בהתאמה אישית ברמת השירות שהוגדר. |
get | הוצא משימוש. הפונקציה מחזירה את הרשימה של כל מפתחות הטירגוט המותאמים אישית ברמת השירות שהוגדרו. |
is | הוצא משימוש. הפונקציה מחזירה ערך שמציין אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad. |
refresh | מאחזרת ומציגה מודעות חדשות במיקומים ספציפיים או בכל המיקומים בדף. |
register | רושם הוק (hook) שיבוצע במקביל להוקים רשומים אחרים לפני כל בקשה להצגת מודעה בדף, במסגרת זמן קצוב גלובלי. |
remove | הסרת מאזין שנרשם בעבר. עובר בירושה מהשיטה |
set | הוצא משימוש. מגדירה ערכים למאפיינים של AdSense שחלים על כל מיקומי המודעות בדף בשירותי הפרסום של בעלי התוכן הדיגיטלי. |
set | הוצא משימוש. הגדרה של החרגת קטגוריית מודעות ברמת הדף לשם התווית הנתון. |
set | הוצא משימוש. הפעלה והשבתה של מרכוז אופקי של מודעות. |
set | הוצא משימוש. המדיניות קובעת אם כל המודעות בדף יעובדו באמצעות מאגר SafeFrame. |
set | הוצא משימוש. מעבירה נתוני מיקום מאתרים כדי שתוכלו לטרגט פריטים גיאוגרפית למיקומים ספציפיים. |
set | מאפשרת לקבוע את כל הגדרות הפרטיות מ-API אחד באמצעות אובייקט config. |
set | מגדירה את הערך של המזהה שסופק על ידי בעל האפליקציה. |
set | הוצא משימוש. הגדרת ההעדפות ברמת הדף להגדרת SafeFrame. |
set | הוצא משימוש. הגדרת פרמטרים מותאמים אישית לטירגוט של מפתח נתון, שחלים על כל מיקומי המודעות בדף של שירות המודעות של בעל האתר. |
set | הוצא משימוש. מגדירה את פרטי קטע הווידאו שיישלחו יחד עם הבקשות להצגת מודעות למטרות טירגוט והחרגת תוכן. |
update | משנה את המתאם שנשלח עם בקשות להצגת מודעות, וכך מתחילה צפייה חדשה בדף. |
Methods
clear
clear(slots?: Slot[]): booleanהפונקציה מסירה את המודעות ממיקומי המודעות שצוינו ומחליפה אותן בתוכן ריק. מיקומי המודעות יסומנו ככאלה שלא אוחזרו.
באופן ספציפי, ניקוי של מיקום מודעה מסיר את המודעה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות תחרותיות שקשורות למודעה הזו.
באופן ספציפי, ניקוי של מיקום מודעה מסיר את המודעה מהצפייה בדף לטווח ארוך של 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();
| פרמטרים | |
|---|---|
| מערך המיקומים שרוצים לנקות. המערך הוא אופציונלי. אם לא מציינים אותו, כל המיקומים ינוקו. |
| החזרות | |
|---|---|
boolean | הפונקציה מחזירה את הערך true אם המיקומים למודעות נוקו, ואת הערך false אם לא. |
clearCategoryExclusions
clearCategoryExclusions(): PubAdsServiceמנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. האפשרות הזו שימושית אם רוצים לרענן את מיקום המודעה.
- דוגמה
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.setConfig({ categoryExclusion: ["AirlineAd"], }); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.setConfig({ categoryExclusion: null, }); // Make ad requests. Any ad can be returned.
JavaScript (דור קודם)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.setConfig({ categoryExclusion: ["AirlineAd"], }); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.setConfig({ categoryExclusion: null, }); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.setConfig({ categoryExclusion: ["AirlineAd"], }); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.setConfig({ categoryExclusion: null, }); // Make ad requests. Any ad can be returned.
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
clearTargeting
clearTargeting(key?: string): PubAdsServiceמנקה פרמטרים של טירגוט בהתאמה אישית למפתח ספציפי או לכל המפתחות.
- דוגמה
JavaScript
googletag.setConfig({ targeting: { interests: "sports", colors: "blue", fruits: "apple", }, }); googletag.setConfig({ targeting: { interests: null, }, }); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.setConfig({ targeting: null, }); // All targeting has been cleared.
JavaScript (דור קודם)
googletag.setConfig({ targeting: { interests: "sports", colors: "blue", fruits: "apple", }, }); googletag.setConfig({ targeting: { interests: null, }, }); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.setConfig({ targeting: null, }); // All targeting has been cleared.
TypeScript
googletag.setConfig({ targeting: { interests: "sports", colors: "blue", fruits: "apple", }, }); googletag.setConfig({ targeting: { interests: null, }, }); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.setConfig({ targeting: null, }); // All targeting has been cleared.
- ראה גם
| פרמטרים | |
|---|---|
| מפתח פרמטר הטירגוט. המפתח הוא אופציונלי. אם לא תציינו אותו, כל הפרמטרים של הטירגוט יימחקו. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
collapseEmptyDivs
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): booleanמאפשר לכווץ את רכיבי ה-div של מיקומי המודעות כדי שהם לא יתפסו מקום בדף כשאין תוכן של מודעה להצגה. צריך להגדיר את המצב הזה לפני שמפעילים את השירות.
| פרמטרים | |
|---|---|
| אם לכווץ את מיקומי המודעות עוד לפני שהמודעות נשלפות. הפרמטר הזה הוא אופציונלי. אם לא תציינו אותו, המערכת תשתמש בערך ברירת המחדל false. |
| החזרות | |
|---|---|
boolean | הפונקציה מחזירה את הערך true אם מצב כיווץ ה-div הופעל, ואת הערך false אם אי אפשר להפעיל את מצב הכיווץ כי השיטה הופעלה אחרי שהשירות הופעל. |
disableInitialLoad
disableInitialLoad(): voidמשביתה בקשות להצגת מודעות בזמן טעינת הדף, אבל מאפשרת לבקש מודעות באמצעות קריאה ל-PubAdsService.refresh. צריך להגדיר את זה לפני שמפעילים את השירות. צריך להשתמש במצב אסינכרוני, אחרת אי אפשר יהיה לבקש מודעות באמצעות
refresh.תצוגה
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): voidהפונקציה הזו יוצרת ומציגה מיקום מודעה בדף עם הנתיב והגודל של יחידת המודעות שצוינו.
השיטה הזו היא קיצור דרך ששווה ערך לקריאה ל-googletag.defineSlot ואחריה מיד ל-googletag.display.
ההתנהגות של השיטה הזו תלויה בשאלה אם ארכיטקטורת בקשה בודדת (SRA) מופעלת:
השיטה הזו היא קיצור דרך ששווה ערך לקריאה ל-googletag.defineSlot ואחריה מיד ל-googletag.display.
ההתנהגות של השיטה הזו תלויה בשאלה אם ארכיטקטורת בקשה בודדת (SRA) מופעלת:
- SRA מופעל: כל מיקומי המודעות בדף שהוגדרו עד לנקודה של הקריאה הזו יקובצו ויישלחו יחד בבקשה.
- SRA מושבת (ברירת מחדל): המערכת תשלח בקשה נפרדת לכל מיקום מודעה בדף.
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 שמכיל את המיקום או רכיב ה-div עצמו. |
| כתובת אתר לקליקים שבה צריך להשתמש במיקום המודעה הזה. |
enableLazyLoad
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): voidהפונקציה מפעילה טעינה מדורגת ב-GPT, כפי שמוגדר באובייקט config. דוגמאות מפורטות יותר זמינות בדוגמה של טעינה מדורגת.
הערה: אחזור מדורג ב-SRA פועל רק אם כל מיקומי המודעות נמצאים מחוץ לשולי האחזור.
הערה: אחזור מדורג ב-SRA פועל רק אם כל מיקומי המודעות נמצאים מחוץ לשולי האחזור.
- דוגמה
JavaScript
googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, });
JavaScript (דור קודם)
googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, });
TypeScript
googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, });
| פרמטרים | |
|---|---|
| אובייקט ההגדרה מאפשר להתאים אישית את ההתנהגות של הטעינה הדרגתית. אם לא תגדירו את כל ההגדרות, המערכת תשתמש בהגדרות ברירת המחדל של Google, שישתנו עם הזמן. כדי להשבית הגדרה מסוימת, כמו שוליים לאחזור, מגדירים את הערך -1.
|
enableSingleRequest
enableSingleRequest(): booleanמפעיל מצב בקשה בודדת כדי לאחזר כמה מודעות בו-זמנית. לשם כך, צריך להגדיר את כל מיקומי המודעות בדף ולהוסיף אותם ל-PubAdsService לפני שמפעילים את השירות. צריך להגדיר מצב בקשה בודדת לפני שמפעילים את השירות.
- ראה גם
| החזרות | |
|---|---|
boolean | הפונקציה מחזירה את הערך true אם מצב בקשה בודדת הופעל, ואת הערך false אם אי אפשר להפעיל את מצב בקשה בודדת כי השיטה הופעלה אחרי שהשירות הופעל. |
enableVideoAds
enableVideoAds(): voidמאותת ל-GPT שיוצגו מודעות וידאו בדף. ההגדרה הזו מפעילה אילוצים של החרגת מודעות של מתחרים במודעות לרשת המדיה ובמודעות וידאו. אם קטע הווידאו ידוע, צריך להפעיל את PubAdsService.setVideoContent כדי להשתמש בהחרגת תוכן במודעות לרשת המדיה.
get
get(key: string): stringהפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון.
- דוגמה
JavaScript
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }); const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes; const pageUrl = adsenseConfig?.page_url || null; // Returns 'http://www.example.com'.
JavaScript (דור קודם)
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }); var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes; var pageUrl = (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null; // Returns 'http://www.example.com'.
TypeScript
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }); const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes; const pageUrl = adsenseConfig?.page_url || null; // Returns 'http://www.example.com'.
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין שרוצים לחפש. |
| החזרות | |
|---|---|
string | הערך הנוכחי של מפתח המאפיין, או null אם המפתח לא קיים. |
getAttributeKeys
getAttributeKeys(): string[]הפונקציה מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
- דוגמה
JavaScript
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", document_language: "en", }, }); const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes; const adsenseAttributes = Object.keys(adsenseConfig || {}); // Returns ['page_url', 'document_language'].
JavaScript (דור קודם)
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", document_language: "en", }, }); var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes; var adsenseAttributes = Object.keys(adsenseConfig || {}); // Returns ['page_url', 'document_language'].
TypeScript
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", document_language: "en", }, }); const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes; const adsenseAttributes = Object.keys(adsenseConfig || {}); // Returns ['page_url', 'document_language'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות מאפיינים שמוגדרים בשירות הזה. הסדר לא מוגדר. |
getTargeting
getTargeting(key: string): string[]הפונקציה מחזירה פרמטר טירגוט ספציפי בהתאמה אישית ברמת השירות שהוגדר.
- דוגמה
JavaScript
googletag.setConfig({ targeting: { interests: "sports", }, }); const targetingConfig = googletag.getConfig("targeting").targeting; // Get targeting for a specific key. const targeting = targetingConfig?.["interests"] || []; // Returns ['sports']. const ageTargeting = targetingConfig?.["age"] || []; // Returns [] (empty array).
JavaScript (דור קודם)
googletag.setConfig({ targeting: { interests: "sports", }, }); var targetingConfig = googletag.getConfig("targeting").targeting; // Get targeting for a specific key. var targeting = (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["interests"]) || []; // Returns ['sports']. var ageTargeting = (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || []; // Returns [] (empty array).
TypeScript
googletag.setConfig({ targeting: { interests: "sports", }, }); const targetingConfig = googletag.getConfig("targeting").targeting; // Get targeting for a specific key. const targeting = targetingConfig?.["interests"] || []; // Returns ['sports']. const ageTargeting = targetingConfig?.["age"] || []; // Returns [] (empty array).
| פרמטרים | |
|---|---|
key: string | מפתח הטירגוט שרוצים לחפש. |
| החזרות | |
|---|---|
string[] | הערכים שמשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה. |
getTargetingKeys
getTargetingKeys(): string[]הפונקציה מחזירה את הרשימה של כל מפתחות הטירגוט המותאמים אישית ברמת השירות שהוגדרו.
- דוגמה
JavaScript
googletag.setConfig({ targeting: { interests: "sports", colors: "blue", }, }); const targetingConfig = googletag.getConfig("targeting").targeting; const keys = Object.keys(targetingConfig || {}); // Returns ['interests', 'colors'].
JavaScript (דור קודם)
googletag.setConfig({ targeting: { interests: "sports", colors: "blue", }, }); var targetingConfig = googletag.getConfig("targeting").targeting; var keys = Object.keys(targetingConfig || {}); // Returns ['interests', 'colors'].
TypeScript
googletag.setConfig({ targeting: { interests: "sports", colors: "blue", }, }); const targetingConfig = googletag.getConfig("targeting").targeting; const keys = Object.keys(targetingConfig || {}); // Returns ['interests', 'colors'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות טירגוט. הסדר לא מוגדר. |
isInitialLoadDisabled
isInitialLoadDisabled(): booleanהפונקציה מחזירה ערך שמציין אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad.
| החזרות | |
|---|---|
boolean | הפונקציה מחזירה את הערך true אם קריאה קודמת ל-PubAdsService.disableInitialLoad הצליחה, ואת הערך false אם לא. |
refresh
refresh(slots?: Slot[], options?: {
changeCorrelator: boolean;
}): voidמאחזרת ומציגה מודעות חדשות במיקומים ספציפיים או בכל המיקומים בדף. הפונקציה פועלת רק במצב עיבוד אסינכרוני.
כדי שהפונקציה תפעל כמו שצריך בכל הדפדפנים, צריך להפעיל את
רענון של מיקום מודעה מסיר את המודעה הישנה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות תחרותיות שקשורות למודעה הזו.
כדי שהפונקציה תפעל כמו שצריך בכל הדפדפנים, צריך להפעיל את
refresh אחרי שמפעילים את display במיקום המודעה בדף. אם לא תכללו את הקריאה ל-display, יכול להיות שהרענון יתנהג באופן בלתי צפוי. אם רוצים, אפשר להשתמש ב-method 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 });
| פרמטרים | |
|---|---|
| מיקומי המודעות שרוצים לרענן. המערך הוא אופציונלי. אם לא מציינים אותו, כל מיקומי המודעות ירועננו. |
| אפשרויות ההגדרה שמשויכות לקריאת הרענון הזו.
|
registerRequestHook
registerRequestHook(hook: RequestHook, hookId: string): (() => void)Experimental רושם הוק (hook) שיבוצע במקביל להוקים רשומים אחרים לפני כל בקשה להצגת מודעה בדף, במסגרת זמן קצוב גלובלי.- דוגמה
JavaScript
// Register a request hook. const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => { const someAsynchronousAction = Promise.resolve(); await someAsynchronousAction; for (const slot of slots) { slot.setConfig({ targeting: { hookApplied: "true" } }); } }, "my-hook"); // Unregister the hook. unregister();
JavaScript (דור קודם)
// Coming soon.TypeScript
// Register a request hook. const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => { const someAsynchronousAction = Promise.resolve(); await someAsynchronousAction; for (const slot of slots) { slot.setConfig({ targeting: { hookApplied: "true" } }); } }, "my-hook"); // Unregister the hook. unregister();
| פרמטרים | |
|---|---|
hook: RequestHook | פונקציה שמקבלת אובייקט שמכיל את רשימת מיקומי המודעות המבוקשים ומחזירה הבטחה (promise) שמתממשת אחרי שכל הפעולות האסינכרוניות הושלמו. |
hookId: string | מזהה לתיוג ה-hook לצורך אבחון משופר. |
| החזרות | |
|---|---|
(() => void) | פונקציה לביטול הרישום של ה-hook. |
set
set(key: string, value: string): PubAdsServiceמגדירה ערכים למאפיינים של AdSense שחלים על כל מיקומי המודעות בדף בשירות Publisher Ads.
אם קוראים לפונקציה הזו יותר מפעם אחת לאותו מפתח, הערכים שהוגדרו קודם למפתח הזה יוחלפו. צריך להגדיר את כל הערכים לפני שקוראים ל-
אם קוראים לפונקציה הזו יותר מפעם אחת לאותו מפתח, הערכים שהוגדרו קודם למפתח הזה יוחלפו. צריך להגדיר את כל הערכים לפני שקוראים ל-
display או ל-refresh.- דוגמה
JavaScript
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, });
JavaScript (דור קודם)
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, });
TypeScript
googletag.setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, });
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין. |
value: string | ערך המאפיין. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): PubAdsServiceהגדרה של החרגת קטגוריית מודעות ברמת הדף לשם התווית הנתון.
- דוגמה
JavaScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"], });
JavaScript (דור קודם)
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"], });
TypeScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"], });
| פרמטרים | |
|---|---|
categoryExclusion: string | התווית להחרגת קטגוריית מודעות שרוצים להוסיף. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setCentering
setCentering(centerAds: boolean): voidהפעלה והשבתה של מרכוז אופקי של מודעות. כברירת מחדל, המרכוז מושבת. בגרסה הקודמת של gpt_mobile.js, המרכוז מופעל כברירת מחדל.
צריך להפעיל את השיטה הזו לפני שמפעילים את
צריך להפעיל את השיטה הזו לפני שמפעילים את
display או את refresh, כי רק מודעות שמתבקשות אחרי הפעלת השיטה הזו ימורכזו.- דוגמה
JavaScript
// Make ads centered. googletag.setConfig({ centering: true, });
JavaScript (דור קודם)
// Make ads centered. googletag.setConfig({ centering: true, });
TypeScript
// Make ads centered. googletag.setConfig({ centering: true, });
| פרמטרים | |
|---|---|
centerAds: boolean | true כדי למרכז את המודעות, false כדי ליישר אותן לשמאל. |
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): PubAdsServiceההגדרה הזו קובעת אם כל המודעות בדף צריכות לעבור עיבוד באמצעות מאגר SafeFrame.
חשוב לזכור את הדברים הבאים כשמשתמשים ב-API הזה:
חשוב לזכור את הדברים הבאים כשמשתמשים ב-API הזה:
- ההגדרה הזו תשפיע רק על בקשות עתידיות להצגת מודעות במיקומים הרלוונטיים.
- ההגדרה ברמת מיקום המודעה, אם צוינה, תמיד תבטל את ההגדרה ברמת הדף.
- אם הערך מוגדר כ-
true(ברמת מיקום המודעה או ברמת הדף), המודעה תמיד תוצג באמצעות מאגר SafeFrame, בלי קשר לבחירה שנעשתה בממשק המשתמש של Google Ad Manager. - עם זאת, אם הערך מוגדר כ-
falseאו לא צוין, המודעה תוצג באמצעות מאגר SafeFrame בהתאם לסוג הקריאייטיב ולבחירה שבוצעה בממשק המשתמש של Google Ad Manager. - צריך להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של קריאייטיבים שמנסים לצאת מה-iFrame שלהם או מסתמכים על כך שהם מוצגים ישירות בדף של בעל התוכן הדיגיטלי.
- דוגמה
JavaScript
googletag.setConfig({ safeFrame: { forceSafeFrame: true, }, }); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setConfig({ safeFrame: { forceSafeFrame: false, }, }) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (דור קודם)
googletag.setConfig({ safeFrame: { forceSafeFrame: true, }, }); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setConfig({ safeFrame: { forceSafeFrame: false, }, }) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.setConfig({ safeFrame: { forceSafeFrame: true, }, }); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setConfig({ safeFrame: { forceSafeFrame: false, }, }) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
| פרמטרים | |
|---|---|
forceSafeFrame: boolean | true כדי לאלץ את כל המודעות בדף לעבור עיבוד ב-SafeFrames, ו-false כדי לשנות את ההגדרה הקודמת ל-false. אם לא ציינתם ערך קודם, הגדרת הערך false לא תשנה דבר. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setLocation
setLocation(address: string): PubAdsServiceמעבירה נתוני מיקום מאתרים כדי שתוכלו לטרגט פריטים למיקומים גיאוגרפיים ספציפיים.
- דוגמה
JavaScript
// Postal code: googletag.setConfig({ location: "10001,US", });
JavaScript (דור קודם)
// Postal code: googletag.setConfig({ location: "10001,US", });
TypeScript
// Postal code: googletag.setConfig({ location: "10001,US", });
| פרמטרים | |
|---|---|
address: string | כתובת בפורמט חופשי. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
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 | מזהה אלפאנומרי שסופק על ידי בעל האפליקציה. השדה חייב להכיל בין 22 ל-150 תווים. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setSafeFrameConfig
setSafeFrameConfig(config: SafeFrameConfig): PubAdsServiceמגדירה את ההעדפות ברמת הדף להגדרת SafeFrame. המערכת תתעלם ממפתחות לא מזוהים באובייקט config. המערכת תתעלם מכל ההגדרות אם יועבר ערך לא חוקי למפתח מזוהה.
ההעדפות האלה ברמת הדף יוחלפו בהעדפות ברמת מיקום המודעה, אם צוינו כאלה.
ההעדפות האלה ברמת הדף יוחלפו בהעדפות ברמת מיקום המודעה, אם צוינו כאלה.
- דוגמה
JavaScript
googletag.setConfig({ safeFrame: { forceSafeFrame: true, allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }, }); googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setConfig({ safeFrame: { allowOverlayExpansion: false, }, }) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (דור קודם)
googletag.setConfig({ safeFrame: { forceSafeFrame: true, allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }, }); googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setConfig({ safeFrame: { allowOverlayExpansion: false, }, }) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.setConfig({ safeFrame: { forceSafeFrame: true, allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }, }); googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setConfig({ safeFrame: { allowOverlayExpansion: false, }, }) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
| פרמטרים | |
|---|---|
config: SafeFrameConfig | אובייקט ההגדרה. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setTargeting
setTargeting(key: string, value: string | string[]): PubAdsServiceמגדירה פרמטרים של טירגוט בהתאמה אישית למפתח נתון, שחלים על כל מיקומי המודעות בדף של שירותי הפרסום של בעל האתר. אם קוראים לפונקציה הזו כמה פעמים לאותו מפתח, הערכים הישנים יוחלפו. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
- דוגמה
JavaScript
// Example with a single value for a key. googletag.setConfig({ targeting: { interests: "sports", }, }); // Example with multiple values for a key inside in an array. googletag.setConfig({ targeting: { interests: ["sports", "music"], }, });
JavaScript (דור קודם)
// Example with a single value for a key. googletag.setConfig({ targeting: { interests: "sports", }, }); // Example with multiple values for a key inside in an array. googletag.setConfig({ targeting: { interests: ["sports", "music"], }, });
TypeScript
// Example with a single value for a key. googletag.setConfig({ targeting: { interests: "sports", }, }); // Example with multiple values for a key inside in an array. googletag.setConfig({ targeting: { interests: ["sports", "music"], }, });
- ראה גם
| פרמטרים | |
|---|---|
key: string | מפתח פרמטר הטירגוט. |
value: string | string[] | ערך פרמטר טירגוט או מערך של ערכים. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setVideoContent
setVideoContent(videoContentId: string, videoCmsId: string): voidמגדירה את פרטי קטע הווידאו שיישלחו יחד עם הבקשות להצגת מודעות לצורכי טירגוט והחרגת תוכן. מודעות הווידאו יופעלו באופן אוטומטי כשהשיטה הזו תיקרא. בשביל
videoContentId ו-videoCmsId, צריך להשתמש בערכים שסופקו לשירות ניתוח התוכן של Google Ad Manager.| פרמטרים | |
|---|---|
videoContentId: string | מזהה Content ID של קטע וידאו. |
videoCmsId: string | מזהה מערכת ניהול התוכן של הסרטון. |
updateCorrelator
updateCorrelator(): PubAdsServiceמשנה את המתאם שנשלח עם בקשות להצגת מודעות, וכך מתחילה צפייה חדשה בדף. הקורלטור זהה לכל הבקשות להצגת מודעות שמגיעות מצפייה אחת בדף, והוא ייחודי לכל צפייה בדף. ההגדרה הזו רלוונטית רק למצב אסינכרוני.
הערה: ההגדרה הזו לא משפיעה על הצפייה בדף לטווח ארוך של GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות בפועל בדף ואין לה זמן תפוגה.
הערה: ההגדרה הזו לא משפיעה על הצפייה בדף לטווח ארוך של 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.RequestHook
פונקציית קריאה חוזרת (callback) שמופעלת לפני כל בקשה להצגת מודעה כשהיא רשומה דרך PubAdsService.registerRequestHook.
googletag.ResponseInformation
אובייקט שמייצג תגובה אחת למודעה.
| מאפיינים | |
|---|---|
advertiser | המזהה של המפרסם. |
campaign | המזהה של הקמפיין. |
creative | המזהה של הקריאייטיב. |
creative | מזהה התבנית של המודעה. |
line | המזהה של הפריט. |
מאפיינים
advertiserId
advertiserId: numbercampaignId
campaignId: numbercreativeId
creativeId: numbercreativeTemplateId
creativeTemplateId: numberlineItemId
lineItemId: numbergoogletag.RewardedPayload
אובייקט שמייצג את הפרס שמשויך למודעה מתגמלת
| מאפיינים | |
|---|---|
amount | מספר הפריטים שכלולים בפרס. |
type | סוג הפריט שכלול בתגמול (לדוגמה, "מטבע"). |
- ראה גם
מאפיינים
amount
amount: numbertype
type: stringgoogletag.Service
מחלקה בסיסית של שירות שמכילה שיטות שמשותפות לכל השירותים.
| Methods | |
|---|---|
add | רושמת פונקציית listener שמאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. |
get | קבלת רשימת המשבצות שמשויכות לשירות הזה. |
remove | הסרת מאזין שנרשם בעבר. |
Methods
addEventListener
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Serviceרושמת פונקציית listener שמאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. אפשר להשתמש באירועים הבאים:
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- דוגמה
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (דור קודם)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
| פרמטרים | |
|---|---|
eventType: K | מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות. |
listener: ((arg: EventTypeMap[K]) => void) | פונקציה שמקבלת ארגומנט של אובייקט אירוע אחד. |
| החזרות | |
|---|---|
Service | אובייקט השירות שבו הופעלה השיטה. |
getSlots
removeEventListener
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): voidהסרת מאזין שנרשם בעבר.
- דוגמה
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (דור קודם)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
| פרמטרים | |
|---|---|
eventType: K | מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות. |
listener: ((event: EventTypeMap[K]) => void) | פונקציה שמקבלת ארגומנט של אובייקט אירוע יחיד. |
googletag.SizeMappingBuilder
כלי ליצירת אובייקטים של מפרט מיפוי גודל. הכלי הזה נועד לעזור לכם ליצור בקלות מפרטי גודל.
| Methods | |
|---|---|
add | מוסיפה מיפוי ממערך בגודל יחיד (שמייצג את אזור התצוגה) למערך בגודל יחיד או בגדלים מרובים שמייצג את מיקום המודעה. |
build | יוצרת מפרט של מיפוי גודל מהמיפויים שנוספו ל-builder הזה. |
Methods
addSize
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilderמוסיפה מיפוי ממערך בגודל יחיד (שמייצג את אזור התצוגה) למערך בגודל יחיד או בגדלים מרובים שמייצג את מיקום המודעה.
- דוגמה
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (דור קודם)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
| פרמטרים | |
|---|---|
viewportSize: SingleSizeArray | גודל אזור התצוגה של רשומת המיפוי הזו. |
slotSize: GeneralSize | הגדלים של מיקום המודעה ברשומה הזו של המיפוי. |
| החזרות | |
|---|---|
SizeMappingBuilder | הפניה ל-builder הזה. |
build
build(): SizeMappingArrayיוצר מפרט של מיפוי גדלים מהמיפויים שנוספו ל-builder הזה.
אם סופקו מיפויים לא חוקיים, השיטה הזו תחזיר
הערה: ההתנהגות של ה-builder אחרי הקריאה ל-method הזה לא מוגדרת.
אם סופקו מיפויים לא חוקיים, השיטה הזו תחזיר
null. אחרת, היא מחזירה מפרט בפורמט הנכון להעברה אל Slot.defineSizeMapping.הערה: ההתנהגות של ה-builder אחרי הקריאה ל-method הזה לא מוגדרת.
| החזרות | |
|---|---|
SizeMappingArray | התוצאה שנוצרה על ידי ה-builder הזה. הערך יכול להיות null אם סופקו מיפויים לא חוקיים של גודל. |
googletag.Slot
מיקום מודעה בדף הוא אובייקט שמייצג מיקום מודעה יחיד בדף.
| Methods | |
|---|---|
add | הוספת שירות למשבצת הזו. |
clear | הוצא משימוש. מנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת מיקום המודעה במיקום המודעה הזה. |
clear | הוצא משימוש. מנקה פרמטרים ספציפיים או את כל הפרמטרים המותאמים אישית של טירגוט ברמת מיקום המודעה במיקום המודעה הזה. |
define | הגדרה של מערך מיפויים מגודל מינימלי של אזור תצוגה לגודל של מיקום המודעה הזה. |
get | הוצא משימוש. הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח שצוין למיקום המודעה הזה. |
get | החזרת הנתיב המלא של יחידת המודעות, עם קוד הרשת והנתיב של יחידת המודעות. |
get | הוצא משימוש. החזרת רשימה של מפתחות מאפיינים שמוגדרים במיקום המודעה הזה. |
get | הוצא משימוש. מחזירה את תוויות ההחרגה של קטגוריות המודעות במיקום המודעה הזה. |
get | הפונקציה הזו מקבלת עותק קפוא של אפשרויות ההגדרה הכלליות של המיקום שהוגדר על ידי setConfig. |
get | מחזירה את פרטי התגובה למודעה. |
get | מחזירה את המזהה של מיקום המודעה div שסופק כשהמיקום הוגדר. |
get | הוצא משימוש. הפונקציה מחזירה פרמטר ספציפי של טירגוט בהתאמה אישית שמוגדר במיקום המודעה הזה. |
get | הוצא משימוש. הפונקציה מחזירה את הרשימה של כל מפתחות הטירגוט בהתאמה אישית שמוגדרים במיקום המודעה הזה. |
set | הוצא משימוש. מגדירה ערך למאפיין של AdSense במיקום המודעה הזה בדף. |
set | הוצא משימוש. מגדירה תווית החרגה של קטגוריית מודעות ברמת מיקום המודעה במיקום המודעה הזה. |
set | הוצא משימוש. מגדירה את כתובת אתר לקליקים שאליה המשתמשים יופנו אחרי שילחצו על המודעה. |
set | הוצא משימוש. הגדרה אם להסתיר את מיקום המודעה div כשאין בו מודעה. |
set | הגדרת אפשרויות כלליות למיקום המודעה הזה. |
set | הוצא משימוש. ההגדרה הזו קובעת אם המודעות במיקום הזה יוצגו באמצעות מאגר SafeFrame. |
set | הוצא משימוש. הגדרת ההעדפות ברמת מיקום המודעה להגדרות של SafeFrame. |
set | הוצא משימוש. הגדרת פרמטר טירגוט מותאם אישית למיקום המודעה הזה. |
update | הוצא משימוש. הגדרת פרמטרים של טירגוט בהתאמה אישית למיקום המודעה הזה, ממפה של מפתח:ערך באובייקט JSON. |
Methods
addService
addService(service: Service): Slotהוספת שירות למשבצת הזו.
- דוגמה
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (דור קודם)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
| פרמטרים | |
|---|---|
service: Service | השירות שרוצים להוסיף. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה השיטה. |
clearCategoryExclusions
clearCategoryExclusions(): Slotמנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת מיקום המודעה עבור מיקום המודעה הזה.
- דוגמה
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ categoryExclusion: ["AirlineAd"], }) .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.setConfig({ categoryExclusion: null, }); // Make an ad request. Any ad can be returned for the slot.
JavaScript (דור קודם)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ categoryExclusion: ["AirlineAd"], }) .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.setConfig({ categoryExclusion: null, }); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ categoryExclusion: ["AirlineAd"], }) .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.setConfig({ categoryExclusion: null, }); // Make an ad request. Any ad can be returned for the slot.
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה השיטה. |
clearTargeting
clearTargeting(key?: string): Slotמנקה פרמטרים ספציפיים או את כל הפרמטרים המותאמים אישית של טירגוט ברמת מיקום המודעה עבור מיקום המודעה הזה.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ targeting: { allow_expandable: "true", interests: ["sports", "music"], color: "red", }, }) .addService(googletag.pubads()); slot.setConfig({ targeting: { color: null, }, }); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.setConfig({ targeting: null, }); // All targeting has been cleared.
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ targeting: { allow_expandable: "true", interests: ["sports", "music"], color: "red", }, }) .addService(googletag.pubads()); slot.setConfig({ targeting: { color: null, }, }); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.setConfig({ targeting: null, }); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ targeting: { allow_expandable: "true", interests: ["sports", "music"], color: "red", }, }) .addService(googletag.pubads()); slot.setConfig({ targeting: { color: null, }, }); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.setConfig({ targeting: null, }); // All targeting has been cleared.
- ראה גם
| פרמטרים | |
|---|---|
| מפתח פרמטר הטירגוט. המפתח הוא אופציונלי. אם לא תציינו אותו, כל הפרמטרים של הטירגוט יימחקו. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה השיטה. |
defineSizeMapping
defineSizeMapping(sizeMapping: SizeMappingArray): Slotהגדרה של מערך מיפויים מגודל מינימלי של אזור תצוגה לגודל של מיקום המודעה הזה.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping!);
| פרמטרים | |
|---|---|
sizeMapping: SizeMappingArray | מערך של מיפויי גודל. אפשר להשתמש ב-SizeMappingBuilder כדי ליצור אותו. כל מיפוי גודל הוא מערך של שני רכיבים: SingleSizeArray ו-GeneralSize. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
get
get(key: string): stringמחזירה את הערך של מאפיין AdSense שמשויך למפתח שצוין עבור מיקום המודעה הזה. כדי לראות מאפיינים ברמת השירות שהמיקום הזה ירש, משתמשים ב-PubAdsService.get.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }) .addService(googletag.pubads()); const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes; const pageUrl = adsenseConfig?.page_url || null; // Returns 'http://www.example.com'.
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }) .addService(googletag.pubads()); var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes; var pageUrl = (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null; // Returns 'http://www.example.com'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }) .addService(googletag.pubads()); const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes; const pageUrl = adsenseConfig?.page_url || null; // Returns 'http://www.example.com'.
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין שרוצים לחפש. |
| החזרות | |
|---|---|
string | הערך הנוכחי של מפתח המאפיין, או null אם המפתח לא קיים. |
getAdUnitPath
getAdUnitPath(): stringהפונקציה מחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת והנתיב של יחידת המודעות.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
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") .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", document_language: "en", }, }) .addService(googletag.pubads()); const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes; const adsenseAttributes = Object.keys(adsenseConfig || {}); // Returns ['page_url', 'document_language'].
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", document_language: "en", }, }) .addService(googletag.pubads()); var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes; var adsenseAttributes = Object.keys(adsenseConfig || {}); // Returns ['page_url', 'document_language'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", document_language: "en", }, }) .addService(googletag.pubads()); const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes; const adsenseAttributes = Object.keys(adsenseConfig || {}); // Returns ['page_url', 'document_language'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות מאפיינים. הסדר לא מוגדר. |
getCategoryExclusions
getCategoryExclusions(): string[]הפונקציה מחזירה את תוויות ההחרגה של קטגוריות המודעות למיקום המודעה הזה.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ categoryExclusion: ["AirlineAd", "TrainAd"], }) .addService(googletag.pubads()); const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || []; // Returns ['AirlineAd', 'TrainAd'].
JavaScript (דור קודם)
var _a; var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ categoryExclusion: ["AirlineAd", "TrainAd"], }) .addService(googletag.pubads()); var exclusions = ((_a = slot.getConfig("categoryExclusion")) === null || _a === void 0 ? void 0 : _a.categoryExclusion) || []; // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ categoryExclusion: ["AirlineAd", "TrainAd"], }) .addService(googletag.pubads()); const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || []; // Returns ['AirlineAd', 'TrainAd'].
| החזרות | |
|---|---|
string[] | תוויות ההחרגה של קטגוריות המודעות במיקום הזה, או מערך ריק אם לא הוגדרו תוויות. |
getConfig
getConfig(keys: string | string[]): Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>הפונקציה הזו מקבלת עותק קפוא של אפשרויות ההגדרה הכלליות של מיקום המודעה שהוגדר על ידי setConfig.
לא כל המאפיינים של
לא כל המאפיינים של
setConfig() נתמכים בשיטה הזו. המאפיינים הנתמכים הם:- דוגמה
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); // Get the value of the `targeting` setting. const targetingConfig = slot.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `categoryExclusion` settings. const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
JavaScript (דור קודם)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); // Get the value of the `targeting` setting. var targetingConfig = slot.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `categoryExclusion` settings. var config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; // Get the value of the `targeting` setting. const targetingConfig = slot.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `categoryExclusion` settings. const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
| פרמטרים | |
|---|---|
keys: string | string[] | המפתחות של אפשרויות ההגדרה שרוצים לקבל. |
| החזרות | |
|---|---|
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">> | עותק קפוא של אפשרויות ההגדרה של המיקום. |
getResponseInformation
getResponseInformation(): ResponseInformationמחזירה את פרטי התגובה למודעה. הנתון הזה מבוסס על התגובה האחרונה לבקשה להצגת מודעה במיקום המודעה. אם הפונקציה הזו נקראת כשאין מודעה במיקום, יוחזר הערך
null.| החזרות | |
|---|---|
ResponseInformation | המידע העדכני ביותר על התגובה לבקשה להצגת מודעה, או null אם אין מודעה במיקום המודעה. |
getSlotElementId
getSlotElementId(): stringמחזירה את המזהה של מיקום המודעה
div שסופק כשהמיקום הוגדר.- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
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") .setConfig({ targeting: { allow_expandable: "true", }, }) .addService(googletag.pubads()); const targetingConfig = slot.getConfig("targeting").targeting; // Get targeting for a specific key. const targeting = targetingConfig?.["allow_expandable"] || []; // Returns ['true']. const ageTargeting = targetingConfig?.["age"] || []; // Returns [] (empty array).
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ targeting: { allow_expandable: "true", }, }) .addService(googletag.pubads()); var targetingConfig = slot.getConfig("targeting").targeting; // Get targeting for a specific key. var targeting = (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["allow_expandable"]) || []; // Returns ['true']. var ageTargeting = (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || []; // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ targeting: { allow_expandable: "true", }, }) .addService(googletag.pubads()); const targetingConfig = slot.getConfig("targeting").targeting; // Get targeting for a specific key. const targeting = targetingConfig?.["allow_expandable"] || []; // Returns ['true']. const ageTargeting = targetingConfig?.["age"] || []; // Returns [] (empty array).
| פרמטרים | |
|---|---|
key: string | מפתח הטירגוט שרוצים לחפש. |
| החזרות | |
|---|---|
string[] | הערכים שמשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה. |
getTargetingKeys
getTargetingKeys(): string[]החזרת הרשימה של כל מפתחות הטירגוט בהתאמה אישית שמוגדרים במשבצת הזו. מפתחות טירגוט ברמת השירות לא נכללים.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ targeting: { allow_expandable: "true", interests: ["sports", "music"], }, }) .addService(googletag.pubads()); const targetingConfig = slot.getConfig("targeting").targeting; const keys = Object.keys(targetingConfig || {}); // Returns ['interests', 'allow_expandable'].
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ targeting: { allow_expandable: "true", interests: ["sports", "music"], }, }) .addService(googletag.pubads()); var targetingConfig = slot.getConfig("targeting").targeting; var keys = Object.keys(targetingConfig || {}); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ targeting: { allow_expandable: "true", interests: ["sports", "music"], }, }) .addService(googletag.pubads()); const targetingConfig = slot.getConfig("targeting").targeting; const keys = Object.keys(targetingConfig || {}); // Returns ['interests', 'allow_expandable'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות טירגוט. הסדר לא מוגדר. |
set
set(key: string, value: string): Slotמגדיר ערך למאפיין של AdSense במיקום המודעה הזה בדף. הפעולה הזו תבטל את הערכים שהוגדרו ברמת השירות למפתח הזה.
אם תפעילו את ה-method הזו יותר מפעם אחת לאותו מפתח, הערכים שהוגדרו קודם למפתח הזה יבוטלו. צריך להגדיר את כל הערכים לפני שקוראים ל-
אם תפעילו את ה-method הזו יותר מפעם אחת לאותו מפתח, הערכים שהוגדרו קודם למפתח הזה יבוטלו. צריך להגדיר את כל הערכים לפני שקוראים ל-
display או ל-refresh.- דוגמה
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }) .addService(googletag.pubads());
JavaScript (דור קודם)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }) .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ adsenseAttributes: { page_url: "http://www.example.com", }, }) .addService(googletag.pubads());
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין. |
value: string | ערך המאפיין. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): Slotמגדירה במיקום המודעה הזה תווית להחרגת קטגוריית מודעות ברמת מיקום המודעה.
- דוגמה
JavaScript
// Label = AirlineAd. googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ categoryExclusion: ["AirlineAd"], }) .addService(googletag.pubads());
JavaScript (דור קודם)
// Label = AirlineAd. googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ categoryExclusion: ["AirlineAd"], }) .addService(googletag.pubads());
TypeScript
// Label = AirlineAd. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ categoryExclusion: ["AirlineAd"], }) .addService(googletag.pubads());
| פרמטרים | |
|---|---|
categoryExclusion: string | התווית להחרגת קטגוריית מודעות שרוצים להוסיף. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
setClickUrl
setClickUrl(value: string): Slotמגדירה את כתובת אתר לקליקים שאליה המשתמשים יופנו אחרי שילחצו על המודעה.
השרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת אתר לקליקים מוחלפת. כל כתובת דף נחיתה שמשויכת לקריאייטיב שמוצג מצורפת לערך שצוין. קריאות עוקבות מחליפות את הערך. האפשרות הזו פועלת רק בבקשות שאינן SRA.
השרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת אתר לקליקים מוחלפת. כל כתובת דף נחיתה שמשויכת לקריאייטיב שמוצג מצורפת לערך שצוין. קריאות עוקבות מחליפות את הערך. האפשרות הזו פועלת רק בבקשות שאינן SRA.
- דוגמה
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ clickUrl: "http://www.example.com?original_click_url=", }) .addService(googletag.pubads());
JavaScript (דור קודם)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setConfig({ clickUrl: "http://www.example.com?original_click_url=", }) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setConfig({ clickUrl: "http://www.example.com?original_click_url=", }) .addService(googletag.pubads());
| פרמטרים | |
|---|---|
value: string | כתובת אתר לקליקים שרוצים להגדיר. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
setCollapseEmptyDiv
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slotההגדרה הזו קובעת אם להסתיר את מיקום המודעה
div כשאין בו מודעה. ההגדרה הזו מבטלת את ההגדרות ברמת השירות.- דוגמה
JavaScript
const slot1 = googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setConfig({ collapseDiv: "BEFORE_FETCH", }) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. const slot2 = googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setConfig({ collapseDiv: "ON_NO_FILL", }) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (דור קודם)
var slot1 = googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setConfig({ collapseDiv: "BEFORE_FETCH", }) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. var slot2 = googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setConfig({ collapseDiv: "ON_NO_FILL", }) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
const slot1 = googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setConfig({ collapseDiv: "BEFORE_FETCH", }) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. const slot2 = googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setConfig({ collapseDiv: "ON_NO_FILL", }) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
| פרמטרים | |
|---|---|
collapse: boolean | האם לכווץ את מיקום המודעה אם לא מוצגת מודעה. |
| אם לכווץ את מיקום המודעה עוד לפני שהמודעה נשלפת. המערכת מתעלמת מהמאפיין אם הערך של collapse הוא לא true. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
setConfig
setConfig(slotConfig: SlotSettingsConfig): Slotהגדרת אפשרויות כלליות למיקום המודעה הזה.
| פרמטרים | |
|---|---|
slotConfig: SlotSettingsConfig | אובייקט ההגדרה. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): Slotמגדיר אם המודעות במיקום הזה צריכות להיות מוצגות באמצעות מאגר SafeFrame.
חשוב לזכור את הדברים הבאים כשמשתמשים ב-API הזה:
חשוב לזכור את הדברים הבאים כשמשתמשים ב-API הזה:
- ההגדרה הזו תשפיע רק על בקשות עתידיות להצגת מודעות במיקומים הרלוונטיים.
- ההגדרה ברמת מיקום המודעה, אם צוינה, תמיד תבטל את ההגדרה ברמת הדף.
- אם הערך מוגדר כ-
true(ברמת מיקום המודעה או ברמת הדף), המודעה תמיד תוצג באמצעות מאגר SafeFrame, בלי קשר לבחירה שנעשתה בממשק המשתמש של Google Ad Manager. - עם זאת, אם הערך מוגדר כ-
falseאו לא צוין, המודעה תוצג באמצעות מאגר SafeFrame בהתאם לסוג הקריאייטיב ולבחירה שבוצעה בממשק המשתמש של Google Ad Manager. - צריך להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של קריאייטיבים שמנסים לצאת מה-iFrame שלהם או מסתמכים על כך שהם מוצגים ישירות בדף של בעל התוכן הדיגיטלי.
- דוגמה
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (דור קודם)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
| פרמטרים | |
|---|---|
forceSafeFrame: boolean | true כדי לאלץ את כל המודעות במיקום הזה לעבור עיבוד ב-SafeFrames, ו-false כדי לבטל את ההסכמה להגדרה ברמת הדף (אם קיימת). אם לא צוין ערך ברמת הדף, הגדרת הערך false לא תשנה דבר. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
setSafeFrameConfig
setSafeFrameConfig(config: 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: SafeFrameConfig | אובייקט ההגדרה. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
setTargeting
setTargeting(key: string, value: string | string[]): Slotהגדרת פרמטר טירגוט מותאם אישית למיקום המודעה הזה. אם קוראים לשיטה הזו כמה פעמים לאותו מפתח, הערכים הישנים יוחלפו. הערכים שמוגדרים כאן יחליפו את פרמטרי הטירגוט שמוגדרים ברמת השירות. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
- דוגמה
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.addService(googletag.pubads()); // Example with a single value for a key. slot.setConfig({ targeting: { allow_expandable: "true", }, }); // Example with multiple values for a key inside in an array. slot.setConfig({ targeting: { interests: ["sports", "music"], }, });
JavaScript (דור קודם)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.addService(googletag.pubads()); // Example with a single value for a key. slot.setConfig({ targeting: { allow_expandable: "true", }, }); // Example with multiple values for a key inside in an array. slot.setConfig({ targeting: { interests: ["sports", "music"], }, });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.addService(googletag.pubads()); // Example with a single value for a key. slot.setConfig({ targeting: { allow_expandable: "true", }, }); // Example with multiple values for a key inside in an array. slot.setConfig({ targeting: { interests: ["sports", "music"], }, });
- ראה גם
| פרמטרים | |
|---|---|
key: string | מפתח פרמטר הטירגוט. |
value: string | string[] | ערך פרמטר טירגוט או מערך של ערכים. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-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: { | מפת צמדי מפתח/ערך של פרמטר טירגוט. |
| החזרות | |
|---|---|
Slot | אובייקט המיקום שבו הופעלה ה-method. |
googletag.config
ממשק ההגדרות הראשי להגדרות ברמת הדף.
| ממשקים | |
|---|---|
Ad | הגדרות לשליטה בהרחבת המודעות. |
Ad | הגדרות שקובעות את ההתנהגות של מודעות AdSense. |
Auto | הגדרות של רענון אוטומטי. |
Continue | הגדרות לקביעת ההתנהגות של לחצן ההמשך. |
Interstitial | אובייקט שמגדיר את ההתנהגות של מיקום מודעה יחיד של מודעת מעברון. |
Lazy | הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT. |
Page | ממשק ההגדרות הראשי להגדרות ברמת הדף. |
Privacy | הגדרות לשליטה בטיפול של בעלי תוכן דיגיטלי בפרטיות. |
Publisher | אובייקט ההגדרה של אותות שמספקים בעלי תוכן דיגיטלי (PPS). |
Safe | הגדרות לשליטה ב-SafeFrame ב-GPT. |
Slot | ממשק ההגדרות הראשי להגדרות ברמת מיקום המודעה. |
Taxonomy | אובייקט שמכיל את הערכים של טקסונומיה אחת. |
Video | הגדרות שקשורות למודעות וידאו. |
| כינויי סוגים | |
|---|---|
Collapse | ערכים נתמכים לשליטה בהתנהגות הכיווץ של מיקומי מודעות בדף. |
Interstitial | טריגרים נתמכים להצגת מודעות מעברון. |
Privacy | אמצעים נתמכים לשמירה על פרטיות המשתמשים. |
Taxonomy | טקסונומיות נתמכות לאותות שמספקים בעלי תוכן דיגיטלי (PPS). |
כינויי סוגים
CollapseDivBehavior
CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"הערה: החל מ-15 ביוני 2026, הטריגר
backward לא ייתמך יותר, והפעלתו לא תשפיע. מידע נוסף זמין בנתוני הגרסה של GPT.PrivacyTreatment
PrivacyTreatment: "disablePersonalization"טקסונומיה
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"googletag.config.AdExpansionConfig
הגדרות לשליטה בהרחבת המודעות.
| מאפיינים | |
|---|---|
enabled | אם התכונה 'מיקום מודעה מתרחב' מופעלת או מושבתת. |
- דוגמה
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (דור קודם)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
מאפיינים
Optional מופעל
enabled?: booleanהגדרת הערך הזה מבטלת את ברירת המחדל שהוגדרה ב-Google Ad Manager.
googletag.config.AdSenseAttributesConfig
הגדרות ששולטות בהתנהגות של מודעות AdSense.
אפשר להשתמש במאפיינים האלה כדי לשנות את ההגדרות בצד השרת בכל בקשה בנפרד.
אפשר להשתמש במאפיינים האלה כדי לשנות את ההגדרות בצד השרת בכל בקשה בנפרד.
| מאפיינים | |
|---|---|
adsense | פורמט מודעה ב-AdSense. |
adsense | מזהי ערוצים ב-AdSense. |
adsense | אם מצב הבדיקה מופעל או לא. |
document | השפה של הדף שבו מוצגות המודעות. |
page | כתובת ה-URL של הדף שבו מוצגות מודעות. |
מאפיינים
Optional adsense_ad_format
adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"Optional adsense_channel_ids
adsense_channel_ids?: stringהערכים המותרים הם מזהי ערוצים שמופרדים בתו "+".
דוגמה:
271828183+314159265Optional adsense_test_mode
adsense_test_mode?: "on"כשהערך מוגדר כ-
on, המודעות מסומנות כמודעות לבדיקה בלבד, והן לא ייכללו בספירה או בחיוב. צריך לבטל את ההגדרה הזו בתנועה אמיתית, לא לבדיקה.Optional document_language
document_language?: stringהערכים המותרים הם קודי שפה תקינים לפי תקן ISO 639-1.
דוגמה:
enOptional page_url
page_url?: stringהערכים המותרים הם כתובות URL תקינות.
דוגמה:
http://www.example.comgoogletag.config.AutoRefreshConfig
הגדרות של רענון אוטומטי.
| מאפיינים | |
|---|---|
back | אם תג ה-GPT ירענן באופן אוטומטי מיקום מודעה בדף שצופים בו באופן פעיל כשהדף משוחזר מהמטמון לדף הקודם/הבא. |
heavy | אם GPT ירענן באופן אוטומטי מיקום מודעה בדף אם התכונה "התערבות במודעות כבדות" של Chrome תופעל ב-iframe של המודעה במיקום המודעה בדף. |
מאפיינים
Optional backForwardCache
backForwardCache?: booleantrue.- דוגמה
JavaScript
// Set the auto refresh configuration, disabling auto refresh on // back/forward cache restore. googletag.setConfig({ autoRefresh: { backForwardCache: false } }); // Clear the auto refresh configuration, restoring to default behavior. googletag.setConfig({ autoRefresh: null });
JavaScript (דור קודם)
// Set the auto refresh configuration, disabling auto refresh on // back/forward cache restore. googletag.setConfig({ autoRefresh: { backForwardCache: false } }); // Clear the auto refresh configuration, restoring to default behavior. googletag.setConfig({ autoRefresh: null });
TypeScript
// Set the auto refresh configuration, disabling auto refresh on // back/forward cache restore. googletag.setConfig({ autoRefresh: { backForwardCache: false } }); // Clear the auto refresh configuration, restoring to default behavior. googletag.setConfig({ autoRefresh: null });
Optional heavyAds
heavyAds?: booleantrue.- דוגמה
JavaScript
// Set the auto refresh configuration, disabling auto refresh on heavy // ad intervention. googletag.setConfig({ autoRefresh: { heavyAds: false } }); // Clear the auto refresh configuration, restoring to default behavior. googletag.setConfig({ autoRefresh: null });
JavaScript (דור קודם)
// Set the auto refresh configuration, disabling auto refresh on heavy // ad intervention. googletag.setConfig({ autoRefresh: { heavyAds: false } }); // Clear the auto refresh configuration, restoring to default behavior. googletag.setConfig({ autoRefresh: null });
TypeScript
// Set the auto refresh configuration, disabling auto refresh on heavy // ad intervention. googletag.setConfig({ autoRefresh: { heavyAds: false } }); // Clear the auto refresh configuration, restoring to default behavior. googletag.setConfig({ autoRefresh: null });
googletag.config.ContinueButtonConfig
הגדרות לקביעת ההתנהגות של לחצן ההמשך.
| מאפיינים | |
|---|---|
background | צבע הרקע של הכפתור. |
font | משפחת הגופנים של הטקסט בלחצן. |
font | צבע הטקסט של הכפתור. |
freq | מרווח הזמן של מכסת התדירות בדקות. |
target | המזהה של רכיב ה-HTML שבו יוצג או יופעל כפתור ההמשך. |
מאפיינים
Optional backgroundColor
backgroundColor?: stringדוגמה:
'blue', '#94B1FF'Optional גופן
font?: stringדוגמה:
'Arial'Optional fontColor
fontColor?: stringדוגמה:
'white', '#B73B87'Optional freqCapIntervalMinutes
freqCapIntervalMinutes?: numberחייב להיות מספר שלם שגדול מ-1 או שווה לו.
Optional targetId
targetId?: stringgoogletag.config.InterstitialConfig
אובייקט שמגדיר את ההתנהגות של מיקום מודעה יחיד של מודעת מעברון.
| מאפיינים | |
|---|---|
require | אם נדרשת הסכמה לאחסון מקומי כדי להציג את מודעת המעברון הזו. |
triggers | הגדרת הטריגר של מודעת המעברון הזו. |
מאפיינים
Optional requireStorageAccess
requireStorageAccess?: booleanGPT משתמש באחסון מקומי כדי לאכוף מכסת תדירות למודעות מעברון. עם זאת, עדיין אפשר להציג מודעות מעברון למשתמשים שלא נתנו הסכמה לאחסון מקומי. אם מגדירים את המאפיין הזה לערך
true, מבטלים את פעולת ברירת המחדל ומוודאים שמודעות המעברון יוצגו רק למשתמשים שהביעו הסכמה לאחסון מקומי.- דוגמה
JavaScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
JavaScript (דור קודם)
// Opt out of showing interstitials to users // without local storage consent. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
TypeScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
Optional טריגרים
triggers?: Partial<Record<InterstitialTrigger, boolean>>הגדרת הערך של טריגר מודעת מעברון ל-
true תפעיל אותו, והגדרת הערך ל-false תשבית אותו. הפעולה הזו תבטל את ערכי ברירת המחדל שהוגדרו ב-Google Ad Manager.- דוגמה
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (דור קודם)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
googletag.config.LazyLoadConfig
הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT.
| מאפיינים | |
|---|---|
fetch | המרחק המינימלי של מיקום המודעה מאזור התצוגה הנוכחי שנדרש כדי שנבקש מודעה, מבוטא כאחוז מגודל אזור התצוגה. |
mobile | מכפיל שמוחל על שוליים במכשירים ניידים. |
render | המרחק המינימלי של מיקום המודעה מאזור התצוגה הנוכחי שנדרש כדי שהמודעה תוצג, מבוטא כאחוז מגודל אזור התצוגה. |
מאפיינים
Optional fetchMarginPercent
fetchMarginPercent?: numberההגדרה הזו משמשת בשילוב עם renderMarginPercent, ומאפשרת לאחזר מראש מודעה, אבל להמתין לעיבוד ולהורדה של משאבי משנה אחרים. לכן, הערך הזה תמיד צריך להיות גדול מ-renderMarginPercent או שווה לו.
הערך
0 פירושו "כאשר מיקום המודעה נכנס לאזור התצוגה", הערך 100 פירושו "כאשר המודעה נמצאת במרחק של אזור תצוגה אחד", וכן הלאה.Optional mobileScaling
mobileScaling?: numberכך אפשר להגדיר שוליים שונים לניידים ולמחשבים, שבהם הגדלים של אזור התצוגה ומהירויות הגלילה עשויים להיות שונים. לדוגמה, אם הערך הוא 2.0, כל השוליים יוכפלו ב-2 במכשירים ניידים, והמרחק המינימלי שמיקום המודעה יכול להיות בו מהאזור שמוצג במסך לפני האחזור והרינדור יגדל.
Optional renderMarginPercent
renderMarginPercent?: numberההגדרה הזו משמשת בשילוב עם fetchMarginPercent, ומאפשרת לאחזר מראש מודעה, אבל להמתין לפני ההצגה וההורדה של משאבי משנה אחרים. לכן, הערך הזה תמיד צריך להיות קטן או שווה ל-fetchMarginPercent.
הערך
0 פירושו "כאשר מיקום המודעה נכנס לאזור התצוגה", הערך 100 פירושו "כאשר המודעה נמצאת במרחק של אזור תצוגה אחד", וכן הלאה.googletag.config.PageSettingsConfig
ממשק ההגדרות הראשי להגדרות ברמת הדף.
מאפשר להגדיר כמה תכונות באמצעות קריאה ל-API אחת.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות שבסוג PageSettingsConfig בהמשך.
דוגמאות:
מאפשר להגדיר כמה תכונות באמצעות קריאה ל-API אחת.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות שבסוג PageSettingsConfig בהמשך.
דוגמאות:
- רק התכונות שצוינו בקריאה googletag.setConfig ישתנו.
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה מסוימת מתעדכנות בכל קריאה ל-googletag.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- כדי למחוק את כל ההגדרות של תכונה מסוימת, צריך להעביר את הערך
null.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
| מאפיינים | |
|---|---|
ad | הגדרות לשליטה בהרחבת המודעות. |
adsense | הגדרה לקביעת מאפייני AdSense. |
ad | הוצא משימוש. |
auto | הגדרה לקביעת אופן הפעולה של רענון המודעות האוטומטי. |
category | הגדרה לקביעת החרגות של קטגוריות מודעות. |
centering | הגדרה ששולטת במרכוז האופקי של המודעות. |
collapse | הגדרה שקובעת את אופן הכיווץ של מיקומי המודעות בדף. |
disable | הגדרה שקובעת מתי נשלחות בקשות להצגת מודעות. |
lazy | הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT. |
location | הגדרה לטירגוט גיאוגרפי של פריטים למיקומים גיאוגרפיים. |
pps | הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS). |
privacy | הגדרות לשליטה בטיפול של בעלי תוכן דיגיטלי בפרטיות. |
request | הגדרה שקובעת את משך הזמן המקסימלי ש-GPT ימתין עד שכל ה-hooks הרשומים של הבקשות יושלמו לפני שימשיך לבקשה להצגת מודעה. |
safe | הגדרות לשליטה בשימוש ב-SafeFrame ב-GPT. |
single | הגדרה להפעלה או להשבתה של ארכיטקטורת בקשה בודדת (SRA). |
targeting | הגדרה ששולטת בטירגוט לפי צמד מפתח/ערך. |
thread | הגדרה שקובעת אם GPT צריך להניב את ה-JS thread כשמבקשים ומעבדים קריאייטיבים. |
video | הגדרות לשליטה במודעות וידאו. |
מאפיינים
Optional adExpansion
adExpansion?: AdExpansionConfigOptional adsenseAttributes
adsenseAttributes?: AdSenseAttributesConfigמאפיינים של AdSense שנקבעו באמצעות ההגדרה הזו יחולו על כל מיקומי המודעות בדף. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה ערכי מאפיינים, או כדי להחליף ערכים קיימים.
השינויים במאפייני AdSense חלים רק על מודעות שהבקשה להצגת מודעה להן נשלחה אחרי שהשיטה הזו הופעלה. לכן, מומלץ להפעיל את ה-method הזו לפני כל הפעלה של googletag.display או PubAdsService.refresh.
- דוגמה
JavaScript
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
JavaScript (דור קודם)
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
TypeScript
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
Optional adYield
adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"Optional autoRefresh
autoRefresh?: AutoRefreshConfig- דוגמה
JavaScript
// Set the auto refresh configuration. googletag.setConfig({ autoRefresh: { heavyAds: false } }); // Clear the auto refresh configuration. googletag.setConfig({ autoRefresh: null });
JavaScript (דור קודם)
// Set the auto refresh configuration. googletag.setConfig({ autoRefresh: { heavyAds: false } }); // Clear the auto refresh configuration. googletag.setConfig({ autoRefresh: null });
TypeScript
// Set the auto refresh configuration. googletag.setConfig({ autoRefresh: { heavyAds: false } }); // Clear the auto refresh configuration. googletag.setConfig({ autoRefresh: null });
Optional categoryExclusion
categoryExclusion?: string[]- דוגמה
JavaScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
JavaScript (דור קודם)
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
TypeScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
Optional מרכוז
centering?: booleanהשינויים במרכוז האופקי חלים רק על בקשות להצגת מודעה שהתבקשו אחרי שהשיטה הזו הופעלה. לכן, מומלץ להפעיל את ה-method הזו לפני כל הפעלה של googletag.display או PubAdsService.refresh.
- דוגמה
JavaScript
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
JavaScript (דור קודם)
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
TypeScript
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
Optional collapseDiv
collapseDiv?: CollapseDivBehaviorמיקום מודעה מכווץ לא תופס מקום בדף.
ערכים נתמכים:
null(ברירת המחדל): מיקום המודעה לא יכווץ.-
DISABLED: מיקום המודעה לא יכווץ, גם אם לא תוצג בו מודעה. BEFORE_FETCH: מיקום המודעה יתחיל במצב מכווץ ויתרחב כשתתקבל מודעה.ON_NO_FILL: מיקום המודעה יתחיל במצב מורחב, ויתכווץ אם לא תוצג בו מודעה.
- דוגמה
JavaScript
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
JavaScript (דור קודם)
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
TypeScript
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
Optional disableInitialLoad
disableInitialLoad?: booleanכברירת מחדל, השיטה googletag.display גם רושמת מיקומי מודעות בדף וגם שולחת בקשות להצגת מודעות במיקומים האלה. עם זאת, לפעמים עדיף להפריד בין הפעולות האלה כדי לשלוט בצורה מדויקת יותר במועד הטעינה של תוכן המודעה.
אם מפעילים את ההגדרה הזו, לא יישלחו בקשות להצגת מודעות במיקומי מודעות רשומים כשמתבצעת קריאה ל-method
display(). במקום זאת, צריך לבצע קריאה נפרדת ל-PubAdsService.refresh כדי לשלוח בקשה להצגת מודעה.חובה להפעיל את השיטה הזו לפני שמפעילים את googletag.enableServices.
- דוגמה
JavaScript
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
JavaScript (דור קודם)
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
TypeScript
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
Optional lazyLoad
lazyLoad?: LazyLoadConfigטעינה מדורגת היא שיטה לעיכוב הבקשה להצגת מודעות והעיבוד שלהן עד שהן מתקרבות לאזור התצוגה של המשתמש. דוגמה מפורטת יותר זמינה בדוגמה של טעינה מדורגת.
הערה: אם
singleRequest מופעל, האחזור המדורג פועל רק כשכל המיקומים נמצאים מחוץ לשולי האחזור.כל הגדרות הטעינה המדורגת שלא צוינו בקריאה ל-
setConfig() ישתמשו בערך ברירת המחדל שהוגדר על ידי Google. יכול להיות שברירות המחדל האלה ישתנו עם הזמן. כדי להשבית הגדרה מסוימת, מגדירים את הערך null.- דוגמה
JavaScript
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
JavaScript (דור קודם)
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
TypeScript
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
Optional מיקום
location?: string- דוגמה
JavaScript
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
JavaScript (דור קודם)
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
TypeScript
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
Optional נקודות אחוז
הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS).
Optional privacyTreatments
privacyTreatments?: PrivacyTreatmentsConfigOptional Experimental requestHookTimeoutMs
requestHookTimeoutMs?: number | "auto"כל ה-hooks הרשומים של הבקשות מופעלים במקביל. הזמן הקצוב לתפוגה מגדיר את הגבול העליון של משך הזמן שבו תהליך הבקשה להצגת מודעה יושהה בזמן ההמתנה להשלמת ההרצות המקבילות האלה.
ערכים נתמכים:
- מספר חיובי באלפיות השנייה: תקופת ההמתנה בהתאמה אישית.
-
'auto': ב-GPT נעשה שימוש בזמן קצוב לתפוגה שעבר אופטימיזציה על ידי Google. null: השבתת הזמן הקצוב לתפוגה (GPT ממתין ללא הגבלת זמן עד להשלמת ה-hooks).
- דוגמה
JavaScript
// Set a 1000ms timeout for request hooks. googletag.setConfig({ requestHookTimeoutMs: 1000 }); // Use a Google-optimized timeout for request hooks. googletag.setConfig({ requestHookTimeoutMs: "auto" }); // Clear the timeout. googletag.setConfig({ requestHookTimeoutMs: null });
JavaScript (דור קודם)
// Set a 1000ms timeout for request hooks. googletag.setConfig({ requestHookTimeoutMs: 1000 }); // Use a Google-optimized timeout for request hooks. googletag.setConfig({ requestHookTimeoutMs: "auto" }); // Clear the timeout. googletag.setConfig({ requestHookTimeoutMs: null });
TypeScript
// Set a 1000ms timeout for request hooks. googletag.setConfig({ requestHookTimeoutMs: 1000 }); // Use a Google-optimized timeout for request hooks. googletag.setConfig({ requestHookTimeoutMs: "auto" }); // Clear the timeout. googletag.setConfig({ requestHookTimeoutMs: null });
Optional safeFrame
safeFrame?: SafeFrameConfigהערכים שמוגדרים באמצעות ההגדרה הזו יחולו על כל מיקומי המודעות בדף. מיקומי מודעות בדף ספציפיים יכולים לשנות את הערכים האלה באמצעות SlotSettingsConfig.safeFrame.
- דוגמה
JavaScript
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
JavaScript (דור קודם)
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
TypeScript
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
Optional singleRequest
singleRequest?: booleanכשה-SRA מופעלת, כל מיקומי המודעות בדף שהוגדרו לפני קריאה ל-googletag.display או ל-PubAdsService.refresh יקובצו לבקשה אחת להצגת מודעה. השיטה הזו משפרת את הביצועים, וגם נדרשת כדי להבטיח שהמערכת תכבד את ההגדרות של מודעת roadblock והחרגות תחרותיות.
כאשר SRA מושבת, המערכת שולחת בקשה נפרדת לכל מיקום מודעה בדף. זוהי פעולת ברירת המחדל של GPT.
חובה להפעיל את השיטה הזו לפני שמפעילים את googletag.enableServices.
- דוגמה
JavaScript
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
JavaScript (דור קודם)
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
TypeScript
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
Optional טירגוט
targeting?: Record<string, string | string[]>הטירגוט שמוגדר באמצעות ההגדרה הזו יחול על כל מיקומי המודעות בדף. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה צמדי מפתח/ערך לטירגוט, או כדי להחליף ערכים קיימים. מפתחות טירגוט מוגדרים בחשבון Google Ad Manager.
- דוגמה
JavaScript
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
JavaScript (דור קודם)
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
TypeScript
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
- ראה גם
Optional threadYield
threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"GPT יניב רק לדפדפנים שתומכים ב-Scheduler.postTask או ב-Scheduler.yield API.
ערכים נתמכים:
-
null(ברירת המחדל): GPT יניב את ה-JS thread למיקומי מודעות מחוץ לאזור התצוגה. ENABLED_ALL_SLOTS: מערכת GPT תניב את ה-thread של JS לכל מיקומי המודעות, גם אם מיקום המודעה לא נמצא באזור התצוגה.DISABLED: GPT לא יניב את ה-thread של JS.
- דוגמה
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript (דור קודם)
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- ראה גם
Optional videoAds
videoAds?: VideoAdsConfig- דוגמה
JavaScript
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
JavaScript (דור קודם)
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
TypeScript
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
- ראה גם
googletag.config.PrivacyTreatmentsConfig
הגדרות לשליטה בטיפול של בעלי תוכן דיגיטלי בפרטיות.
| מאפיינים | |
|---|---|
treatments | מערך של אמצעים לשמירה על פרטיות שבעלי האתרים יכולים להפעיל. |
מאפיינים
טיפולים
treatments: "disablePersonalization"[]- דוגמה
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (דור קודם)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvidedSignalsConfig
אובייקט ההגדרה של אותות שמספקים בעלי תוכן דיגיטלי (PPS).
| מאפיינים | |
|---|---|
taxonomies | אובייקט שמכיל מיפויים של Taxonomy או null כדי לנקות את ההגדרות האישיות. |
- דוגמה
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (דור קודם)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
מאפיינים
טקסונומיות
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>googletag.config.SafeFrameConfig
הגדרות לשליטה ב-SafeFrame ב-GPT.
| מאפיינים | |
|---|---|
allow | אם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי שכבת-על של תוכן הדף. |
allow | האם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי דחיפת תוכן הדף. |
force | האם לאלץ עיבוד של מודעות באמצעות מאגר SafeFrame. |
sandbox | אם SafeFrame צריך להשתמש במאפיין ארגז החול של HTML5 כדי למנוע ניווט ברמה העליונה ללא אינטראקציה של המשתמש. |
use | הוצא משימוש. אם SafeFrame צריך להשתמש בתת-דומיינים אקראיים לנכסי קריאייטיב במכירה ישירה לא פרוגרמטית. |
מאפיינים
Optional allowOverlayExpansion
allowOverlayExpansion?: booleanOptional allowPushExpansion
allowPushExpansion?: booleanOptional forceSafeFrame
forceSafeFrame?: booleanOptional ארגז חול
sandbox?: booleantrue (אי אפשר לאלץ את הערך false). חשוב לזכור שמאפיין ארגז החול משבית פלאגינים (למשל, Flash).Optional useUniqueDomain
useUniqueDomain?: booleannull.הערה: התכונה הזו מופעלת כברירת מחדל.
googletag.config.SlotSettingsConfig
ממשק ההגדרות הראשי להגדרות ברמת מיקום המודעה.
מאפשר להגדיר כמה תכונות באמצעות קריאה ל-API אחת למיקום מודעה אחד.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות שבסוג SlotSettingsConfig בהמשך.
דוגמאות:
מאפשר להגדיר כמה תכונות באמצעות קריאה ל-API אחת למיקום מודעה אחד.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות שבסוג SlotSettingsConfig בהמשך.
דוגמאות:
- רק התכונות שצוינו בקריאה Slot.setConfig ישתנו.
const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה מסוימת מתעדכנות בכל קריאה ל-Slot.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- כדי למחוק את כל ההגדרות של תכונה מסוימת, צריך להעביר את הערך
null.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
| מאפיינים | |
|---|---|
ad | הגדרות לקביעת מיקום מודעה מתרחב. |
adsense | הגדרה לקביעת מאפייני AdSense. |
category | הגדרה לקביעת החרגות של קטגוריות מודעות. |
click | הגדרה של כתובת ה-URL שאליה המשתמשים יופנו אחרי שילחצו על המודעה. |
collapse | הגדרה לקביעת אופן הכיווץ של מיקום המודעה בדף. |
continue | הגדרות לקביעת ההתנהגות של כפתור ההמשך במודעות שמופיעות בהשהיה של תוכן. |
interstitial | הגדרות שקובעות את ההתנהגות של מיקום מודעת המעברון בדף. |
safe | הגדרות לשימוש ב-SafeFrame ב-GPT. |
targeting | הגדרה לקביעת טירגוט לפי מפתח/ערך. |
מאפיינים
Optional adExpansion
adExpansion?: AdExpansionConfig- ראה גם
Optional adsenseAttributes
adsenseAttributes?: AdSenseAttributesConfigמאפיינים של AdSense שנקבעו באמצעות ההגדרה הזו יחולו רק על מיקום המודעה בדף. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה ערכי מאפיינים, או כדי להחליף ערכים קיימים.
השינויים במאפייני AdSense חלים רק על מודעות שהבקשה להצגת מודעה להן נשלחה אחרי שהשיטה הזו הופעלה. לכן, מומלץ להפעיל את ה-method הזו לפני כל הפעלה של googletag.display או PubAdsService.refresh.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
Optional categoryExclusion
categoryExclusion?: string[]- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
Optional clickUrl
clickUrl?: stringהשרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת אתר לקליקים מוחלפת. כל כתובת דף נחיתה שמשויכת לקריאייטיב שמוצג מצורפת לערך שצוין. אם מגדירים את הערך הזה יותר מפעם אחת, הערך החדש מחליף את הערך הקודם.
null ינקה את הערך.הערה: ההגדרה הזו חלה רק על בקשות שאינן SRA.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
Optional collapseDiv
collapseDiv?: CollapseDivBehaviorמיקום מודעה מכווץ לא תופס מקום בדף.
ערכים נתמכים:
-
null(ברירת מחדל): מיקום המודעה לא יכווץ. -
DISABLED: מיקום המודעה לא יכווץ, גם אם לא תוצג בו מודעה. BEFORE_FETCH: מיקום המודעה יתחיל במצב מכווץ ויתרחב כשתתקבל מודעה.ON_NO_FILL: מיקום המודעה יתחיל במצב מורחב, ויתכווץ אם לא תוצג בו מודעה.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
Optional continueButton
continueButton?: ContinueButtonConfigההגדרות האלה מאפשרות להתאים אישית את המראה וההתנהגות של האינטראקציות של היציאה והמשך הקריאה שמשויכות לפורמטים של מודעות שמופיעות בהשהיה של תוכן.
כל הגדרה של לחצן ההמשך שלא צוינה בקריאה ל-
setConfig() תשתמש בערך ברירת מחדל שנקבע על ידי Google.כדי להשבית או לנקות את כל ההגדרות של לחצן ההמשך, צריך להעביר את
null.- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Configure continue button settings. slot.setConfig({ continueButton: { font: "Arial", fontColor: "white", backgroundColor: "blue", targetId: "target-div-id", freqCapIntervalMinutes: 20, }, }); // Clear continue button settings. slot.setConfig({ continueButton: null });
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Configure continue button settings. slot.setConfig({ continueButton: { font: "Arial", fontColor: "white", backgroundColor: "blue", targetId: "target-div-id", freqCapIntervalMinutes: 20, }, }); // Clear continue button settings. slot.setConfig({ continueButton: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Configure continue button settings. slot.setConfig({ continueButton: { font: "Arial", fontColor: "white", backgroundColor: "blue", targetId: "target-div-id", freqCapIntervalMinutes: 20, }, }); // Clear continue button settings. slot.setConfig({ continueButton: null });
Optional מודעת מעברון
interstitial?: InterstitialConfigOptional safeFrame
safeFrame?: SafeFrameConfigהערכים שמוגדרים באמצעות ההגדרה הזו יחולו רק על מיקום המודעה בדף, ויחליפו את הערכים שמוגדרים באמצעות PageSettingsConfig.safeFrame.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
Optional טירגוט
targeting?: Record<string, string | string[]>הטירגוט שנקבע באמצעות ההגדרה הזו יחול רק על מיקום המודעה בדף. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה צמדי מפתח/ערך לטירגוט, או כדי להחליף ערכים קיימים. מפתחות טירגוט מוגדרים בחשבון Google Ad Manager.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
JavaScript (דור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
- ראה גם
googletag.config.TaxonomyData
אובייקט שמכיל את הערכים של טקסונומיה אחת.
| מאפיינים | |
|---|---|
values | רשימה של ערכי טקסונומיה. |
מאפיינים
ערכים
values: readonly string[]googletag.config.VideoAdsConfig
הגדרות שקשורות למודעות וידאו.
| מאפיינים | |
|---|---|
enable | אם מודעות וידאו יוצגו בדף. |
video | מזהה מקור קטע הווידאו. |
video | מזהה Content ID של קטע וידאו. |
מאפיינים
enableVideoAds
enableVideoAds: booleanכשהערך מוגדר כ-
true, מופעלות מגבלות של החרגת תוכן על מודעות לרשת המדיה ומודעות וידאו.אם קטע הווידאו ידוע, צריך להגדיר את videoContentId ואת videoCmsId לערכים שסופקו לשירות ניתוח התוכן של Google Ad Manager כדי להשתמש בהחרגת תוכן במודעות לרשת המדיה.
Optional videoCmsId
videoCmsId?: stringזהו ערך ייחודי שמוקצה על ידי שירות ניתוח התוכן של Google Ad Manager כדי לזהות את מקור קטע הווידאו שצוין על ידי videoContentId.
- ראה גם
Optional videoContentId
videoContentId?: stringזהו ערך ייחודי שמזהה סרטון מסוים ממקור התוכן שצוין על ידי videoCmsId. הערך הזה מוקצה על ידי מערכת ניהול התוכן (CMS) שמארחת את קטע הווידאו שלכם.
- ראה גם
googletag.enums
זהו מרחב השמות שבו GPT משתמש לסוגי enum.
| ערכי ספירה | |
|---|---|
Out | פורמטים של מודעות מחוץ לדף שנתמכים ב-GPT. |
Tag | הגדרות של הגבלות שקשורות לגיל שנתמכות ב-GPT. |
Traffic | מקורות תנועה שנתמכים על ידי GPT. |
ערכי ספירה
OutOfPageFormat
OutOfPageFormat- ראה גם
TagForAgeTreatment
TagForAgeTreatmentTrafficSource
TrafficSource| חברי ספירה | |
|---|---|
ORGANIC | הזנה ישירה של כתובת URL, חיפוש באתר או הורדת אפליקציה. |
PURCHASED | תנועה שהופנתה מנכסים שלא בבעלות בעל התוכן הדיגיטלי (פעילות נרכשת או מתומרצת בדרך אחרת). |
googletag.events
זהו מרחב השמות שבו GPT משתמש לאירועים. הקוד שלכם יכול להגיב לאירועים האלה באמצעות Service.addEventListener.
| ממשקים | |
|---|---|
Event | ממשק בסיסי לכל האירועים של GPT. |
Event | זהו סוג מדומה שממפה שם האירוע לסוג אובייקט האירוע המתאים לו עבור Service.addEventListener ו-Service.removeEventListener. |
Game | האירוע הזה מופעל כשמשתמש סוגר מיקום ידני של מודעת מעברון במשחק. |
Game | האירוע הזה מופעל כשמיקום ידני למודעת מעברון במשחק מוכן להצגה למשתמש. |
Impression | האירוע הזה מופעל כשחשיפה הופכת לניתנת לצפייה, בהתאם לקריטריונים של Active View. |
Rewarded | האירוע הזה מופעל כשמשתמש סוגר מיקום מודעה בדף של מודעה מתגמלת. |
Rewarded | האירוע הזה מופעל כשמוענק תגמול על צפייה במודעה מתגמלת. |
Rewarded | האירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה. |
Rewarded | האירוע הזה מופעל כשמודעת וידאו מתגמלת מסיימת לפעול. |
Slot | האירוע הזה מופעל כש-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. |
Slot | האירוע הזה מופעל כשקוד הקריאייטיב מוזרק למיקום מודעה. |
Slot | האירוע הזה מופעל כשנשלחת בקשה להצגת מודעה במיקום ספציפי. |
Slot | האירוע הזה מופעל כשמתקבלת תגובה למודעה במיקום ספציפי. |
Slot | האירוע הזה מופעל בכל פעם שמשתנה אחוז השטח של מיקום המודעה בדף שמוצג במסך. |
googletag.events.Event
ממשק בסיס לכל האירועים של GPT. כל האירועים של GPT שמופיעים בהמשך יכללו את השדות הבאים.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. |
slot | המשבצת שהפעילה את האירוע. |
מאפיינים
serviceName
serviceName: stringslot
slot: Slotgoogletag.events.EventTypeMap
זהו סוג מדומה שממפה שם האירוע לסוג אובייקט האירוע המתאים לו עבור Service.addEventListener ו-Service.removeEventListener. הוא מתועד למטרות עזר ומניעת שגיאות הקלדה בלבד.
מאפיינים
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEventgameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEventimpressionViewable
impressionViewable: ImpressionViewableEventrewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEventrewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEventrewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEventrewardedSlotVideoCompleted
rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEventslotOnload
slotOnload: SlotOnloadEventslotRenderEnded
slotRenderEnded: SlotRenderEndedEventslotRequested
slotRequested: SlotRequestedEventslotResponseReceived
slotResponseReceived: SlotResponseReceivedslotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEventgoogletag.events.GameManualInterstitialSlotClosedEvent
הרחבה של
Eventהאירוע הזה מופעל כשמשתמש סוגר מיקום ידני של מודעת מעברון במשחק.
הערה: מודעות מעברון ידניות במשחקים הן פורמט בגישה מוגבלת.
הערה: מודעות מעברון ידניות במשחקים הן פורמט בגישה מוגבלת.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
slot | המשבצת שהפעילה את האירוע. עובר בירושה מהנכס |
- דוגמה
JavaScript
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (דור קודם)
// This listener is called when a game manual interstitial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
googletag.events.GameManualInterstitialSlotReadyEvent
הרחבה של
Eventהאירוע הזה מופעל כשמיקום ידני של מודעת מעברון במשחק מוכן להצגה למשתמש.
הערה: מיקום ידני של מודעת מעברון במשחק הוא פורמט בגישה מוגבלת.
הערה: מיקום ידני של מודעת מעברון במשחק הוא פורמט בגישה מוגבלת.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
slot | המשבצת שהפעילה את האירוע. עובר בירושה מהנכס |
| Methods | |
|---|---|
make | הצגת מודעת המעברון הידנית של המשחק למשתמש. |
- דוגמה
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (דור קודם)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
Methods
makeGameManualInterstitialVisible
makeGameManualInterstitialVisible(): booleanהצגת מודעת המעברון הידנית של המשחק למשתמש. הפונקציה מחזירה ערך שמציין אם המודעה הוצגה בהצלחה.
| החזרות | |
|---|---|
boolean | |
googletag.events.ImpressionViewableEvent
הרחבה של
Eventהאירוע הזה מופעל כשחשיפה הופכת לניתנת לצפייה, בהתאם לקריטריונים של Active View.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
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.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
slot | המשבצת שהפעילה את האירוע. עובר בירושה מהנכס |
- דוגמה
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (דור קודם)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
googletag.events.RewardedSlotGrantedEvent
הארכה של
Eventהאירוע הזה מופעל כשמוענק תגמול על צפייה במודעה מתגמלת. אם המודעה נסגרת לפני שהמשתמש עומד בקריטריונים לקבלת התגמול, האירוע הזה לא יופעל.
| מאפיינים | |
|---|---|
payload | אובייקט שמכיל מידע על התגמול שניתן. |
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
slot | המשבצת שהפעילה את האירוע. עובר בירושה מהנכס |
- דוגמה
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (דור קודם)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount, ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
מאפיינים
payload
payload: RewardedPayloadgoogletag.events.RewardedSlotReadyEvent
הרחבה של
Eventהאירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה. בעל האפליקציה אחראי להציג למשתמש אפשרות לצפות במודעה לפני שהיא מוצגת.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
slot | המשבצת שהפעילה את האירוע. עובר בירושה מהנכס |
| Methods | |
|---|---|
make | מציגה את המודעה המתגמלת. |
- דוגמה
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (דור קודם)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
Methods
makeRewardedVisible
makeRewardedVisible(): booleanמציגה את המודעה המתגמלת. צריך להפעיל את השיטה הזו רק אחרי שהמשתמש הסכים לצפות במודעה.
| החזרות | |
|---|---|
boolean | אם המודעה המתגמלת הוצגה בהצלחה. |
googletag.events.RewardedSlotVideoCompletedEvent
הרחבה של
Eventהאירוע הזה מופעל כשמודעת וידאו מתגמלת מסיימת לפעול.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
slot | המשבצת שהפעילה את האירוע. עובר בירושה מהנכס |
- דוגמה
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the video in a rewarded ad slot has // finished playing. googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => { const slot = event.slot; console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (דור קודם)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the video in a rewarded ad slot has // finished playing. googletag.pubads().addEventListener("rewardedSlotVideoCompleted", function (event) { var slot = event.slot; console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the video in a rewarded ad slot has // finished playing. googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => { const slot = event.slot; console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing."); if (slot === targetSlot) { // Slot specific logic. } }); }
googletag.events.SlotOnloadEvent
הרחבה של
Eventהאירוע הזה מופעל כש-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. כשמודעות מדיה עשירה מוצגות במצב עיבוד סינכרוני, לא נעשה שימוש ב-iframe ולכן לא יופעל
SlotOnloadEvent.| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
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.
| מאפיינים | |
|---|---|
advertiser | מזהה המפרסם של המודעה שהוצגה. |
campaign | מזהה הקמפיין של המודעה שמוצגת. |
company | המזהים של החברות שהגישו הצעת מחיר על המודעה למילוי חוסרים שהוצגה. |
creative | מזהה הקריאייטיב של המודעה בהזמנה שעברה רינדור. |
creative | מזהה התבנית של הקריאייטיב של המודעה בהזמנה שעברה רינדור. |
is | אם המודעה הייתה מודעה למילוי חוסרים. |
is | אם הוחזרה מודעה למיקום המודעה. |
label | הוצא משימוש. |
line | מזהה הפריט של המודעה בהזמנה שהוצגה. |
response | מזהה התגובה הוא מזהה ייחודי של התגובה לבקשה להצגת מודעה. |
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
size | מציין את גודל הפיקסלים של הקריאייטיב שעבר רינדור. |
slot | המשבצת שהפעילה את האירוע. עובר בירושה מהנכס |
slot | אם התוכן של מיקום המודעה השתנה עם המודעה שהוצגה. |
source | מזהה הקריאייטיב של המודעה שהוצגה, בין אם היא מודעה בהזמנה או מודעה למילוי מלאי שטחי הפרסום. |
source | מזהה הפריט של המודעה שהוצגה, בין אם היא מודעה שהוזמנה מראש או מודעה למילוי שטחי פרסום שלא נוצלו. |
yield | המזהים של הקבוצות למילוי שטחי פרסום שמהן נשלפה המודעה שהוצגה. |
- דוגמה
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (דור קודם)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
מאפיינים
advertiserId
advertiserId: numbernull למיקומי מודעות ריקים, מודעות למילוי שטחי פרסום שלא נוצלו ונכסי קריאייטיב שעובדו על ידי שירותים אחרים מלבד PubAdsService.campaignId
campaignId: numbernull במיקומי מודעות ריקים, במודעות למילוי שטחי פרסום ובקריאייטיבים שמוצגים על ידי שירותים אחרים מלבד PubAdsService.companyIds
companyIds: number[]null במיקומי מודעות ריקים, במודעות בהזמנה ובנכסי קריאייטיב שמוצגים על ידי שירותים אחרים מלבד PubAdsService.creativeId
creativeId: numbernull למיקומי מודעות ריקים, מודעות למילוי מלאי שטחי פרסום וקריאייטיבים שמוצגים על ידי שירותים אחרים מלבד PubAdsService.creativeTemplateId
creativeTemplateId: numbernull למיקומי מודעות ריקים, מודעות למילוי שטחי פרסום שלא נוצלו ונכסי קריאייטיב שעובדו על ידי שירותים אחרים מלבד PubAdsService.isBackfill
isBackfill: booleantrue אם המודעה הייתה מודעת מילוי, אחרת הערך הוא false.isEmpty
isEmpty: booleantrue אם לא הוחזרה מודעה, אחרת הערך הוא false.labelIds
labelIds: number[]lineItemId
lineItemId: numbernull במיקומי מודעות ריקים, במודעות למילוי שטחי פרסום שלא נוצלו ובקריאייטיבים שנוצרו על ידי שירותים אחרים מלבד PubAdsService.responseIdentifier
responseIdentifier: stringsize
size: string | number[][728, 90] הערך הוא null למיקומי מודעות ריקים בדף.slotContentChanged
slotContentChanged: booleantrue אם התוכן השתנה, אחרת הערך הוא false.sourceAgnosticCreativeId
sourceAgnosticCreativeId: numbernull אם המודעה היא לא מודעה בהזמנה או מילוי חוסרים של פריט, או אם הקריאייטיב מוצג על ידי שירותים אחרים מלבד PubAdsService.sourceAgnosticLineItemId
sourceAgnosticLineItemId: numbernull אם המודעה היא לא מודעה בהזמנה או מילוי חוסרים של פריט, או אם הקריאייטיב מוצג על ידי שירותים אחרים מלבד PubAdsService.yieldGroupIds
yieldGroupIds: number[]null במיקומי מודעות ריקים, במודעות בהזמנה ובנכסי קריאייטיב שמוצגים על ידי שירותים אחרים מלבד PubAdsService.googletag.events.SlotRequestedEvent
הרחבה של
Eventהאירוע הזה מופעל כשנשלחת בקשה להצגת מודעה במיקום ספציפי.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
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האירוע הזה מופעל כשמתקבלת תגובה למודעה במיקום ספציפי.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
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 אלפיות השנייה.
| מאפיינים | |
|---|---|
in | אחוז שטח המודעה שגלוי. |
service | שם השירות שהפעיל את האירוע. עובר בירושה מהנכס |
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: numbergoogletag.secureSignals
זהו מרחב השמות שבו GPT משתמש כדי לנהל אותות מאובטחים.
| ממשקים | |
|---|---|
Bidder | הפונקציה מחזירה אות מאובטח למגיש הצעת מחיר ספציפי. |
Publisher | הפונקציה מחזירה אות מאובטח לבעל אתר ספציפי. |
Secure | ממשק לניהול אותות מאובטחים. |
| כינויי סוגים | |
|---|---|
Secure | ממשק להחזרת אות מאובטח למגיש הצעת מחיר או לספק ספציפי. |
כינויי סוגים
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProviderid או את networkCode, אבל לא את שניהם.googletag.secureSignals.BidderSignalProvider
הפונקציה מחזירה אות מאובטח למגיש הצעות מחיר ספציפי.
ספק של אותות מאובטחים למגישי הצעות מחיר מורכב משני חלקים:
ספק של אותות מאובטחים למגישי הצעות מחיר מורכב משני חלקים:
- פונקציית איסוף שמחזירה
Promiseשמתורגם לאות מאובטח. idשמזהה את מגיש הצעת המחיר שמשויך לאות.
| מאפיינים | |
|---|---|
collector | פונקציה שמחזירה Promise שמתורגם לאות מאובטח. |
id | מזהה ייחודי של אוסף הנתונים שמשויך לאות המאובטח הזה, כפי שהוא רשום ב-Google Ad Manager. |
- דוגמה
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (דור קודם)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
מאפיינים
collectorFunction
collectorFunction: (() => Promise<string>)Promise שמתורגם לאות מאובטח.id
id: stringgoogletag.secureSignals.PublisherSignalProvider
הפונקציה מחזירה אות מאובטח לבעל תוכן דיגיטלי ספציפי.
ספק אותות של בעל תוכן דיגיטלי מורכב משני חלקים:
ספק אותות של בעל תוכן דיגיטלי מורכב משני חלקים:
- פונקציית איסוף שמחזירה
Promiseשמתורגם לאות מאובטח. networkCodeשמזהה את בעל האפליקציה שמשויך לאות.
| מאפיינים | |
|---|---|
collector | פונקציה שמחזירה Promise שמתורגם לאות מאובטח. |
network | קוד הרשת (כפי שמופיע בנתיב של יחידת המודעות) של בעל האפליקציה שמשויך לאות המאובטח הזה. |
- דוגמה
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (דור קודם)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
מאפיינים
collectorFunction
collectorFunction: (() => Promise<string>)Promise שמתורגם לאות מאובטח.networkCode
networkCode: stringgoogletag.secureSignals.SecureSignalProvidersArray
ממשק לניהול אותות מאובטחים.
| Methods | |
|---|---|
clear | מנקה מהמטמון את כל האותות של כל אוספי הנתונים. |
push | מוסיפה secureSignals.SecureSignalProvider חדש למערך ספקי האותות ומתחילה את תהליך יצירת האותות. |
Methods
clearAllCache
clearAllCache(): voidמנקה מהמטמון את כל האותות של כל אוספי הנתונים.
קריאה ל-method הזה עשויה להפחית את הסבירות שהאותות ייכללו בבקשות להצגת מודעות בצפיות בדף הנוכחי, ואולי גם בצפיות בדפים הבאים. לכן, צריך להפעיל אותה רק כשמתרחשים שינויים משמעותיים במצב, כמו אירועים שמציינים משתמש חדש (כניסה, יציאה, הרשמה וכו').
קריאה ל-method הזה עשויה להפחית את הסבירות שהאותות ייכללו בבקשות להצגת מודעות בצפיות בדף הנוכחי, ואולי גם בצפיות בדפים הבאים. לכן, צריך להפעיל אותה רק כשמתרחשים שינויים משמעותיים במצב, כמו אירועים שמציינים משתמש חדש (כניסה, יציאה, הרשמה וכו').
push
push(provider: SecureSignalProvider): voidמוסיפה secureSignals.SecureSignalProvider חדש למערך ספקי האותות ומתחילה את תהליך יצירת האותות.
| פרמטרים | |
|---|---|
provider: SecureSignalProvider | האובייקט secureSignals.SecureSignalProvider שצריך להוסיף למערך. |