קובץ העזר הזה משתמש בסימון TypeScript כדי לתאר סוגים. בטבלה הבאה מוצג הסבר קצר לדוגמה.
ביטוי הקלדה | |
---|---|
string |
סוג המחרוזת הפרמיטיבית. |
string[] |
סוג מערך, שבו הערכים יכולים להיות מחרוזות בלבד. |
number | string |
סוג איחוד, שבו הערך יכול להיות מספר או מחרוזת. |
Array<number | string> |
סוג מערך, שבו הערכים הם מסוג מורכב (איחוד). |
[number, string] |
טיפוס דו-צדדי שבו הערך הוא מערך של שני רכיבים שחייב להכיל מספר ומחרוזת בסדר הזה. |
Slot |
סוג אובייקט, שבו הערך הוא מופע של googletag.Slot . |
() => void |
סוג פונקציה ללא ארגומנטים מוגדרים וללא ערך מוחזר. |
למידע נוסף על הסוגים הנתמכים וביטויי הסוג הנתמכים, עיינו במדריך של TypeScript .
סוג הערות
נקודתיים אחרי משתנה, שם פרמטר, שם מאפיין או חתימת פונקציה מציינים הערה מסוג סוג. הערות סוג מתארות את סוגי הרכיב שמימין לנקודתיים שהרכיב יכול לקבל או להחזיר. הטבלה הבאה מציגה דוגמאות להערות מסוגים שאתם עשויים לראות בחומר העזר הזה.
סוג הערה | |
---|---|
param: string |
השדה param מקבל או מחזיר ערך מחרוזת. התחביר הזה משמש
למשתנים, לפרמטרים, למאפיינים ולסוגי החזרות.
|
param?: number | string |
הפרמטר param הוא אופציונלי, אבל מקבל או מספר או מחרוזת
כשמציינים אותו. התחביר הזה משמש לפרמטרים ולמאפיינים.
|
...params: Array<() => void> |
מציין ש-params הוא
פרמטר מנוחה
שמקבל פונקציות. הפרמטרים של השאר מקבלים מספר לא מוגבל של ערכים
מהסוג שצוין.
|
הגדרות סוג
סוגים | |
---|---|
|
SingleSize | MultiSize
|
הגדרת גודל חוקית ביחידת קיבולת (Slot), שיכולה להיות בגודל אחד או בכמה גדלים. |
|
|
SingleSize[]
|
רשימה של גדלים חוקיים יחידים. |
|
|
"fluid" | ["fluid"]
|
גדלים בעלי שם שיכולים להיות ביחידת קיבולת (Slot). ברוב המקרים, הגודל הוא מלבן בגודל קבוע, אבל יש מקרים שבהם אנחנו זקוקים לסוגים אחרים של מפרטי מידות. רק המידות הבאות הן מידות חוקיות עם שם:
|
|
|
SingleSizeArray | NamedSize
|
גודל חוקי אחד ליחידת קיבולת (Slot). |
|
|
[number, number]
|
מערך של שני מספרים המייצג [רוחב, גובה]. |
|
|
[SingleSizeArray, GeneralSize]
|
מיפוי של גודל אזור התצוגה לגדלים של מודעות. משמש למודעות רספונסיביות. |
|
|
SizeMapping[]
|
רשימה של מיפויי גדלים. |
|
|
"unhideWindow" | "navBar"
|
טריגרים נתמכים של מודעות מעברון. |
|
|
"disablePersonalization"
|
טיפולי פרטיות נתמכים לבעלי תוכן דיגיטלי. |
|
|
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
|
טקסונומיות נתמכות של אותות שמספקים בעלי תוכן דיגיטלי (PPS). |
|
|
BidderSignalProvider | PublisherSignalProvider
|
ממשק להחזרת אות מאובטח למגיש הצעות מחיר או לספק ספציפי. יש לספק אחד מהערכים |
סוגי טיפוסים בני מנייה (enum)
טיפוסים בני מנייה (enums) | |
---|---|
googletag.enums.OutOfPageFormat
|
פורמטים של מחוץ לדף שנתמכים על ידי GPT.
|
googletag.enums.TrafficSource
|
מקורות תנועה שנתמכים על ידי GPT.
|
googletag.enums.OutOfPageFormat
-
פורמטים של מחוץ לדף שנתמכים על ידי GPT.
-
- כדאי לעיין גם בפרטים הבאים
googletag.enums.TrafficSource
-
מקורות תנועה שנתמכים על ידי GPT.
-
- כדאי לעיין גם בפרטים הבאים
-
ערכים ORGANIC
הזנה ישירה של כתובת URL, חיפוש באתר או הורדת אפליקציה.PURCHASED
תנועה שהופנתה מנכסים שאינם בבעלות (פעילות שנרכשה או מתומרצת בדרך אחרת).
googletag
מרחב השמות הגלובלי שבו Google Publisher Tag משתמש עבור ה-API שלו.
סיכום משתנים | |
---|---|
apiReady
|
סימון שמציין שממשק ה-API של GPT נטען ומוכן לקריאה.
|
cmd
|
הפניה לתור הפקודות הגלובלי להפעלה אסינכרונית של קריאות שקשורות ל-GPT.
|
pubadsReady
|
סימון שמציין ש-
PubAdsService מופעל, נטען ופועל באופן מלא.
|
secureSignalProviders
|
הפניה למערך של ספקי האותות המאובטחים.
|
סיכום פונקציות | |
---|---|
companionAds
|
מחזירה הפניה אל
CompanionAdsService .
|
defineOutOfPageSlot
|
בונה מיקום מודעה מחוץ לדף עם הנתיב הנתון של יחידת המודעות.
|
defineSlot
|
יצירת מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות, ומשייכת אותו למזהה של רכיב div בדף שיכיל את המודעה.
|
destroySlots
|
משמיד את יחידות הקיבולת הנתונות ומסיר את כל האובייקטים וההפניות הקשורים של משבצות אלה מ-GPT.
|
disablePublisherConsole
|
ההגדרה משביתה את Google Publisher Console.
|
display
|
מורה לשירותי יחידות הקיבולת (Slot) לעבד את יחידת הקיבולת (Slot).
|
enableServices
|
מפעיל את כל שירותי GPT שהוגדרו למיקומי מודעות בדף.
|
getVersion
|
מחזירה את הגרסה הנוכחית של GPT.
|
openConsole
|
ייפתח שירות Google Publisher Console.
|
pubads
|
מחזירה הפניה אל
PubAdsService .
|
setAdIframeTitle
|
מגדיר את הכותרת לכל מסגרות ה-iframe של מאגרי המודעות שנוצרו על ידי
PubAdsService , מרגע זה ואילך.
|
setConfig
|
מגדיר אפשרויות תצורה כלליות עבור הדף.
|
sizeMapping
|
ייווצר
SizeMappingBuilder חדש.
|
googletag.apiReady
-
apiReady: boolean | undefined
-
סימון שמציין שממשק ה-API של GPT נטען ומוכן לקריאה. הנכס הזה יהיה
undefined
פשוט עד שה-API יהיה מוכן.
לתשומת ליבך, הדרך המומלצת לטיפול באופן אסינכרוני היא להשתמש ב-googletag.cmd לתור קריאות חוזרות (callback) כש-GPT מוכן. אין צורך לבדוק את הקריאות החוזרות (callback) האלה כי הן יבוצעו לאחר הגדרת ה-API. -
- דוגמה
-
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript (מדור קודם)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
TypeScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletag.cmd
-
cmd: Array<(this: typeof globalThis) => void> | CommandArray
-
הפניה לתור הפקודות הגלובליות להפעלה אסינכרונית של קריאות שקשורות ל-GPT.
המשתנהgoogletag.cmd
מופעל למערך JavaScript ריק על ידי התחביר של תג GPT בדף, ו-cmd.push
היא השיטה הרגילהArray.push
שמוסיפה רכיב לסוף המערך. כאשר ה-JavaScript של GPT נטען, הוא בודק את המערך ומפעיל את כל הפונקציות לפי הסדר. לאחר מכן הסקריפט מחליף אתcmd
באובייקטCommandArray
ששיטת הדחיפה שלו מוגדרת כדי להפעיל את הארגומנט של הפונקציה שמועבר אליו. המנגנון הזה מאפשר ל-GPT לקצר את זמן האחזור על ידי אחזור ה-JavaScript באופן אסינכרוני, ובמקביל לאפשר לדפדפן להמשיך לעבד את הדף. -
- דוגמה
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (מדור קודם)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
googletag.pubadsReady
-
pubadsReady: boolean | undefined
-
סימון שמציין ש-
PubAdsService
מופעל, נטען ופועל באופן מלא. המאפיין הזה יהיהundefined
פשוט עד שתתבצע קריאה ל-enableServices
ותתבצע טעינה ואתחול שלPubAdsService
. -
googletag.secureSignalProviders
-
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
-
הפניה למערך ספקי האותות המאובטחים.
מערך ספקי האותות המאובטחים מקבל רצף של פונקציות ליצירת אותות ומפעיל אותן לפי הסדר. היא נועדה להחליף מערך סטנדרטי המשמש לקביעת תורים של פונקציות יוצרי אותות להפעלה לאחר טעינת GPT. -
- דוגמה
-
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (מדור קודם)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- כדאי לעיין גם בפרטים הבאים
googletag.companionAds
-
companionAds(): CompanionAdsService
-
מחזירה הפניה אל
CompanionAdsService
. -
-
החזרות CompanionAdsService
שירות המודעות הנלוות.
googletag.defineOutOfPageSlot
-
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
-
יוצר מיקום מודעה מחוץ לדף עם הנתיב הנתון של יחידת המודעות.
במודעות מותאמות אישית מחוץ לדף,div
הוא המזהה של רכיב ה-div שיכיל את המודעה. למידע נוסף, מומלץ לעיין במאמר בנושא קריאייטיבים מחוץ לדף.
למודעות GPT מנוהלות מחוץ לדף,div
הוא OutOfPageFormat נתמכת. -
- דוגמה
-
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (מדור קודם)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים adUnitPath: string
נתיב מלא של יחידת מודעות עם קוד הרשת וקוד יחידת המודעות.div?: string | OutOfPageFormat
המזהה של ה-div שיכיל את יחידת המודעות הזו או OutOfPageFormat. -
החזרות Slot | null
יחידת הקיבולת (Slot) החדשה שנוצרה, אוnull
אם אי אפשר ליצור אותה.
googletag.defineSlot
-
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
-
יצירת מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות, ומשייכת אותו למזהה של רכיב div בדף שיכיל את המודעה.
-
- דוגמה
-
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (מדור קודם)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים adUnitPath: string
נתיב מלא של יחידת מודעות עם קוד הרשת וקוד היחידה.size: GeneralSize
הרוחב והגובה של החריץ שנוסף. זהו הגודל שבו נעשה שימוש בבקשה להצגת מודעה אם לא סופק מיפוי של גודל רספונסיבי, או אם אזור התצוגה קטן מהגודל הקטן ביותר שצוין במיפוי.div?: string
המזהה של ה-div שיכיל את יחידת המודעות הזו. -
החזרות Slot | null
יחידת הקיבולת (Slot) החדשה שנוצרה, אוnull
אם אי אפשר ליצור אותה.
googletag.destroySlots
-
destroySlots(slots?: Slot[]): boolean
-
משמיד את יחידות הקיבולת הנתונות ומסיר את כל האובייקטים וההפניות הקשורים של משבצות אלה מ-GPT. ה-API הזה לא תומך במיקומי מודעות passback ובמיקומי מודעות נלווים.
קריאה ל-API הזה במיקום מודעה מנקה את המודעה ומסירה את אובייקט המיקום מהמצב הפנימי שמתוחזק על ידי GPT. קריאה לפונקציות נוספות באובייקט המשבצת תגרום להתנהגות לא מוגדרת. שים לב: ייתכן שהדפדפן לא ישחרר את הזיכרון המשויך לחריץ הזה אם ההפניה אליו מנוהלת בדף המוציא לאור. קריאה ל-API הזה מאפשרת להשתמש שוב ב-div שמשויך למשבצת הזמן הזו.
במיוחד, השמדה של מיקום מודעה מסירה את המודעה מצפייה בדף במשך חיים של GPT, כך שבקשות עתידיות לא יושפעו ממחסומי דרכים או מהחרגות תחרותיות שקשורות למודעה הזו. אם לא תתבצע קריאה לפונקציה הזו לפני הסרת ה-div של מיקום מודעה מהדף, התוצאה תהיה התנהגות לא מוגדרת. -
- דוגמה
-
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (מדור קודם)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
-
פרמטרים slots?: Slot[]
מערך המשבצות שצריך להשמיד. המערך הוא אופציונלי. כל יחידות הקיבולת יושמדו אם לא תצוין. -
החזרות boolean
true
אם יחידות הקיבולת הושמדו, אחרתfalse
.
googletag.disablePublisherConsole
-
disablePublisherConsole(): void
-
ההגדרה משביתה את Google Publisher Console.
-
- כדאי לעיין גם בפרטים הבאים
googletag.display
-
display(divOrSlot: string | Element | Slot): void
-
מורה לשירותי יחידות הקיבולת (Slot) לעבד את יחידת הקיבולת (Slot). יש להציג כל מיקום מודעה פעם אחת בלבד בכל דף. כל המשבצות צריכות להיות מוגדרות ושירות שמשויך אליהן לפני שהן מוצגות. הקריאה לתצוגה לא יכולה להתרחש עד שהאלמנט נמצא ב-DOM. הדרך הרגילה להשיג את השלב הזה היא להציב אותו בתוך בלוק סקריפט בתוך אלמנט div שצוין בקריאת ה-method.
אם נעשה שימוש בארכיטקטורת בקשה יחידה (SRA), כל מיקומי המודעות שלא נשלפו בזמן הקריאה לשיטה הזו יאוחזרו בבת אחת. כדי לאלץ משבצת מודעה לא להופיע, יש להסיר את ה-div כולו. -
- דוגמה
-
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript (מדור קודם)
googletag.cmd.push(function () { googletag.display("div-1"); });
TypeScript
googletag.cmd.push(() => { googletag.display("div-1"); });
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים divOrSlot: string | Element | Slot
המזהה של רכיב ה-div שמכיל את מיקום המודעה בדף, הרכיב div או את האובייקט של מיקום המודעה. אם צוין רכיב div, חובה שיהיה לו מאפיין 'id' שתואם למזהה שמועבר אלdefineSlot
.
googletag.enableServices
-
enableServices(): void
-
מפעיל את כל שירותי GPT שהוגדרו למיקומי מודעות בדף.
-
googletag.getVersion
-
getVersion(): string
-
מחזירה את הגרסה הנוכחית של GPT.
-
- כדאי לעיין גם בפרטים הבאים
-
החזרות string
מחרוזת הגרסה של GPT שפעילה כרגע.
googletag.openConsole
-
openConsole(div?: string): void
-
ייפתח שירות Google Publisher Console.
-
- דוגמה
-
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (מדור קודם)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים div?: string
מזהה div של מיקום מודעה. הערך הזה הוא אופציונלי. אם תספקו את הפרטים האלה, ה-Publisher Console ינסה לפתוח את החלונית עם פרטים על מיקום המודעה שצוין.
googletag.pubads
-
pubads(): PubAdsService
-
מחזירה הפניה אל
PubAdsService
. -
-
החזרות PubAdsService
השירות 'מודעות לבעלי תוכן דיגיטלי'.
googletag.setAdIframeTitle
-
setAdIframeTitle(title: string): void
-
מגדיר את הכותרת לכל מסגרות ה-iframe של מאגרי המודעות שנוצרו על ידי
PubAdsService
, מרגע זה ואילך. -
- דוגמה
-
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (מדור קודם)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
-
פרמטרים title: string
הכותרת החדשה של כל מסגרות ה-iframe של מאגרי המודעות.
googletag.setConfig
-
setConfig(config: PageSettingsConfig): void
-
מגדיר אפשרויות תצורה כלליות עבור הדף.
-
-
פרמטרים config: PageSettingsConfig
googletag.sizeMapping
-
sizeMapping(): SizeMappingBuilder
-
ייווצר
SizeMappingBuilder
חדש. -
- כדאי לעיין גם בפרטים הבאים
-
החזרות SizeMappingBuilder
Builder חדש.
googletag.CommandArray
מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר. היא נועדה להחליף מערך סטנדרטי המשמש לקביעת תורים להפעלה של פונקציות לאחר טעינת GPT.
סיכום שיטה | |
---|---|
push
|
מפעילה את רצף הפונקציות שצוין בארגומנטים לפי הסדר.
|
push
-
push(...f: Array<(this: typeof globalThis) => void>): number
-
מפעילה את רצף הפונקציות שצוין בארגומנטים לפי הסדר.
-
- דוגמה
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (מדור קודם)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
-
פרמטרים ...f: Array<(this: typeof globalThis) => void>
פונקציית JavaScript להפעלה. הקישור בזמן הריצה יהיה תמידglobalThis
. כדאי להעביר פונקציית חץ כדי לשמור על הערךthis
של ההקשר המילוני המצורף. -
החזרות number
מספר הפקודות שעובדו עד כה. הערך הזה תואם לערך המוחזר שלArray.push
(האורך הנוכחי של המערך).
googletag.CompanionAdsService
הרחבה
שירות מודעות נלוות. השירות הזה משמש מודעות וידאו להצגת מודעות נלוות.
סיכום שיטה | |
---|---|
addEventListener
|
הרישום של ה-listener מאפשר להגדיר ולהפעיל פונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף.
הועברה בירושה מ-
|
getSlots
|
קבל את רשימת המשבצות המשויכות לשירות הזה.
הועברה בירושה מ-
|
removeEventListener
|
הסרה של האזנה שנרשם בעבר.
הועברה בירושה מ-
|
setRefreshUnfilledSlots
|
המדיניות מגדירה אם מיקומי מודעות נלוות שלא מולאו ימולאו אוטומטית.
|
- כדאי לעיין גם בפרטים הבאים
setRefreshUnfilledSlots
-
setRefreshUnfilledSlots(value: boolean): void
-
המדיניות קובעת אם מיקומי מודעות נלווים שלא מולאו ימולאו באופן אוטומטי.
אפשר לקרוא לשיטה הזו כמה פעמים במהלך משך החיים של הדף, כדי להפעיל או להשבית את המילוי החוזר. רק מיקומים שנרשמו גם ב-PubAdsService
ימולאו. עקב הגבלות מדיניות, השיטה הזו לא מיועדת למלא מיקומי מודעות נלווים ריקים בעת הצגת סרטון של Ad Exchange. -
- דוגמה
-
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (מדור קודם)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
-
פרמטרים value: boolean
true
כדי למלא באופן אוטומטי משבצות שלא מולאו,false
כדי להשאיר אותן ללא שינוי.
googletag.PrivacySettingsConfig
אובייקט להגדרת פרטיות.
סיכום נכס | |
---|---|
childDirectedTreatment
|
מציין אם יש לטפל בדף כתוכן לילדים.
|
limitedAds
|
מאפשרת להציג את המודעות במצב מודעות מוגבלות (LTD) כדי לעמוד בצורכי התאימות של בעלי התוכן הדיגיטלי.
|
nonPersonalizedAds
|
מאפשרת להציג את המודעות במצב מודעות ללא התאמה אישית כדי לעמוד בצורכי התאימות של בעלי התוכן הדיגיטלי.
|
restrictDataProcessing
|
מאפשר את הצגת המודעות במצב 'עיבוד מוגבל' כדי לסייע בצורכי תאימות לתקנות של בעלי תוכן דיגיטלי.
|
trafficSource
|
מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית.
|
underAgeOfConsent
|
השדה הזה מציין אם לסמן בקשות להצגת מודעות כמודעות שמגיעות ממשתמשים מתחת לגיל ההסכמה.
|
- כדאי לעיין גם בפרטים הבאים
childDirectedTreatment
-
childDirectedTreatment: null | boolean
-
מציין אם יש לטפל בדף כתוכן לילדים. יש להגדיר את הערך כ-
null
כדי לנקות את ההגדרות האישיות. -
limitedAds
-
limitedAds: boolean
-
מאפשרת להציג את המודעות במצב מודעות מוגבלות (LTD) כדי לעמוד בצורכי התאימות של בעלי התוכן הדיגיטלי. כשהאפשרות הזו מופעלת, ניתן לבקש את ספריית GPT עצמה מכתובת URL של מודעות מוגבלות (LTD) ללא קובצי cookie.
-
- כדאי לעיין גם בפרטים הבאים
nonPersonalizedAds
-
nonPersonalizedAds: boolean
-
מאפשרת להציג את המודעות במצב מודעות ללא התאמה אישית כדי לעמוד בצורכי התאימות של בעלי התוכן הדיגיטלי.
-
restrictDataProcessing
-
restrictDataProcessing: boolean
-
מאפשר את הצגת המודעות במצב 'עיבוד מוגבל' כדי לסייע בצורכי תאימות לתקנות של בעלי תוכן דיגיטלי.
-
trafficSource
-
trafficSource: TrafficSource
-
מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית. הערך הזה מאכלס את המאפיין מקור תנועה בדוחות של Ad Manager. אם היא לא מוגדרת, מקור התנועה מוגדר כברירת מחדל בתור
undefined
בדוחות. -
- דוגמה
-
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (מדור קודם)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
underAgeOfConsent
-
underAgeOfConsent: null | boolean
-
השדה הזה מציין אם לסמן בקשות להצגת מודעות כמודעות שמגיעות ממשתמשים מתחת לגיל ההסכמה. יש להגדיר את הערך כ-
null
כדי לנקות את ההגדרות האישיות. -
googletag.PubAdsService
הרחבה
שירות 'מודעות לבעלי תוכן דיגיטלי'. השירות הזה משמש לאחזור ולהצגה של מודעות מחשבון Google Ad Manager שלך.
סיכום שיטה | |
---|---|
addEventListener
|
הרישום של ה-listener מאפשר להגדיר ולהפעיל פונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף.
הועברה בירושה מ-
|
clear
|
הסרה של המודעות מהמשבצות האלה והחלפה שלהן בתוכן ריק.
|
clearCategoryExclusions
|
ניקוי כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף.
|
clearTargeting
|
ניקוי פרמטרים מותאמים אישית של טירגוט למפתח ספציפי או לכל המפתחות.
|
collapseEmptyDivs
|
מאפשרת כיווץ של divs של מיקומי מודעות, כך שהם לא יתפסו מקום בדף כשאין תוכן מודעה להצגה.
|
disableInitialLoad
|
משביתה בקשות להצגת מודעות בזמן טעינת הדף, אבל מאפשרת לבקש מודעות באמצעות קריאה ל-
PubAdsService.refresh .
|
display
|
יצירה והצגה של מיקום מודעה בדף עם הגודל והנתיב של יחידת המודעות.
|
enableLazyLoad
|
מפעיל טעינה מושהית ב-GPT כפי שמוגדר באובייקט config.
|
enableSingleRequest
|
מפעיל מצב בקשה יחידה לאחזור מודעות מרובות בו-זמנית.
|
enableVideoAds
|
אותות ל-GPT על כך שמודעות וידאו יופיעו בדף.
|
get
|
מחזירה את הערך של מאפיין AdSense המשויך למפתח הנתון.
|
getAttributeKeys
|
מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
|
getSlots
|
קבל את רשימת המשבצות המשויכות לשירות הזה.
הועברה בירושה מ-
|
getTargeting
|
הפונקציה מחזירה פרמטר ספציפי של טירגוט ברמת השירות שהוגדר.
|
getTargetingKeys
|
מחזירה את הרשימה של כל מפתחות הטירגוט המותאמים אישית ברמת השירות שהוגדרו.
|
isInitialLoadDisabled
|
הפונקציה מראה אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-
PubAdsService.disableInitialLoad .
|
refresh
|
אחזור ומציג מודעות חדשות למיקומים ספציפיים או לכל המיקומים בדף.
|
removeEventListener
|
הסרה של האזנה שנרשם בעבר.
הועברה בירושה מ-
|
set
|
מגדיר ערכים למאפייני AdSense שחלים על כל מיקומי המודעות בשירות 'מודעות לבעלי תוכן דיגיטלי'.
|
setCategoryExclusion
|
מגדירה החרגה של קטגוריית מודעות ברמת הדף עבור שם התווית הנתון.
|
setCentering
|
מפעילה ומשביתה מרכוז אופקי של מודעות.
|
setForceSafeFrame
|
המדיניות הזו קובעת אם יש לאלץ עיבוד של כל המודעות בדף באמצעות מאגר SafeFrame.
|
setLocation
|
מעביר פרטי מיקום מאתרים כדי שתוכלו לבצע טירגוט גיאוגרפי של פריטים למיקומים ספציפיים.
|
setPrivacySettings
|
מאפשר לקבוע את כל הגדרות הפרטיות מ-API יחיד באמצעות אובייקט config.
|
setPublisherProvidedId
|
קביעת הערך של המזהה שסופק על ידי בעל האפליקציה.
|
setSafeFrameConfig
|
מגדיר את ההעדפות ברמת הדף לתצורת SafeFrame.
|
setTargeting
|
מגדיר פרמטרים מותאמים אישית של טירגוט למפתח נתון, שיחול על כל מיקומי המודעות של שירות המודעות של בעלי תוכן דיגיטלי.
|
setVideoContent
|
מגדיר את המידע של תוכן הווידאו שיישלח יחד עם הבקשות להצגת מודעות למטרות טירגוט והחרגת תוכן.
|
updateCorrelator
|
שינוי המתאם שנשלח עם בקשות להצגת מודעה, ומתחיל בפועל צפייה חדשה בדף.
|
clear
-
clear(slots?: Slot[]): boolean
-
הסרה של המודעות מהמשבצות האלה והחלפה שלהן בתוכן ריק. המיקומים יסומנו ככאלה שלא נשלפו.
באופן ספציפי, ניקוי מיקום מודעה מסיר את המודעה מצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו ממחסומי דרכים או מהחרגות תחרותיות שקשורות למודעה הזו. -
- דוגמה
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (מדור קודם)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
-
פרמטרים slots?: Slot[]
מערך המשבצות שיש לנקות. המערך הוא אופציונלי. אם לא צוין מערך, כל יחידות הקיבולת יוסרו. -
החזרות boolean
הפונקציה מחזירה את הערךtrue
אם המיקומים נוקו. אחרת,false
.
clearCategoryExclusions
-
clearCategoryExclusions(): PubAdsService
-
ניקוי כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. האפשרות הזו שימושית אם רוצים לרענן את המשבצת.
-
- דוגמה
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (מדור קודם)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- כדאי לעיין גם בפרטים הבאים
-
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
clearTargeting
-
clearTargeting(key?: string): PubAdsService
-
ניקוי פרמטרים מותאמים אישית של טירגוט למפתח ספציפי או לכל המפתחות.
-
- דוגמה
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (מדור קודם)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key?: string
מפתח פרמטר של טירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל הפרמטרים של הטירגוט יימחקו. -
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
collapseEmptyDivs
-
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
-
מאפשרת כיווץ של divs של מיקומי מודעות, כך שהם לא יתפסו מקום בדף כשאין תוכן מודעה להצגה. חובה להגדיר את המצב הזה כדי שהשירות יופעל.
-
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים collapseBeforeAdFetch?: boolean
האם לכווץ את המיקומים עוד לפני אחזור המודעות. הפרמטר הזה הוא אופציונלי. אם לא תספקו אותו, ערך ברירת המחדל ישמש אתfalse
. -
החזרות boolean
הפונקציה מחזירה את הערךtrue
אם מצב הכיווץ div הופעל ואת הערךfalse
אם לא ניתן להפעיל את מצב הכיווץ כי השיטה נקראה אחרי שהשירות הופעל.
disableInitialLoad
-
disableInitialLoad(): void
-
משביתה בקשות להצגת מודעות בזמן טעינת הדף, אבל מאפשרת לבקש מודעות באמצעות קריאה ל-
PubAdsService.refresh
. יש להגדיר זאת לפני הפעלת השירות. יש להשתמש במצב אסינכרוני. אחרת, לא ניתן יהיה לבקש מודעות באמצעותrefresh
. -
- כדאי לעיין גם בפרטים הבאים
display
-
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
-
יצירה והצגה של מיקום מודעה בדף עם הגודל והנתיב של יחידת המודעות. השיטה הזו לא פועלת במצב בקשה בודדת.
הערה: כשהשיטה הזו מופעלת, המערכת יוצרת תמונת מצב של מיקום הדף ומצב הדף כדי להבטיח עקביות בשליחת הבקשה להצגת מודעה ובעיבוד התגובה. כל שינוי שיבוצעו במצב המיקום או בדף אחרי הקריאה לשיטה הזו (כולל טירגוט, הגדרות פרטיות, אילוץ פריים בטוח וכו') יחולו רק על בקשותdisplay()
אוrefresh()
הבאות. -
- דוגמה
-
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (מדור קודם)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים adUnitPath: string
הנתיב של יחידת המודעות של המיקום שמיועד לעיבוד.size: GeneralSize
הרוחב והגובה של החריץ.div?: string | Element
המזהה של ה-div שמכיל את יחידת הקיבולת (Slot) או רכיב ה-div עצמו.clickUrl?: string
כתובת ה-URL לקליקים לשימוש במשבצת הזו.
enableLazyLoad
-
enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void
-
מפעיל טעינה מושהית ב-GPT כפי שמוגדר באובייקט config. דוגמאות מפורטות יותר זמינות בדוגמה של טעינה מושהית.
הערה: אחזור עצל ב-SRA פועל רק אם כל המשבצות נמצאות מחוץ לשולי השליפה. -
- דוגמה
-
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (מדור קודם)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
אובייקט התצורה מאפשר התאמה אישית של התנהגות עצלה. אם תושמטו הגדרות, ייעשה שימוש בברירת המחדל שהוגדרה על ידי Google, שתבוצע כוונון עם הזמן. כדי להשבית הגדרה מסוימת, כמו שוליים לאחזור, מגדירים את הערך ל--1
.fetchMarginPercent
המרחק המינימלי מאזור התצוגה הנוכחי למקום מסוים חייב להיות לפני שנאחזר את המודעה כאחוז מגודל אזור התצוגה. הערך 0 פירושו "כשמיקום המודעה נכנס לאזור התצוגה", 100 פירושו "כשהמודעה נמצאת במרחק של אזור תצוגה אחד" וכו'.renderMarginPercent
המרחק המינימלי מאזור התצוגה הנוכחי למיקום המודעה חייב להיות כדי שנוכל לעבד מודעה. כך אפשר לבצע שליפה מראש (prefetch) של המודעה, אבל להמתין לעיבוד ולהורדה של משאבי משנה אחרים. הערך פועל בדיוק כמוfetchMarginPercent
כאחוז מאזור התצוגה.mobileScaling
מכפיל שחל על שולי רווח במכשירים ניידים. כך אפשר לשנות את השוליים בניידים ובמחשבים. לדוגמה, ערך של 2.0 יכפיל את כל השוליים ב-2 במכשירים ניידים, וכך יגדל המרחק המינימלי של משבצת לפני השליפה והעיבוד.
enableSingleRequest
-
enableSingleRequest(): boolean
-
מפעיל מצב בקשה יחידה לאחזור מודעות מרובות בו-זמנית. לשם כך יש להגדיר את כל מיקומי המודעות של בעלי תוכן דיגיטלי ולהוסיף אותם ל-PubAdsService, לפני הפעלת השירות. כדי שהשירות יופעל, יש להגדיר מצב בקשה יחידה.
-
- כדאי לעיין גם בפרטים הבאים
-
החזרות boolean
הפונקציה מחזירה את הערךtrue
אם מצב בקשה יחידה הופעל, ואת הערךfalse
אם לא ניתן להפעיל מצב בקשה בודדת מפני שהשיטה הופעלה אחרי שהשירות הופעל.
enableVideoAds
-
enableVideoAds(): void
-
אותות ל-GPT על כך שמודעות וידאו יופיעו בדף. כך מתאפשרת אילוצי החרגה תחרותיים במודעות לרשת המדיה ובמודעות וידאו. אם תוכן הווידאו ידוע, יש להתקשר למספר
PubAdsService.setVideoContent
כדי להשתמש בהחרגת תוכן למודעות ברשת המדיה. -
get
-
get(key: string): null | string
-
מחזירה את הערך של מאפיין AdSense המשויך למפתח הנתון.
-
- דוגמה
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (מדור קודם)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key: string
שם המאפיין שצריך לחפש. -
החזרות null | string
הערך הנוכחי של מפתח המאפיין, אוnull
אם המפתח לא קיים.
getAttributeKeys
-
getAttributeKeys(): string[]
-
מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
-
- דוגמה
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (מדור קודם)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
החזרות string[]
מערך של מפתחות מאפיינים שמוגדר לשירות הזה. הסדר לא מוגדר.
getTargeting
-
getTargeting(key: string): string[]
-
הפונקציה מחזירה פרמטר ספציפי של טירגוט ברמת השירות שהוגדר.
-
- דוגמה
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (מדור קודם)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
-
פרמטרים key: string
מפתח הטירגוט שצריך לחפש. -
החזרות string[]
הערכים שמשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה.
getTargetingKeys
-
getTargetingKeys(): string[]
-
מחזירה את הרשימה של כל מפתחות הטירגוט המותאמים אישית ברמת השירות שהוגדרו.
-
- דוגמה
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (מדור קודם)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
-
החזרות string[]
מערך של מפתחות טירגוט. הסדר לא מוגדר.
isInitialLoadDisabled
-
isInitialLoadDisabled(): boolean
-
הפונקציה מראה אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-
PubAdsService.disableInitialLoad
. -
-
החזרות boolean
הפונקציה מחזירה את הערךtrue
אם קריאה קודמת אלPubAdsService.disableInitialLoad
בוצעה בהצלחה. אחרת,false
.
refresh
-
refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void
-
אחזור ומציג מודעות חדשות למיקומים ספציפיים או לכל המיקומים בדף. התכונה פועלת רק במצב רינדור אסינכרוני.
כדי שהיא תפעל באופן תקין בכל הדפדפנים, יש להפעיל לפני הקריאה לפונקציהrefresh
את מיקום המודעה בדףdisplay
. אם הקריאה אלdisplay
לא תיכלל, יכול להיות שהרענון לא יפעל באופן בלתי צפוי. אם רוצים, אפשר להשתמש בשיטהPubAdsService.disableInitialLoad
כדי למנוע מ-display
לאחזר מודעה.
רענון מיקום מודעה מסיר את המודעה הישנה מצפייה בדף שנמשכת זמן רב של GPT, כך שבקשות עתידיות לא יושפעו ממחסומים או מהחרגות תחרותיות שקשורות למודעה הזו. -
- דוגמה
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (מדור קודם)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים slots?: null | Slot[]
המשבצות שצריך לרענן. המערך הוא אופציונלי. אם לא צוין מערך, כל יחידות הקיבולת ירועננו.options?: { changeCorrelator: boolean }
אפשרויות תצורה המשויכות לשיחת הרענון הזו.changeCorrelator
מציין אם יש ליצור מתאם חדש לאחזור מודעות או לא. שרתי המודעות שלנו שומרים על ערך מתאם זה לזמן קצר (כרגע למשך 30 שניות, אך עשוי להשתנות), כך שבקשות עם אותו מתאם שהתקבלו בקרבת מקום ייחשבו לצפייה בדף יחיד. כברירת מחדל, נוצר מתאם חדש לכל רענון.
הערה: לאפשרות הזו אין השפעה על צפיות בדף לטווח ארוך ב-GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות כרגע בדף ואין לו זמן תפוגה.
set
-
set(key: string, value: string): PubAdsService
-
מגדיר ערכים למאפייני AdSense שחלים על כל מיקומי המודעות בשירות 'מודעות לבעלי תוכן דיגיטלי'.
קריאה לפונקציה הזו יותר מפעם אחת לאותו מפתח תבטל את הערכים שהוגדרו קודם לכן עבור המפתח הזה. יש להגדיר את כל הערכים לפני הקריאה ל-display
או ל-refresh
. -
- דוגמה
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (מדור קודם)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key: string
שם המאפיין.value: string
ערך מאפיין. -
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): PubAdsService
-
מגדירה החרגה של קטגוריית מודעות ברמת הדף עבור שם התווית הנתון.
-
- דוגמה
-
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (מדור קודם)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים categoryExclusion: string
תווית ההחרגה של קטגוריית המודעות להוספה. -
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
setCentering
-
setCentering(centerAds: boolean): void
-
מפעילה ומשביתה מרכוז אופקי של מודעות. כברירת מחדל, המרכוז מושבת. בגרסה הקודמת של gpt_mobile.js, המרכוז מופעל כברירת מחדל.
יש להפעיל את השיטה הזו לפני הקריאה ל-display
או ל-refresh
, מפני שרק מודעות שהתבקשו אחרי הקריאה לשיטה הזו ימורכזו. -
- דוגמה
-
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (מדור קודם)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
-
פרמטרים centerAds: boolean
true
כדי להציג מודעות למרכז,false
כדי ליישר אותן לשמאל.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
-
המדיניות הזו קובעת אם יש לאלץ עיבוד של כל המודעות בדף באמצעות מאגר SafeFrame.
חשוב לזכור את הדברים הבאים כשמשתמשים ב-API הזה:- ההגדרה הזו תהיה בתוקף רק בבקשות הבאות להצגת מודעות שיישלחו במיקומים המתאימים.
- ההגדרה ברמת המיקום, אם צוינה, תמיד תבטל את ההגדרה ברמת הדף.
- אם היא מוגדרת כ-
true
(ברמת המיקום או ברמת הדף), המודעה תמיד תוצג באמצעות מאגר SafeFrame, ללא קשר לבחירה בממשק המשתמש של Google Ad Manager. - עם זאת, אם המדיניות מוגדרת לערך
false
או לא צוינה, המודעה תוצג באמצעות מאגר SafeFrame בהתאם לסוג הקריאייטיב ולבחירה שבוצעו בממשק המשתמש של Google Ad Manager. - יש להשתמש ב-API זה בזהירות מכיוון שהוא עלול להשפיע על ההתנהגות של קריאייטיבים שמנסים לפרוץ מה-iFrames שלהם או להסתמך על כך שיעובדו ישירות בדף של בעלי תוכן דיגיטלי.
-
- דוגמה
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (מדור קודם)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים forceSafeFrame: boolean
true
כדי לאלץ את כל המודעות בדף לעבור עיבוד ב-SafeFrames וב-false
כדי לשנות את ההגדרה הקודמת ל-False. אם המדיניות הזו לא צוינה,false
אם לא צוין אחרת, לא תהיה כל שינוי. -
החזרות PubAdsService
אובייקט השירות שבו נקראה הפונקציה.
setLocation
-
setLocation(address: string): PubAdsService
-
מעביר פרטי מיקום מאתרים כדי שתוכלו לבצע טירגוט גיאוגרפי של פריטים למיקומים ספציפיים.
-
- דוגמה
-
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (מדור קודם)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
-
פרמטרים address: string
כתובת בפורמט חופשי. -
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
setPrivacySettings
-
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
-
מאפשר לקבוע את כל הגדרות הפרטיות מ-API יחיד באמצעות אובייקט config.
-
- דוגמה
-
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (מדור קודם)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים privacySettings: PrivacySettingsConfig
אובייקט שמכיל הגדרות של פרטיות. -
החזרות PubAdsService
אובייקט השירות שבו נקראה הפונקציה.
setPublisherProvidedId
-
setPublisherProvidedId(ppid: string): PubAdsService
-
קביעת הערך של המזהה שסופק על ידי בעל האפליקציה.
-
- דוגמה
-
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (מדור קודם)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים ppid: string
מזהה אלפאנומרי שסופק על ידי בעל התוכן הדיגיטלי. חייב להכיל בין 32 ל-150 תווים. -
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
setSafeFrameConfig
-
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
-
מגדיר את ההעדפות ברמת הדף לתצורת SafeFrame. המערכת תתעלם ממפתחות לא מזוהים באובייקט config. המערכת תתעלם מההגדרה כולה אם יועבר ערך לא חוקי למפתח מזוהה.
העדפות ברמת הדף יבטלו את ההעדפות ברמת המיקום, אם צוינו. -
- דוגמה
-
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (מדור קודם)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים config: SafeFrameConfig
אובייקט התצורה. -
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
setTargeting
-
setTargeting(key: string, value: string | string[]): PubAdsService
-
מגדיר פרמטרים מותאמים אישית של טירגוט למפתח נתון, שיחול על כל מיקומי המודעות של שירות המודעות של בעלי תוכן דיגיטלי. קריאה חוזרת לאותו המפתח תחליף ערכים ישנים. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
-
- דוגמה
-
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (מדור קודם)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key: string
מפתח פרמטר של טירגוט.value: string | string[]
ערך פרמטר או מערך ערכים של טירגוט. -
החזרות PubAdsService
אובייקט השירות שבו נקראה השיטה.
setVideoContent
-
setVideoContent(videoContentId: string, videoCmsId: string): void
-
מגדיר את המידע של תוכן הווידאו שיישלח יחד עם הבקשות להצגת מודעות למטרות טירגוט והחרגת תוכן. מודעות וידאו יופעלו אוטומטית לאחר קריאה לשיטה הזו. עבור
videoContentId
ו-videoCmsId
, יש להשתמש בערכים שסופקו לשירות הטמעת התוכן של Google Ad Manager. -
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים videoContentId: string
מזהה התוכן של הסרטוןvideoCmsId: string
מזהה מערכת ניהול התוכן של הסרטון
updateCorrelator
-
updateCorrelator(): PubAdsService
-
שינוי המתאם שנשלח עם בקשות להצגת מודעה, ומתחיל בפועל צפייה חדשה בדף. המתאם הזה זהה לכל הבקשות למודעות שמגיעות מצפייה אחת בדף, וייחודי לכל הצפיות בדפים. המצב הזה רלוונטי רק למצב אסינכרוני.
הערה:אין לכך השפעה על צפייה בדף לטווח ארוך של GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות בפועל בדף ואין לה זמן תפוגה. -
- דוגמה
-
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (מדור קודם)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
-
החזרות PubAdsService
אובייקט השירות שבו נקראה הפונקציה.
googletag.ResponseInformation
אובייקט שמייצג תגובה אחת למודעה.
סיכום נכס | |
---|---|
advertiserId
|
המזהה של המפרסם.
|
campaignId
|
המזהה של הקמפיין.
|
creativeId
|
המזהה של הקריאייטיב.
|
creativeTemplateId
|
מזהה התבנית של המודעה.
|
lineItemId
|
המזהה של הפריט.
|
- כדאי לעיין גם בפרטים הבאים
advertiserId
-
advertiserId: null | number
-
המזהה של המפרסם.
-
campaignId
-
campaignId: null | number
-
המזהה של הקמפיין.
-
creativeId
-
creativeId: null | number
-
המזהה של הקריאייטיב.
-
creativeTemplateId
-
creativeTemplateId: null | number
-
מזהה התבנית של המודעה.
-
lineItemId
-
lineItemId: null | number
-
המזהה של הפריט.
-
googletag.RewardedPayload
אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת
סיכום נכס | |
---|---|
amount
|
מספר הפריטים שכלולים בפרס.
|
type
|
סוג הפריט שנכלל בפרס (לדוגמה, 'מטבע').
|
- כדאי לעיין גם בפרטים הבאים
amount
-
amount: number
-
מספר הפריטים שכלולים בפרס.
-
type
-
type: string
-
סוג הפריט שנכלל בפרס (לדוגמה, 'מטבע').
-
googletag.SafeFrameConfig
אובייקט הגדרה של קונטיינרים של SafeFrame.
סיכום נכס | |
---|---|
allowOverlayExpansion
|
האם SafeFrame צריך לאפשר הרחבה של תוכן מודעה על ידי שכבת-על של תוכן הדף.
|
allowPushExpansion
|
האם SafeFrame צריך לאפשר הרחבה של תוכן מודעה על ידי דחיפת תוכן של דף.
|
sandbox
|
האם SafeFrame צריך להשתמש במאפיין ארגז החול של HTML5 כדי למנוע ניווט ברמה העליונה ללא אינטראקציה של המשתמש.
|
useUniqueDomain
|
הוצא משימוש.
האם SafeFrame צריך להשתמש בתת-דומיינים אקראיים עבור נכסי קריאייטיב בהזמנה.
|
- כדאי לעיין גם בפרטים הבאים
allowOverlayExpansion
-
allowOverlayExpansion: boolean
-
האם SafeFrame צריך לאפשר הרחבה של תוכן מודעה על ידי שכבת-על של תוכן הדף.
-
allowPushExpansion
-
allowPushExpansion: boolean
-
האם SafeFrame צריך לאפשר הרחבה של תוכן מודעה על ידי דחיפת תוכן של דף.
-
sandbox
-
sandbox: boolean
-
האם SafeFrame צריך להשתמש במאפיין ארגז החול של HTML5 כדי למנוע ניווט ברמה העליונה ללא אינטראקציה של המשתמש. הערך החוקי היחיד הוא
true
(לא ניתן לאלץ אותו להיותfalse
). חשוב לשים לב שמאפיין ה-Sandbox משבית יישומי פלאגין (למשל Flash). -
useUniqueDomain
-
useUniqueDomain: null | boolean
-
האם SafeFrame צריך להשתמש בתת-דומיינים אקראיים עבור נכסי קריאייטיב בהזמנה. צריך להעביר את
null
כדי למחוק את הערך ששמור.
הערה: התכונה הזו מופעלת כברירת מחדל. -
- כדאי לעיין גם בפרטים הבאים
googletag.Service
מחלקת שירות בסיסית שמכילה שיטות הנפוצות לכל השירותים.
סיכום שיטה | |
---|---|
addEventListener
|
הרישום של ה-listener מאפשר להגדיר ולהפעיל פונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף.
|
getSlots
|
קבל את רשימת המשבצות המשויכות לשירות הזה.
|
removeEventListener
|
הסרה של האזנה שנרשם בעבר.
|
addEventListener
-
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (arg: EventTypeMap[K]) => void): Service
-
הרישום של ה-listener מאפשר להגדיר ולהפעיל פונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. המערכת תומכת באירועים הבאים:
אובייקט מסוג האירוע המתאים מועבר ל-listener כשהיא מופעלת. -
- דוגמה
-
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים eventType: K
מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי אירועים הם תלויי אותיות רישיות.listener: (arg: EventTypeMap[K]) => void
פונקציה שלוקחת ארגומנט של אובייקט אירוע יחיד. -
החזרות Service
אובייקט השירות שבו נקראה השיטה.
getSlots
removeEventListener
-
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void
-
הסרה של האזנה שנרשם בעבר.
-
- דוגמה
-
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (מדור קודם)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
-
פרמטרים eventType: K
מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי אירועים הם תלויי אותיות רישיות.listener: (event: EventTypeMap[K]) => void
פונקציה שלוקחת ארגומנט של אובייקט אירוע יחיד.
googletag.SizeMappingBuilder
Builder לאובייקטים במפרט למיפוי גודל. הכלי הזה מסופק כדי לעזור לבנות בקלות מפרטי גדלים.
סיכום שיטה | |
---|---|
addSize
|
הוספת מיפוי ממערך בגודל יחיד (המייצג את אזור התצוגה) למערך בגודל יחיד או מרובה גדלים שמייצג את יחידת הקיבולת (Slot).
|
build
|
יוצר מפרט של מפת גדלים מהמיפויים שנוספו ל-builder.
|
- כדאי לעיין גם בפרטים הבאים
addSize
-
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
-
הוספת מיפוי ממערך בגודל יחיד (המייצג את אזור התצוגה) למערך בגודל יחיד או מרובה גדלים שמייצג את יחידת הקיבולת (Slot).
-
- דוגמה
-
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (מדור קודם)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
-
פרמטרים viewportSize: SingleSizeArray
הגודל של אזור התצוגה עבור רשומת המיפוי הזו.slotSize: GeneralSize
הגדלים של יחידת הקיבולת של רשומת המיפוי הזו. -
החזרות SizeMappingBuilder
הפניה ל-builder הזה.
build
-
build(): null | SizeMappingArray
-
יוצר מפרט של מפת גדלים מהמיפויים שנוספו ל-builder הזה.
אם סופקו מיפויים לא חוקיים, השיטה הזו תחזיר את הערךnull
. אחרת, הוא יחזיר מפרט בפורמט הנכון שיועבר אלSlot.defineSizeMapping
.
הערה: ההתנהגות של ה-builder אחרי הקריאה לשיטה הזו לא מוגדרת. -
-
החזרות null | SizeMappingArray
התוצאה שנוצרה על ידי ה-builder הזה. הערך יכול להיות null אם סופקו מיפויי גודל לא חוקיים.
googletag.Slot
מיקום מודעה הוא אובייקט שמייצג מיקום מודעה יחיד בדף.
סיכום שיטה | |
---|---|
addService
|
הוספה של
Service למשבצת הזמן הזו.
|
clearCategoryExclusions
|
ניקוי כל תוויות ההחרגה של קטגוריות המודעות ברמת המיקום עבור המיקום הזה.
|
clearTargeting
|
יתבצע ניקוי של הפרמטרים הספציפיים או של כל הפרמטרים המותאמים אישית ברמת המיקום למיקום הזה.
|
defineSizeMapping
|
מגדירה מערך של מיפויים מגודל אזור תצוגה מינימלי עד גודל משבצת ליחידה הזו.
|
get
|
מחזירה את הערך של מאפיין AdSense המשויך למפתח הנתון עבור משבצת זו.
|
getAdUnitPath
|
מחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת והנתיב של יחידת המודעות.
|
getAttributeKeys
|
הפונקציה מחזירה את רשימת מפתחות המאפיינים שמוגדרים ביחידת הקיבולת (Slot) הזו.
|
getCategoryExclusions
|
הפונקציה מחזירה את תוויות ההחרגה של קטגוריית המודעות במיקום הזה.
|
getResponseInformation
|
הפונקציה מחזירה את המידע לגבי התגובה למודעה.
|
getSlotElementId
|
הפונקציה מחזירה את המזהה של יחידת הקיבולת (Slot)
div שסופקה כשהחריץ הוגדר.
|
getTargeting
|
הפונקציה מחזירה פרמטר ספציפי של טירגוט בהתאמה אישית שהוגדר במיקום הזה.
|
getTargetingKeys
|
הפונקציה מחזירה את הרשימה של כל מפתחות הטירגוט בהתאמה אישית שהוגדרו במשבצת הזו.
|
set
|
מגדיר ערך למאפיין AdSense במיקום המודעה הזה.
|
setCategoryExclusion
|
מגדיר תווית החרגה של קטגוריית מודעות ברמת המיקום במשבצת הזו.
|
setClickUrl
|
מגדירה את כתובת ה-URL של הקליק שאליה המשתמשים יופנו אחרי שילחצו על המודעה.
|
setCollapseEmptyDiv
|
המדיניות הזו מגדירה אם המיקום
div יוסתר כשאין מודעה במיקום הזה.
|
setConfig
|
מגדיר אפשרויות תצורה כלליות עבור יחידת הקיבולת (Slot).
|
setForceSafeFrame
|
המדיניות הזו קובעת אם יש לאלץ הצגת מודעות במשבצת הזו באמצעות מאגר SafeFrame.
|
setSafeFrameConfig
|
מגדיר את ההעדפות ברמת המיקום לתצורה של SafeFrame.
|
setTargeting
|
מגדיר פרמטר טירגוט מותאם אישית למיקום הזה.
|
updateTargetingFromMap
|
מגדיר פרמטרים מותאמים אישית של טירגוט ביחידת הקיבולת (Slot), ממפת מפתח:ערך באובייקט JSON.
|
addService
-
הוספה של
Service
למשבצת הזמן הזו. -
- דוגמה
-
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (מדור קודם)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים service: Service
השירות שצריך להוסיף. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
clearCategoryExclusions
-
clearCategoryExclusions(): Slot
-
ניקוי כל תוויות ההחרגה של קטגוריות המודעות ברמת המיקום עבור המיקום הזה.
-
- דוגמה
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (מדור קודם)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
-
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
clearTargeting
-
clearTargeting(key?: string): Slot
-
יתבצע ניקוי של הפרמטרים הספציפיים או של כל הפרמטרים המותאמים אישית ברמת המיקום למיקום הזה.
-
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key?: string
מפתח פרמטר של טירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל הפרמטרים של הטירגוט יימחקו. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
defineSizeMapping
-
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
-
מגדירה מערך של מיפויים מגודל אזור תצוגה מינימלי עד גודל משבצת ליחידה הזו.
-
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping!);
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים sizeMapping: SizeMappingArray
מערך של מיפויי גדלים. אפשר להשתמש ב-SizeMappingBuilder
כדי ליצור אותו. כל מיפוי גודל הוא מערך של שני רכיבים:SingleSizeArray
ו-GeneralSize
. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
get
-
get(key: string): null | string
-
מחזירה את הערך של מאפיין AdSense המשויך למפתח הנתון עבור משבצת זו. כדי להציג מאפיינים ברמת השירות שהועברו בירושה ביחידת הקיבולת (Slot) הזו, צריך להשתמש ב-
PubAdsService.get
. -
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key: string
שם המאפיין שצריך לחפש. -
החזרות null | string
הערך הנוכחי של מפתח המאפיין, אוnull
אם המפתח לא קיים.
getAdUnitPath
-
getAdUnitPath(): string
-
מחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת והנתיב של יחידת המודעות.
-
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
-
החזרות string
נתיב יחידת המודעות.
getAttributeKeys
-
getAttributeKeys(): string[]
-
הפונקציה מחזירה את רשימת מפתחות המאפיינים שמוגדרים ביחידת הקיבולת (Slot) הזו. כדי לראות את המפתחות של מאפיינים ברמת השירות שהועברו בירושה ביחידת הקיבולת (Slot) הזו, צריך להשתמש ב-
PubAdsService.getAttributeKeys
. -
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
החזרות string[]
מערך של מפתחות מאפיינים. הסדר לא מוגדר.
getCategoryExclusions
-
getCategoryExclusions(): string[]
-
הפונקציה מחזירה את תוויות ההחרגה של קטגוריית המודעות במיקום הזה.
-
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
-
החזרות string[]
תוויות ההחרגה של קטגוריות המודעות במיקום הזה, או מערך ריק אם לא הוגדרו.
getResponseInformation
-
getResponseInformation(): null | ResponseInformation
-
הפונקציה מחזירה את המידע לגבי התגובה למודעה. הנתון הזה מבוסס על התגובה האחרונה למודעה במיקום המודעה. אם קריאה כזו מתבצעת כאשר במיקום המודעה אין מודעה, הפונקציה תחזיר
null
. -
-
החזרות null | ResponseInformation
המידע העדכני ביותר לגבי התגובה למודעה, אוnull
אם במיקום המודעה אין מודעה.
getSlotElementId
-
getSlotElementId(): string
-
הפונקציה מחזירה את המזהה של יחידת הקיבולת (Slot)
div
שסופקה כשהחריץ הוגדר. -
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
-
החזרות string
מזהה משבצתdiv
.
getTargeting
-
getTargeting(key: string): string[]
-
הפונקציה מחזירה פרמטר ספציפי של טירגוט בהתאמה אישית שהוגדר במיקום הזה. לא כולל פרמטרים של טירגוט ברמת השירות.
-
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
-
פרמטרים key: string
מפתח הטירגוט שצריך לחפש. -
החזרות string[]
הערכים שמשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה.
getTargetingKeys
-
getTargetingKeys(): string[]
-
הפונקציה מחזירה את הרשימה של כל מפתחות הטירגוט בהתאמה אישית שהוגדרו במשבצת הזו. לא כולל מפתחות טירגוט ברמת השירות.
-
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
-
החזרות string[]
מערך של מפתחות טירגוט. הסדר לא מוגדר.
set
-
set(key: string, value: string): Slot
-
מגדיר ערך למאפיין AdSense במיקום המודעה הזה. הפעולה הזו תשנה את הערכים שהוגדרו ברמת השירות למפתח הזה.
קריאה לשיטה הזו יותר מפעם אחת לאותו המפתח תבטל ערכים שהוגדרו בעבר למפתח הזה. יש להגדיר את כל הערכים לפני הקריאה ל-display
או ל-refresh
. -
- דוגמה
-
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (מדור קודם)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key: string
שם המאפיין.value: string
ערך מאפיין. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): Slot
-
מגדיר תווית החרגה של קטגוריית מודעות ברמת המיקום במשבצת הזו.
-
- דוגמה
-
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (מדור קודם)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים categoryExclusion: string
תווית ההחרגה של קטגוריית המודעות להוספה. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
setClickUrl
-
setClickUrl(value: string): Slot
-
מגדירה את כתובת ה-URL של הקליק שאליה המשתמשים יופנו אחרי שילחצו על המודעה.
השרתים של Google Ad Manager עדיין יתעדו קליק גם אם כתובת ה-URL של הקליק תוחלף. כל כתובת של דף נחיתה המשויכת לקריאייטיב המוצג מצורפת לערך שצוין. הקריאות הבאות מחליפות את הערך. הדבר פועל רק בבקשות שאינן SRA. -
- דוגמה
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (מדור קודם)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
-
פרמטרים value: string
כתובת ה-URL להגדרה. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
setCollapseEmptyDiv
-
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
-
המדיניות הזו מגדירה אם המיקום
div
יוסתר כשאין מודעה במיקום הזה. ההגדרה הזו מבטלת את ההגדרות ברמת השירות. -
- דוגמה
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (מדור קודם)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים collapse: boolean
האם לכווץ את מיקום המודעה אם לא מוחזרת מודעה.collapseBeforeAdFetch?: boolean
האם לכווץ את מיקום המודעה עוד לפני אחזור המודעה. המערכת תתעלם אם הכיווץ אינוtrue
. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
setConfig
-
setConfig(slotConfig: SlotSettingsConfig): void
-
מגדיר אפשרויות תצורה כלליות עבור יחידת הקיבולת (Slot).
-
-
פרמטרים slotConfig: SlotSettingsConfig
אובייקט התצורה.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): Slot
-
המדיניות הזו קובעת אם יש לאלץ עיבוד מודעות במשבצת הזו באמצעות מאגר SafeFrame.
חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:- ההגדרה הזו תהיה בתוקף רק בבקשות הבאות להצגת מודעות שיישלחו במיקומים המתאימים.
- ההגדרה ברמת המיקום, אם צוינה, תמיד תבטל את ההגדרה ברמת הדף.
- אם היא מוגדרת כ-
true
(ברמת המיקום או ברמת הדף), המודעה תמיד תוצג באמצעות מאגר SafeFrame, ללא קשר לבחירה בממשק המשתמש של Google Ad Manager. - עם זאת, אם המדיניות מוגדרת לערך
false
או לא צוינה, המודעה תוצג באמצעות מאגר SafeFrame בהתאם לסוג הקריאייטיב ולבחירה שבוצעו בממשק המשתמש של Google Ad Manager. - יש להשתמש ב-API זה בזהירות מכיוון שהוא עלול להשפיע על ההתנהגות של קריאייטיבים שמנסים לפרוץ מה-iFrames שלהם או להסתמך על כך שיעובדו ישירות בדף של בעלי תוכן דיגיטלי.
-
- דוגמה
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (מדור קודם)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים forceSafeFrame: boolean
true
כדי לאלץ את כל המודעות במשבצת הזו להופיע ב-SafeFrames וב-false
לבטל את ההסכמה להגדרה ברמת הדף (אם קיימת). אם קובעים במדיניות את הערךfalse
כשהיא לא מוגדרת ברמת הדף, הוא לא ישתנה. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
setSafeFrameConfig
-
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
-
מגדיר את ההעדפות ברמת המיקום לתצורה של SafeFrame. המערכת תתעלם ממפתחות לא מזוהים באובייקט config. המערכת תתעלם מההגדרה כולה אם יועבר ערך לא חוקי למפתח מזוהה.
העדפות ברמת המיקום, אם צוינו, יבטלו העדפות ברמת הדף. -
- דוגמה
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (מדור קודם)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים config: null | SafeFrameConfig
אובייקט התצורה. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
setTargeting
-
setTargeting(key: string, value: string | string[]): Slot
-
מגדיר פרמטר טירגוט מותאם אישית למיקום הזה. קריאה לשיטה הזו כמה פעמים לאותו מפתח תחליף ערכים ישנים. הערכים שמוגדרים כאן יחליפו את הפרמטרים של הטירגוט שהוגדרו ברמת השירות. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
-
- דוגמה
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (מדור קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- כדאי לעיין גם בפרטים הבאים
-
פרמטרים key: string
מפתח פרמטר של טירגוט.value: string | string[]
ערך פרמטר או מערך ערכים של טירגוט. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
updateTargetingFromMap
-
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
-
מגדיר פרמטרים מותאמים אישית של טירגוט ביחידת הקיבולת (Slot), ממפת מפתח:ערך באובייקט JSON. הפעולה הזו זהה לקריאה ל-
Slot.setTargeting
עבור כל ערכי המפתח של האובייקט. המפתחות האלה מוגדרים בחשבון Google Ad Manager שלך.
הערות:- במקרה של החלפה, רק הערך האחרון יישמר.
- אם הערך הוא מערך, כל ערך קודם יוחלף, ולא ימוזג.
- הערכים שמוגדרים כאן יחליפו את הפרמטרים של הטירגוט שהוגדרו ברמת השירות.
-
- דוגמה
-
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (מדור קודם)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
-
פרמטרים map: { [adUnitPath: string]: string | string[] }
מפתח פרמטר של טירגוט:מפת ערכים. -
החזרות Slot
אובייקט ה-משבצת שבו נקראה השיטה.
googletag.config.AdExpansionConfig
הגדרות לשליטה בהרחבת המודעה.
סיכום נכס | |
---|---|
enabled
|
האם הרחבת המודעות מופעלת או מושבתת.
|
- דוגמה
-
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (מדור קודם)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
enabled
-
enabled: boolean
-
אם הרחבת המודעות מופעלת או מושבתת.
הגדרת הערך הזה מבטלת את ברירת המחדל שהוגדרה ב-Google Ad Manager. -
- כדאי לעיין גם בפרטים הבאים
googletag.config.ComponentAuctionConfig
אובייקט שמייצג מכירה פומבית של רכיב יחיד במכרז מודעות במכשיר.
סיכום נכס | |
---|---|
auctionConfig
|
אובייקט הגדרת מכרז עבור המכרז של הרכיב הזה.
|
configKey
|
מפתח התצורה שמשויך למכרז של הרכיב הזה.
|
- כדאי לעיין גם בפרטים הבאים
auctionConfig
-
auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
-
אובייקט הגדרת מכרז של הרכיב הזה.
אם הערך מוגדר כ-null
, כל ההגדרות הקיימות שלconfigKey
שצוינו יימחקו. -
- דוגמה
-
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (מדור קודם)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- כדאי לעיין גם בפרטים הבאים
configKey
-
configKey: string
-
מפתח התצורה שמשויך למכרז של הרכיב הזה.
הערך לא יכול להיות ריק ועליו להיות ייחודי. אם לשני אובייקטים מסוגComponentAuctionConfig
יש ערך configKey זהה, האובייקטים האחרונים שיוגדרו יחליפו את ההגדרות הקודמות. -
googletag.config.InterstitialConfig
אובייקט שמגדיר את ההתנהגות של מיקום יחיד של מודעת מעברון.
סיכום נכס | |
---|---|
triggers
|
ההגדרה של הטריגר למודעת המעברון הזו.
|
triggers
-
triggers: Partial<Record<InterstitialTrigger, boolean>>
-
ההגדרה של טריגר מודעת מעברון עבור מודעת המעברון הזו.
הגדרת הערך של טריגר מסוג מעברון ל-true
תפעיל אותו ו-false
תשבית אותו. הפעולה הזו תחליף את ערכי ברירת המחדל שהוגדרו ב-Google Ad Manager. -
- דוגמה
-
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (מדור קודם)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- כדאי לעיין גם בפרטים הבאים
googletag.config.PageSettingsConfig
ממשק תצורה ראשי עבור הגדרות ברמת הדף.
מאפשר הגדרה של תכונות מרובות בקריאה יחידה ל-API.
כל המאפיינים המפורטים למטה הם דוגמאות ואינם משקפים תכונות בפועל שמשתמשות ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות בסוג PageSettingsConfig שבהמשך.
דוגמאות:
- רק תכונות שצוינו בקריאה
setConfig
משתנות.// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה נתונה מתעדכנות בכל קריאה אל
setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- כדי למחוק את כל ההגדרות של תכונה מסוימת, אפשר להעביר את הפקודה
null
.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
סיכום נכס | |
---|---|
adExpansion
|
הגדרות לשליטה בהרחבת המודעה.
|
pps
|
הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS).
|
privacyTreatments
|
הגדרות לבקרה על הטיפול במדיניות הפרטיות של בעלי תוכן דיגיטלי.
|
adExpansion
-
adExpansion: null | AdExpansionConfig
-
הגדרות לשליטה בהרחבת המודעה.
-
pps
-
pps: null | PublisherProvidedSignalsConfig
-
הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS).
-
privacyTreatments
-
privacyTreatments: null | PrivacyTreatmentsConfig
-
הגדרות לבקרה על הטיפול במדיניות הפרטיות של בעלי תוכן דיגיטלי.
-
googletag.config.PrivacyTreatmentsConfig
הגדרות לבקרה על הטיפול במדיניות הפרטיות של בעלי תוכן דיגיטלי.
סיכום נכס | |
---|---|
treatments
|
מגוון אמצעים לשמירה על הפרטיות של בעלי תוכן דיגיטלי שאפשר להפעיל.
|
treatments
-
treatments: "disablePersonalization"[]
-
מגוון אמצעים לשמירה על הפרטיות של בעלי תוכן דיגיטלי שאפשר להפעיל.
-
- דוגמה
-
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (מדור קודם)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvidedSignalsConfig
אובייקט הגדרת אותות שמספקים בעלי תוכן דיגיטלי (PPS).
סיכום נכס | |
---|---|
taxonomies
|
אובייקט שמכיל מיפויים של טקסונומיה.
|
- דוגמה
-
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (מדור קודם)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
- כדאי לעיין גם בפרטים הבאים
taxonomies
-
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
-
אובייקט שמכיל מיפויים של טקסונומיה.
-
googletag.config.SlotSettingsConfig
ממשק התצורה הראשי להגדרות ברמת יחידת הקיבולת.
ניתן להגדיר מספר תכונות באמצעות קריאה אחת ל-API עבור יחידת קיבולת (Slot) יחידה.
כל המאפיינים שמפורטים בהמשך הם דוגמאות, והם לא משקפים תכונות בפועל שמשתמשות ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות בסוג ErrorSettingsConfig שבהמשך.
דוגמאות:
- רק תכונות שצוינו בקריאה
Slot.setConfig
משתנות.const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה נתונה מתעדכנות בכל קריאה אל
Slot.setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- כדי למחוק את כל ההגדרות של תכונה מסוימת, אפשר להעביר את הפקודה
null
.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
סיכום נכס | |
---|---|
adExpansion
|
הגדרות לשליטה בהרחבת המודעה.
|
componentAuction
|
מערך מכרזים של רכיבים שייכללו במכרז של מודעות במכשיר.
|
interstitial
|
הגדרות לשליטה בהתנהגות של מיקומי מודעות מעברון.
|
adExpansion
-
adExpansion: AdExpansionConfig
-
הגדרות לשליטה בהרחבת המודעה.
-
componentAuction
-
componentAuction: ComponentAuctionConfig[]
-
מערך מכרזים של רכיבים שייכללו במכרז של מודעות במכשיר.
-
interstitial
-
interstitial: InterstitialConfig
-
הגדרות לשליטה בהתנהגות של מיקומי מודעות מעברון.
-
googletag.config.TaxonomyData
אובייקט שמכיל את הערכים של טקסונומיה אחת.
סיכום נכס | |
---|---|
values
|
רשימה של ערכי טקסונומיה.
|
values
-
values: string[]
-
רשימה של ערכי טקסונומיה.
-
googletag.events.Event
ממשק בסיסי לכל אירועי GPT. כל אירועי GPT שלמטה יכללו את השדות הבאים.
סיכום נכס | |
---|---|
serviceName
|
שם השירות שהפעיל את האירוע.
|
slot
|
המשבצת שהפעילה את האירוע.
|
- כדאי לעיין גם בפרטים הבאים
serviceName
-
serviceName: string
-
שם השירות שהפעיל את האירוע.
-
slot
-
slot: Slot
-
המשבצת שהפעילה את האירוע.
-
googletag.events.EventTypeMap
זהו פסאודו-טיפוס שממפה שם אירוע לסוג אובייקט האירוע התואם שלו עבור Service.addEventListener
ו-Service.removeEventListener
. הוא מתועד למטרות בטיחות ועיון בלבד.
סיכום נכס | |
---|---|
impressionViewable
|
כינוי של
events.ImpressionViewableEvent .
|
rewardedSlotClosed
|
כינוי של
events.RewardedSlotClosedEvent .
|
rewardedSlotGranted
|
כינוי של
events.RewardedSlotGrantedEvent .
|
rewardedSlotReady
|
כינוי של
events.RewardedSlotReadyEvent .
|
slotOnload
|
כינוי של
events.SlotOnloadEvent .
|
slotRenderEnded
|
כינוי של
events.SlotRenderEndedEvent .
|
slotRequested
|
כינוי של
events.SlotRequestedEvent .
|
slotResponseReceived
|
כינוי של
events.SlotResponseReceived .
|
slotVisibilityChanged
|
כינוי של
events.SlotVisibilityChangedEvent .
|
impressionViewable
-
impressionViewable: ImpressionViewableEvent
-
כינוי של
events.ImpressionViewableEvent
. -
rewardedSlotClosed
-
rewardedSlotClosed: RewardedSlotClosedEvent
-
כינוי של
events.RewardedSlotClosedEvent
. -
rewardedSlotGranted
-
rewardedSlotGranted: RewardedSlotGrantedEvent
-
כינוי של
events.RewardedSlotGrantedEvent
. -
rewardedSlotReady
-
rewardedSlotReady: RewardedSlotReadyEvent
-
כינוי של
events.RewardedSlotReadyEvent
. -
slotOnload
-
slotOnload: SlotOnloadEvent
-
כינוי של
events.SlotOnloadEvent
. -
slotRenderEnded
-
slotRenderEnded: SlotRenderEndedEvent
-
כינוי של
events.SlotRenderEndedEvent
. -
slotRequested
-
slotRequested: SlotRequestedEvent
-
כינוי של
events.SlotRequestedEvent
. -
slotResponseReceived
-
slotResponseReceived: SlotResponseReceived
-
כינוי של
events.SlotResponseReceived
. -
slotVisibilityChanged
-
slotVisibilityChanged: SlotVisibilityChangedEvent
-
כינוי של
events.SlotVisibilityChangedEvent
. -
googletag.events.ImpressionViewableEvent
הרחבה
האירוע הזה מופעל כשחשיפה ניתנת לצפייה, בהתאם לקריטריונים של Active View.
סיכום נכס | |
---|---|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
- דוגמה
-
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
googletag.events.RewardedSlotClosedEvent
הרחבה
האירוע הזה מופעל כשהמשתמש סוגר מיקום מודעה מתגמלת. הוא עשוי לפעול לפני או אחרי קבלת הפרס. כדי לקבוע אם הוענק פרס, יש להשתמש במקום זאת ב-events.RewardedSlotGrantedEvent
.
סיכום נכס | |
---|---|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
- דוגמה
-
JavaScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called when the user closes a rewarded ad slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
googletag.events.RewardedSlotGrantedEvent
הרחבה
האירוע הזה מופעל כאשר מוענק תגמול על צפייה במודעה מתגמלת. אם המודעה נסגרת לפני עמידה בקריטריונים למתן תגמול, האירוע הזה לא יופעל.
סיכום נכס | |
---|---|
payload
|
אובייקט שמכיל מידע על התגמול שהוענק.
|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
- דוגמה
-
JavaScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called whenever a reward is granted for a // rewarded ad. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
payload
-
payload: null | RewardedPayload
-
אובייקט שמכיל מידע על התגמול שהוענק.
-
googletag.events.RewardedSlotReadyEvent
הרחבה
האירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה. בעל התוכן הדיגיטלי אחראי להציג למשתמש אפשרות לצפות במודעה לפני הצגתה.
סיכום נכס | |
---|---|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
סיכום שיטה | |
---|---|
makeRewardedVisible
|
מציג את המודעה המתגמלת.
|
- דוגמה
-
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
makeRewardedVisible
-
makeRewardedVisible(): void
-
מציג את המודעה המתגמלת. אין להפעיל את השיטה הזו עד שהמשתמש מביע הסכמה להציג את המודעה.
-
googletag.events.SlotOnloadEvent
הרחבה
האירוע הזה מופעל כאשר ה-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. כשמעבדים מודעות מדיה עשירה במצב עיבוד סנכרון, לא נעשה שימוש ב-iframe ולכן לא יופעל SlotOnloadEvent
.
סיכום נכס | |
---|---|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
- דוגמה
-
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
googletag.events.SlotRenderEndedEvent
הרחבה
האירוע הזה מופעל כאשר קוד הקריאייטיב מוחדר למיקום. האירוע הזה יתרחש לפני אחזור משאבי הקריאייטיב, ולכן ייתכן שהקריאייטיב עדיין לא מוצג. אם אתם צריכים לדעת מתי הטעינה של כל משאבי הקריאייטיב במיקום מסוים הסתיימה, כדאי להשתמש ב-events.SlotOnloadEvent
.
סיכום נכס | |
---|---|
advertiserId
|
מזהה המפרסם של המודעה שעברה עיבוד.
|
campaignId
|
מזהה הקמפיין של המודעה שעברה עיבוד.
|
companyIds
|
מזהים של החברות שמגישים הצעות מחיר על המודעה למילוי חוסרים (backfill) שעברה עיבוד.
|
creativeId
|
מזהה הקריאייטיב של המודעה בהזמנה שעברה עיבוד.
|
creativeTemplateId
|
מזהה תבנית הקריאייטיב של המודעה בהזמנה שעברה עיבוד.
|
isBackfill
|
האם המודעה הייתה מילוי חוסרים (backfill).
|
isEmpty
|
האם הוחזרה מודעה עבור מיקום המודעה.
|
labelIds
|
מזהי התוויות של המודעה שעברה עיבוד.
|
lineItemId
|
מזהה הפריט של המודעה בהזמנה שעברה עיבוד.
|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
size
|
מציין את גודל הפיקסל של הקריאייטיב לאחר עיבוד.
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
slotContentChanged
|
האם התוכן של מיקום המודעה השתנה עם המודעה המעובדת.
|
sourceAgnosticCreativeId
|
מזהה הקריאייטיב של מודעת ההזמנה או המודעה למילוי חוסרים (backfill).
|
sourceAgnosticLineItemId
|
מזהה הפריט של מודעת ההזמנה המעובדת או המודעה למילוי חוסרים (backfill).
|
yieldGroupIds
|
מזהים של קבוצות תפוקה למודעת המילוי החוזר המעובדת.
|
- דוגמה
-
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
advertiserId
-
advertiserId: null | number
-
מזהה המפרסם של המודעה שעברה עיבוד. הערך הוא
null
עבור מיקומים ריקים, מודעות מילוי חוסרים וקריאייטיבים שעובדו על ידי שירותים שאינםPubAdsService
. -
campaignId
-
campaignId: null | number
-
מזהה הקמפיין של המודעה שעברה עיבוד. הערך הוא
null
עבור מיקומים ריקים, מודעות מילוי חוסרים וקריאייטיבים שעובדו על ידי שירותים שאינםPubAdsService
. -
companyIds
-
companyIds: null | number[]
-
מזהים של החברות שמגישים הצעות מחיר על המודעה למילוי חוסרים (backfill) שעברה עיבוד. הערך הוא
null
עבור מיקומים ריקים, מודעות בהזמנה ונכסי קריאייטיב שעובדו על ידי שירותים שאינםPubAdsService
. -
creativeId
-
creativeId: null | number
-
מזהה הקריאייטיב של המודעה בהזמנה שעברה עיבוד. הערך הוא
null
עבור מיקומים ריקים, מודעות מילוי חוסרים וקריאייטיבים שעובדו על ידי שירותים שאינםPubAdsService
. -
creativeTemplateId
-
creativeTemplateId: null | number
-
מזהה תבנית הקריאייטיב של המודעה בהזמנה שעברה עיבוד. הערך הוא
null
עבור מיקומים ריקים, מודעות מילוי חוסרים וקריאייטיבים שעובדו על ידי שירותים שאינםPubAdsService
. -
isBackfill
-
isBackfill: boolean
-
האם המודעה הייתה מילוי חוסרים (backfill). הערך הוא
true
אם המודעה הייתה מילוי חוסרים (backfill). אחרת,false
. -
isEmpty
-
isEmpty: boolean
-
האם הוחזרה מודעה עבור מיקום המודעה. אם לא הוחזרה מודעה, הערך הוא
true
. אחרת, הערך הואfalse
. -
labelIds
-
labelIds: null | number[]
-
מזהי התוויות של המודעה שעברה עיבוד. הערך הוא
null
עבור מיקומים ריקים, מודעות מילוי חוסרים וקריאייטיבים שעובדו על ידי שירותים שאינםPubAdsService
. -
lineItemId
-
lineItemId: null | number
-
מזהה הפריט של המודעה בהזמנה שעברה עיבוד. הערך הוא
null
עבור מיקומים ריקים, מודעות מילוי חוסרים וקריאייטיבים שעובדו על ידי שירותים שאינםPubAdsService
. -
size
-
size: null | string | number[]
-
מציין את גודל הפיקסל של הקריאייטיב לאחר עיבוד. דוגמה:
[728, 90]
הערך הואnull
למיקומי מודעות ריקים. -
slotContentChanged
-
slotContentChanged: boolean
-
האם התוכן של מיקום המודעה השתנה עם המודעה המעובדת. הערך הוא
true
אם התוכן השתנה. אחרת,false
. -
sourceAgnosticCreativeId
-
sourceAgnosticCreativeId: null | number
-
מזהה הקריאייטיב של מודעת ההזמנה או המודעה למילוי חוסרים (backfill). הערך הוא
null
אם המודעה אינה הזמנה או מילוי חוזר של פריט, או אם הקריאייטיב מעובד על ידי שירותים שאינםPubAdsService
. -
sourceAgnosticLineItemId
-
sourceAgnosticLineItemId: null | number
-
מזהה הפריט של מודעת ההזמנה המעובדת או המודעה למילוי חוסרים (backfill). הערך הוא
null
אם המודעה אינה הזמנה או מילוי חוזר של פריט, או אם הקריאייטיב מעובד על ידי שירותים שאינםPubAdsService
. -
yieldGroupIds
-
yieldGroupIds: null | number[]
-
מזהים של קבוצות תפוקה למודעת המילוי החוזר המעובדת. הערך הוא
null
עבור מיקומים ריקים, מודעות בהזמנה ונכסי קריאייטיב שעובדו על ידי שירותים שאינםPubAdsService
. -
googletag.events.SlotRequestedEvent
הרחבה
האירוע הזה מופעל כשנשלחת בקשה להצגת מודעה במיקום מודעה מסוים.
סיכום נכס | |
---|---|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
- דוגמה
-
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
googletag.events.SlotResponseReceived
הרחבה
האירוע הזה מופעל כשמתקבלת תגובה למודעה במיקום מודעה מסוים.
סיכום נכס | |
---|---|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
- דוגמה
-
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
googletag.events.SlotVisibilityChangedEvent
הרחבה
האירוע הזה מופעל בכל פעם שאחוז התוכן במסך של מיקום מודעה משתנה. האירוע מווסת ולא יופעל בתדירות גבוהה יותר מפעם ב-200 אלפיות השנייה.
סיכום נכס | |
---|---|
inViewPercentage
|
אחוז השטח הגלוי של המודעה.
|
serviceName
|
שם השירות שהפעיל את האירוע.
הועברה בירושה מ-
|
slot
|
המשבצת שהפעילה את האירוע.
הועברה בירושה מ-
|
- דוגמה
-
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (מדור קודם)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- כדאי לעיין גם בפרטים הבאים
inViewPercentage
-
inViewPercentage: number
-
אחוז השטח הגלוי של המודעה. הערך הוא מספר בין 0 ל-100.
-
googletag.secureSignals.BidderSignalProvider
הפונקציה מחזירה אות מאובטח למגיש הצעות מחיר ספציפי.
ספק אותות מאובטחים של מגיש הצעות המחיר מורכב מ-2 חלקים:
- פונקציית אספנות, שמחזירה
Promise
שמקבלת אות מאובטח. id
, שמזהה את מגיש הצעות המחיר שמשויך לאות.
secureSignals.PublisherSignalProvider
.
סיכום נכס | |
---|---|
collectorFunction
|
.
|
id
|
מזהה ייחודי של אספן המשויך לאות המאובטח הזה, כפי שרשום ב-Google Ad Manager.
|
- דוגמה
-
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (מדור קודם)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- כדאי לעיין גם בפרטים הבאים
collectorFunction
-
collectorFunction: () => Promise<string>
-
id
-
id: string
-
מזהה ייחודי של אספן המשויך לאות המאובטח הזה, כפי שרשום ב-Google Ad Manager.
-
googletag.secureSignals.PublisherSignalProvider
הפונקציה מחזירה אות מאובטח לבעל תוכן דיגיטלי ספציפי.
ספק אותות של בעלי תוכן דיגיטלי מורכב מ-2 חלקים:
- פונקציית אספנות, שמחזירה
Promise
שמקבלת אות מאובטח. networkCode
, שמזהה את בעל התוכן הדיגיטלי המשויך לאות.
secureSignals.BidderSignalProvider
.
סיכום נכס | |
---|---|
collectorFunction
|
.
|
networkCode
|
קוד הרשת (כפי שמופיע בנתיב יחידת המודעות) של בעל האתר שמשויך לאות המאובטח הזה.
|
- דוגמה
-
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (מדור קודם)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- כדאי לעיין גם בפרטים הבאים
collectorFunction
-
collectorFunction: () => Promise<string>
-
networkCode
-
networkCode: string
-
קוד הרשת (כפי שמופיע בנתיב יחידת המודעות) של בעל האתר שמשויך לאות המאובטח הזה.
-
googletag.secureSignals.SecureSignalProvidersArray
ממשק לניהול אותות מאובטחים.
סיכום שיטה | |
---|---|
clearAllCache
|
ניקוי כל האותות שנשמרו במטמון מהאחסון המקומי.
|
push
|
הוספת
secureSignals.SecureSignalProvider חדש למערך של ספק האותות והתחלת תהליך יצירת האות.
|
clearAllCache
-
clearAllCache(): void
-
ניקוי כל האותות שנשמרו במטמון מהאחסון המקומי.
-
push
-
push(provider: SecureSignalProvider): void
-
הוספת
secureSignals.SecureSignalProvider
חדש למערך של ספק האותות והתחלת תהליך יצירת האות. -
-
פרמטרים provider: SecureSignalProvider
האובייקטsecureSignals.SecureSignalProvider
שיתווסף למערך.