במסמך העזרה הזה נעשה שימוש בסימון של TypeScript כדי לתאר סוגים. בטבלה הבאה מוסבר בקצרה באמצעות דוגמאות.
הקלדה של ביטוי | |
---|---|
string |
סוג המחרוזת הפרימיטיבית. |
string[] |
סוג מערך, שבו הערכים יכולים להיות רק מחרוזות. |
number | string |
סוג איחוד, שבו הערך יכול להיות מספר או מחרוזת. |
Array<number | string> |
סוג מערך שבו הערכים הם מסוג מורכב (איחוד). |
[number, string] |
סוג קבוצת ערכים (tuple), שבו הערך הוא מערך של שני רכיבים שחייב להכיל מספר ומחרוזת בסדר הזה. |
Slot |
סוג אובייקט, שבו הערך הוא מופע של googletag.Slot . |
() => void |
סוג פונקציה ללא ארגומנטים מוגדרים וללא ערך מוחזר. |
למידע נוסף על הסוגים וביטויי הסוגים הנתמכים, אפשר לעיין ב מדריך של TypeScript .
אנוטציות של טיפוסים
נקודתיים אחרי משתנה, שם פרמטר, שם מאפיין או חתימת פונקציה מציינים הערה מסוג. הערות לגבי סוגים מתארות את הסוגים שהרכיב שמשמאל לנקודתיים יכול לקבל או להחזיר. בטבלה הבאה מוצגות דוגמאות של סוגים של הערות שעשויות להופיע בהפניה הזו.
הערה לגבי סוג | |
---|---|
param: string |
מציין ש-param מקבל או מחזיר ערך מחרוזת. התחביר הזה משמש למשתנים, לפרממטרים, למאפיינים ולסוגי החזרים.
|
param?: number | string |
מציין ש-param הוא אופציונלי, אבל מקבל מספר או מחרוזת כשמציינים אותו. התחביר הזה משמש לפרממטרים ולמאפיינים.
|
...params: Array<() => void> |
מציין ש-params הוא
פרמטר מנוחה
שמקבל פונקציות. פרמטרים של Rest יכולים לקבל מספר בלתי מוגבל של ערכים מהסוג שצוין.
|
googletag
מרחבי שמות | |
---|---|
config | ממשק ההגדרות הראשי להגדרות ברמת הדף. |
enums | זהו מרחב השמות שבו נעשה שימוש ב-GPT לסוגים של enum. |
events | זהו מרחב השמות שבו GPT משתמש לאירועים. |
secure | זהו מרחב השמות שבו נעשה שימוש ב-GPT לניהול אותות מאובטחים. |
ממשקים | |
---|---|
Command | מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר. |
Companion | שירות מודעות נלוות. |
Privacy | אובייקט תצורה של הגדרות הפרטיות. |
Pub | שירות מודעות של בעלי תוכן דיגיטלי. |
Response | אובייקט שמייצג תגובה יחידה למודעה. |
Rewarded | אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת. |
Safe | אובייקט הגדרה של קונטיינרים של SafeFrame. |
Service | סוג שירות בסיסי שמכיל שיטות שקיימות בכל השירותים. |
Size | ה-builder של אובייקטים של מפרטי מיפוי גדלים. |
Slot | משבצת היא אובייקט שמייצג משבצת מודעה אחת בדף. |
כינויים מסוג טקסט | |
---|---|
General | הגדרת גודל תקינה של חריץ, שיכולה להיות גודל אחד או כמה גדלים. |
Multi | רשימה של גדלים חוקיים בודדים. |
Named | גדלים מוגדרים שיכולים להיות למק"ט. |
Single | גודל חוקי אחד למשבצת. |
Single | מערך של שני מספרים שמייצגים את [width, height]. |
Size | מיפוי של גודל אזור התצוגה לגדלי מודעות. |
Size | רשימה של מיפויים של גדלים. |
משתנים | |
---|---|
api | סימון שמציין ש-GPT API טעון ומוכן לקריאה |
cmd | הפניה לתור הפקודות הגלובלי לביצוע קריאות שקשורות ל-GPT באופן אסינכרוני. |
pubads | סימון שמציין ש-PubAdsService מופעל, נטען ופועל באופן מלא. |
secure | הפניה למערך של ספקי האותות המאובטחים. |
פונקציות | |
---|---|
companion | הפונקציה מחזירה הפניה ל-CompanionAdsService. |
define | יצירת מיקום מודעה מחוץ לדף לפי נתיב יחידת המודעות שצוין. |
define | היצירה של מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות, ושיוך המיקום למזהה של רכיב div בדף שיכיל את המודעה. |
destroy | הפונקציה משמידה את ה-slots שצוינו, ומסירה את כל האובייקטים וההפניות הקשורים ל-slots האלה מ-GPT. |
disable | משבית את Google Publisher Console. |
display | מורה לשירותי יחידות קיבולת (Slot) לעבד את יחידת הקיבולת (Slot). |
enable | הפעלת כל שירותי GPT שהוגדרו למיקומי מודעות בדף. |
get | הפונקציה מחזירה את הגרסה הנוכחית של GPT. |
open | פותח את מסוף Google Publisher. |
pubads | הפונקציה מחזירה הפניה ל-PubAdsService. |
set | הגדרת הכותרת לכל תגי iframe של מאגרי מודעות שנוצרו על ידי PubAdsService, החל מהרגע הזה ואילך. |
set | מגדיר אפשרויות תצורה כלליות של הדף. |
size | יצירת SizeMappingBuilder חדש. |
סוג כינויים
GeneralSize
GeneralSize: SingleSize | MultiSize
הגדרת גודל תקינה של חריץ, שיכולה להיות גודל אחד או כמה גדלים.
MultiSize
MultiSize: SingleSize[]
רשימה של גדלים חוקיים בודדים.
NamedSize
- fluid: מאגר המודעות תופס 100% מהרוחב של div ההורה, ולאחר מכן משתנה הגובה שלו כך שיתאים לתוכן הקריאייטיב. בדומה לאופן הפעולה של רכיבי בלוק רגילים בדף. משמש למודעות מותאמות (יש לעיין במאמר הקשור). שימו לב שאפשר להשתמש גם ב-
fluid
וגם ב-['fluid']
כדי להצהיר על גודל רצף מודעות כגודל גמיש.
NamedSize: "fluid" | ["fluid"]
גדלים מוגדרים שיכולים להיות למק"ט. ברוב המקרים, הגודל הוא מלבן בגודל קבוע, אבל יש מקרים שבהם אנחנו זקוקים למפרטי גודל מסוגים אחרים. רק הגדלים הבאים עם שם תקינים:
SingleSize
SingleSize: SingleSizeArray | NamedSize
גודל חוקי אחד למשבצת.
SingleSizeArray
SingleSizeArray: [number, number]
מערך של שני מספרים שמייצגים את [width, height].
SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]
מיפוי של גודל אזור התצוגה לגדלי מודעות. משמש למודעות רספונסיביות.
SizeMappingArray
SizeMappingArray: SizeMapping[]
רשימה של מיפויי גדלים.
משתנים
Const
apiReady
apiReady: boolean | undefined
דגל שמציין ש-GPT API נטען ומוכן לקריאה. הערך של המאפיין הזה יהיה פשוט undefined
עד שה-API יהיה מוכן.
הערה: הדרך המומלצת לטיפול באירועים אסינכרונים היא להשתמש ב-googletag.cmd כדי להוסיף לתור קריאות חזרה (callbacks) שיופעלו כש-GPT יהיה מוכן. אין צורך לבדוק את googletag.apiReady בקריאות החזרה האלה, כי מובטח שהן יבוצעו אחרי שה-API יוגדר.
Const
cmd
- דוגמה
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()); });
cmd: ((this: typeof globalThis) => void)[] | CommandArray
הפניה לתור הפקודות הגלובלי לביצוע אסינכרוני של קריאות שקשורות ל-GPT.
הערך של המשתנה googletag.cmd
מוגדר לתחילת מערך JavaScript ריק על ידי התחביר של תג ה-GPT בדף, ו-cmd.push
היא השיטה הרגילה של Array.push
שמוסיפה רכיב לסוף המערך. כשקובץ ה-JavaScript של GPT נטען, הוא בודק את המערך ומריץ את כל הפונקציות לפי הסדר. לאחר מכן הסקריפט מחליף את cmd
באובייקט CommandArray ששיטת הדחיפה שלו מוגדרת לביצוע הארגומנט של הפונקציה שמועבר אליו. המנגנון הזה מאפשר ל-GPT לצמצם את זמן האחזור המשוער על ידי אחזור ה-JavaScript באופן אסינכרוני, תוך מתן אפשרות לדפדפן להמשיך את העיבוד של הדף.
Const
pubadsReady
pubadsReady: boolean | undefined
סימון שמציין ש-PubAdsService מופעל, נטען ופועל באופן מלא. הערך של המאפיין הזה יהיה פשוט undefined
עד שיקראו ל-enableServices ו-PubAdsService ייטען ויאופס.
secureSignalProviders
- דוגמה
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"); }, });
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
הפניה למערך של ספקי האותות המאובטחים.
מערך ספקי האותות המאובטחים מקבל רצף של פונקציות ליצירת אותות ומפעיל אותן לפי הסדר. הוא מיועד להחליף מערך סטנדרטי שמשמש להכנסת פונקציות ליצירת אותות לתור להפעלת פונקציות אחרי טעינת ה-GPT.
פונקציות
companionAds
companionAds(): CompanionAdsService
הפונקציה מחזירה הפניה אל CompanionAdsService.
החזרות | |
---|---|
CompanionAdsService | שירות המודעות הנלווים. |
defineOutOfPageSlot
- דוגמה
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);
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
יוצר מיקום מודעה מחוץ לדף עם הנתיב הנתון של יחידת המודעות.
למודעות בהתאמה אישית מחוץ לדף, div
הוא המזהה של רכיב ה-div שיכיל את המודעה. לפרטים נוספים, אפשר לעיין במאמר בנושא קריאייטיבים מחוץ לדף.
למודעות שמנוהלות מחוץ לדף באמצעות GPT, div
הוא פורמט נתמך של OutOfPageFormat.
פרמטרים | |
---|---|
adUnitPath: string | נתיב יחידת המודעות המלא, עם קוד הרשת וקוד יחידת המודעות. |
| המזהה של ה-div שיכיל את יחידת המודעות הזו או את OutOfPageFormat. |
החזרות | |
---|---|
Slot | null | המשבצת החדשה שנוצרה, או null אם לא ניתן ליצור משבצת. |
defineSlot
- דוגמה
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");
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
היצירה של מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות, ושיוך המיקום למזהה של רכיב div בדף שיכיל את המודעה.
פרמטרים | |
---|---|
adUnitPath: string | נתיב יחידת המודעות המלא, עם קוד הרשת וקוד היחידה. |
size: GeneralSize | הרוחב והגובה של המיקום שנוסף. זהו הגודל שבו נעשה שימוש בבקשה להצגת מודעה אם לא סופק מיפוי של גדלים רספונסיביים או אם גודל שדה התצוגה קטן מהגודל הקטן ביותר שסופק במיפוי. |
| המזהה של ה-div שתכיל את יחידת המודעות הזו. |
החזרות | |
---|---|
Slot | null | משבצת הזמן החדשה שנוצרה, או null אם אי אפשר ליצור משבצת זמן. |
destroySlots
- דוגמה
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();
destroySlots(slots?: Slot[]): boolean
הדבר משמיד את מיקומי המשבצות הנתונים, על ידי הסרת כל האובייקטים הקשורים וההפניות של המשבצות האלה מ-GPT. ה-API הזה לא תומך במשבצות passback או במשבצות נלוות.
ביצוע קריאה ל-API הזה במיקום מנקה את המודעה ומסיר את אובייקט המיקום מהמצב הפנימי שמתוחזק על ידי GPT. קריאה של פונקציות נוספות באובייקט החריץ תוביל להתנהגות לא מוגדרת. שימו לב: יכול להיות שהדפדפן עדיין לא ישחרר את הזיכרון שמשויך למשבצת הזו אם דף בעל התוכן הדיגיטלי שומר על הפניה אליה. קריאה ל-API הזה הופכת את ה-div שמשויך למיקום המודעה לזמין לשימוש חוזר.
במיוחד, השמדת מיקום מודעה מסירה את המודעה מהצגת הדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות תחרותיות שכוללות את המודעה הזו. אם לא תבצעו קריאה לפונקציה הזו לפני הסרת ה-div של חריץ מהדף, התוצאה תהיה התנהגות לא מוגדרת.
פרמטרים | |
---|---|
| מערך השקעים שרוצים למחוק. מערך הוא אופציונלי. אם לא יצוין מערך, כל המקומות יושמדו. |
החזרות | |
---|---|
boolean | true אם ה-slots הושמדו, false אחרת. |
disablePublisherConsole
display
display(divOrSlot: string | Element | Slot): void
נותן הוראה לשירותי יצירת המודעות להציג את המודעות במודעה הווירטואלית. יש להציג כל מיקום מודעה פעם אחת בלבד בכל דף. כל התקנים חייבים להיות מוגדרים, ולכל אחד מהם צריך להיות שירות משויך לפני שהוא יוצג. אסור שהקריאה להצגה תתבצע עד שהאלמנט יופיע ב-DOM. הדרך הרגילה לעשות זאת היא להציב אותו בתוך בלוק סקריפט בתוך רכיב ה-div ששמו מופיע בקריאה ל-method.
אם משתמשים בארכיטקטורה של בקשה יחידה (SRA), כל משבצות המודעות שלא אוחזו בזמן הקריאה ל-method הזה יאוחזו בבת אחת. כדי לאלץ משבצת מודעה לא להופיע, יש להסיר את ה-div כולו.
פרמטרים | |
---|---|
divOrSlot: string | Element | Slot | המזהה של אלמנט ה-div שמכיל את מקום המודעה, או אלמנט ה-div, או אובייקט ה-slot. אם מספקים רכיב div, הוא חייב לכלול את המאפיין 'id' שתואם למזהה שנשלח אל defineSlot. |
enableServices
getVersion
openConsole
- דוגמה
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();
- ראה גם
openConsole(div?: string): void
פותח את מסוף Google Publisher.
פרמטרים | |
---|---|
| מזהה div של מיקום מודעה. הערך הזה הוא אופציונלי. אם תספקו את הפרטים, מערכת Publisher Console תנסה לפתוח את הדף עם הפרטים של מיקום המודעה שציינתם. |
pubads
pubads(): PubAdsService
הפונקציה מחזירה הפניה ל-PubAdsService.
החזרות | |
---|---|
PubAdsService | השירות 'מודעות בתכנים של בעלי תוכן דיגיטלי'. |
setAdIframeTitle
- דוגמה
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (קודם)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
setAdIframeTitle(title: string): void
הגדרת הכותרת לכל תגי iframe של מאגרי מודעות שנוצרו על ידי PubAdsService, החל מהרגע הזה ואילך.
פרמטרים | |
---|---|
title: string | הכותרת החדשה לכל תגי iframe של מאגרי מודעות. |
setConfig
setConfig(config: PageSettingsConfig): void
הגדרת אפשרויות תצורה כלליות לדף.
פרמטרים | |
---|---|
config: PageSettingsConfig |
sizeMapping
sizeMapping(): SizeMappingBuilder
יוצרת SizeMappingBuilder חדש.
החזרות | |
---|---|
SizeMappingBuilder | גרסת build חדשה. |
googletag.CommandArray
שיטות | |
---|---|
push | הפונקציה מבצעת את רצף הפונקציות שצוינו בארגומנטים לפי הסדר. |
שיטות
push
- דוגמה
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()); });
push(...f: ((this: typeof globalThis) => void)[]): number
הפונקציה מבצעת את רצף הפונקציות שצוינו בארגומנטים לפי הסדר.
פרמטרים | |
---|---|
| פונקציית JavaScript שצריך להריץ. הקישור בסביבת זמן הריצה תמיד יהיה globalThis . מומלץ להעביר פונקציית חץ כדי לשמור את הערך של this בהקשר הלקסיקלי המקיף. |
החזרות | |
---|---|
number | מספר הפקודות שעובדו עד עכשיו. הערך הזה תואם לערך המוחזר של Array.push (האורך הנוכחי של המערך). |
googletag.CompanionAdsService
הארכהשיטות | |
---|---|
add | הרשמה של מאזין שמאפשר להגדיר פונקציית JavaScript ולקרוא לה כשאירוע GPT ספציפי מתרחש בדף. הועברה בירושה מ- |
get | הצגת רשימת המקומות שמשויכים לשירות הזה. הועברה בירושה מ- |
remove | הסרת מעבד אירועים שרשום בעבר. הועברה בירושה מ- |
set | ההגדרה קובעת אם מודעות נלוויות שלא מולאו יאוכלסו באופן אוטומטי. |
שיטות
setRefreshUnfilledSlots
- דוגמה
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (קודם)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
setRefreshUnfilledSlots(value: boolean): void
קובע אם מודעות נלוויות שלא מולאו יאוכלסו באופן אוטומטי.
אפשר להפעיל ולכבות את המילוי האוטומטי של מודעות נלוויות כמה פעמים במהלך חיי הדף. רק מודעות נלוויות שרשומים גם ב-PubAdsService יאוכלסו באופן אוטומטי. עקב הגבלות מדיניות, השיטה הזו לא מיועדת למילוי משבצות של מודעות נלווה ריקות כשמוצג סרטון של Ad Exchange.
פרמטרים | |
---|---|
value: boolean | true כדי למלא באופן אוטומטי משבצות שלא מולאו, false כדי להשאיר אותן ללא שינוי. |
googletag.PrivacySettingsConfig
מאפיינים | |
---|---|
child | מציין אם הדף צריך להיחשב כתוכן שמיועד לילדים. |
limited | מאפשרת להציג מודעות במצב מודעות מוגבלות כדי לעזור לבעלי התוכן הדיגיטלי לעמוד בדרישות הרגולטוריות. |
non | מאפשרת להציג מודעות במצב מודעות ללא התאמה אישית כדי לעזור לבעלי התוכן הדיגיטלי לציית לתקנות. |
restrict | מאפשרת להציג מודעות במצב עיבוד מוגבל כדי לעזור לבעלי תוכן דיגיטלי לציית לתקנות. |
traffic | מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית. |
under | הערך הזה מציין אם לסמן בקשות להצגת מודעות כבקשות שמגיעות ממשתמשים מתחת לגיל ההסכמה. |
- ראה גם
מאפיינים
Optional
childDirectedTreatment
childDirectedTreatment?: null | boolean
מציין אם הדף צריך להיחשב כתוכן שמיועד לילדים. מגדירים את הערך null
כדי למחוק את ההגדרה.
Optional
limitedAds
- באופן אוטומטי, באמצעות אות מפלטפורמה לניהול הסכמה של TCF בגרסה 2.0 של IAB.
- באופן ידני, על ידי הגדרת הערך של השדה הזה כ-
true
. - דוגמה
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (קודם)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- ראה גם
limitedAds?: boolean
מאפשרת להציג מודעות במצב מודעות מוגבלות כדי לעזור לבעלי התוכן הדיגיטלי לעמוד בדרישות הרגולטוריות.
אפשר להורות ל-GPT לבקש מודעות מוגבלות בשתי דרכים:
לתשומת ליבכם: אין צורך להפעיל מודעות מוגבלות באופן ידני כשפלטפורמת CMP נמצאת בשימוש.
Optional
nonPersonalizedAds
nonPersonalizedAds?: boolean
מאפשרת להפעיל את הצגת המודעות במצב מודעות ללא התאמה אישית כדי לעזור לבעלי האפליקציות לעמוד בדרישות הרגולטוריות.
Optional
restrictDataProcessing
restrictDataProcessing?: boolean
מאפשרת להפעיל את הצגת המודעות במצב עיבוד מוגבל כדי לעזור לבעלי התוכן הדיגיטלי לעמוד בדרישות הרגולטוריות.
Optional
trafficSource
- דוגמה
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, });
trafficSource?: TrafficSource
מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית. הערך הזה מאכלס את המאפיין מקור תנועה בדוחות של Ad Manager. אם לא מגדירים את המאפיין, ברירת המחדל של מקור התנועה בדיווח היא undefined
.
Optional
underAgeOfConsent
underAgeOfConsent?: null | boolean
הערך הזה מציין אם לסמן בקשות להצגת מודעות כבקשות שמגיעות ממשתמשים מתחת לגיל ההסכמה. מגדירים את הערך null
כדי למחוק את ההגדרה.
googletag.PubAdsService
הארכהשיטות | |
---|---|
add | הרשמה של מאזין שמאפשר להגדיר פונקציית JavaScript ולקרוא לה כשאירוע GPT ספציפי מתרחש בדף. הועברה בירושה מ- |
clear | הסרת המודעות מהמשבצות הנתונות והחלפתן בתוכן ריק. |
clear | מחיקת כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. |
clear | מחיקת פרמטרים של טירגוט מותאם אישית למפתח ספציפי או לכל המפתחות. |
collapse | מאפשרת לכווץ את התשובות של מיקומי המודעות כך שלא יתפסו מקום כלשהו בדף כשאין תוכן של מודעה להצגה. |
disable | ההגדרה משביתה בקשות להצגת מודעות במהלך טעינת הדף, אבל מאפשרת לבקש הצגת מודעות באמצעות קריאה ל-PubAdsService.refresh. |
display | יצירת מקום מודעה והצגתו עם הנתיב והגודל של יחידת המודעות שצוינו. |
enable | הפעלת טעינה איטית ב-GPT כפי שמוגדרת באובייקט התצורה. |
enable | הפעלת מצב בקשה יחידה לאחזור מספר מודעות בו-זמנית. |
enable | האותות מסמנים ל-GPT שמודעות וידאו יופיעו בדף. |
get | הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון. |
get | הפונקציה מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה. |
get | לקבל את רשימת המשבצות שמשויכות לשירות הזה. הועברה בירושה מ- |
get | הפונקציה מחזירה פרמטר טירגוט מותאם אישית ספציפי ברמת השירות שהוגדר. |
get | הפונקציה מחזירה רשימה של כל מפתחות הטירגוט בהתאמה אישית ברמת השירות שהוגדרו. |
is | הפונקציה מחזירה את הערך 'true' אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad, או את הערך 'false' אם לא. |
refresh | אחזור והצגה של מודעות חדשות עבור מיקומי מודעות ספציפיים או עבור כל המיקומים בדף. |
remove | הסרת מעבד אירועים שרשום בעבר. הועברה בירושה מ- |
set | מגדיר ערכים למאפייני AdSense שיחולו על כל מיקומי המודעות בשירות המודעות לבעלי תוכן דיגיטלי. |
set | הגדרת החרגה של קטגוריית מודעות ברמת הדף עבור שם התווית הנתון. |
set | הפעלה והשבתה של מרכוז אופקי של מודעות. |
set | ההגדרה קובעת אם כל המודעות בדף ייאלצו לעבור עיבוד באמצעות מאגר SafeFrame. |
set | העברת פרטי מיקום מאתרים כדי שתוכלו לטרגט פריטים למיקומים ספציפיים. |
set | מאפשרת לקבוע את כל הגדרות הפרטיות מ-API אחד באמצעות אובייקט config. |
set | הגדרת הערך של המזהה שסופק על ידי בעל התוכן הדיגיטלי. |
set | מגדיר את ההעדפות ברמת הדף להגדרת SafeFrame. |
set | הגדרת פרמטרים מותאמים אישית של טירגוט למפתח נתון שחלים על כל שטחי הפרסום בשירות Publisher Ads. |
set | ההגדרה קובעת איזה מידע על תוכן הווידאו יישלח יחד עם בקשות להצגת מודעות, למטרות טירגוט והחרגת תוכן. |
update | שינוי המתאמים שנשלחים עם בקשות להצגת מודעות, וכתוצאה מכך התחלת צפייה חדשה בדף. |
שיטות
clear
- דוגמה
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();
clear(slots?: Slot[]): boolean
הסרת המודעות מהמשבצות הנתונות והחלפתן בתוכן ריק. מיקומי המודעות בדף יסומנו ככאלה שלא נשלפו.
באופן ספציפי, מחיקת מיקום מודעה מסירה את המודעה מצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו ממכשולים או מהחרגות תחרותיות שקשורות למודעה הזו.
פרמטרים | |
---|---|
| מערך המשבצות שצריך לנקות. מערך הוא אופציונלי. אם לא מציינים מערך, כל המקומות יימחקו. |
החזרות | |
---|---|
boolean | הפונקציה מחזירה את הערך true אם החריצים נמחקו, ואת הערך false אם לא. |
clearCategoryExclusions
- דוגמה
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.
clearCategoryExclusions(): PubAdsService
מחיקת כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. האפשרות הזו שימושית אם רוצים לרענן את המיקום.
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעל ה-method. |
clearTargeting
- דוגמה
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.
- ראה גם
clearTargeting(key?: string): PubAdsService
מחיקת פרמטרים של טירגוט מותאם אישית למפתח ספציפי או לכל המפתחות.
פרמטרים | |
---|---|
| מפתח פרמטר של טירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל פרמטרי הטירגוט יימחקו. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעל ה-method. |
collapseEmptyDivs
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
מאפשרת לכווץ divs של משבצות כדי שהן לא יתפסו מקום בדף כשאין תוכן של מודעות להצגה. צריך להגדיר את המצב הזה לפני הפעלת השירות.
פרמטרים | |
---|---|
| האם לכווץ את המיקומים עוד לפני אחזור המודעות. הפרמטר הזה הוא אופציונלי. אם לא מציינים אותו, הערך false ישמש כערך ברירת המחדל. |
החזרות | |
---|---|
boolean | הפונקציה מחזירה את הערך true אם מצב הכיווץ של div הופעל, ואת הערך false אם אי אפשר להפעיל את מצב הכיווץ כי השיטה הוזמנה אחרי שהשירות הופעל. |
disableInitialLoad
disableInitialLoad(): void
ההגדרה משביתה בקשות להצגת מודעות במהלך טעינת הדף, אבל מאפשרת לבקש הצגת מודעות באמצעות קריאה ל-PubAdsService.refresh. צריך להגדיר את זה לפני הפעלת השירות. חובה להשתמש במצב אסינכרוני. אחרת לא תהיה אפשרות לבקש מודעות באמצעות 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");
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
בונה ומציג מיקום מודעה עם הנתיב והגודל הנתונים של יחידת המודעות. השיטה הזו לא פועלת במצב של בקשה יחידה.
הערה: כשקוראים לשיטה הזו, נוצרת קובץ snapshot של המצב של השקע והדף כדי להבטיח עקביות בשליחת הבקשה להצגת מודעה ובעיבוד התגובה. שינויים שיתבצעו במצב של המיקום או הדף אחרי הקריאה ל-method הזה (כולל טירגוט, הגדרות פרטיות, אילוץ SafeFrame וכו') יחולו רק על בקשות display()
או refresh()
הבאות.
פרמטרים | |
---|---|
adUnitPath: string | נתיב יחידת המודעות של המיקום שרוצים להציג בו מודעה. |
size: GeneralSize | הרוחב והגובה של החריץ. |
| המזהה של ה-div שמכיל את ה-slot או רכיב ה-div עצמו. |
| כתובת ה-URL של הקליק שתשמש במקום הזה. |
enableLazyLoad
- דוגמה
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, });
fetchMarginPercent
המרחק המינימלי מהאזור הנוכחי של התצוגה שצריך להיות למיקום של מודעה לפני שאנחנו מאחזרים את המודעה, כאחוז מגודל אזור התצוגה. ערך של 0 פירושו 'כשהמשבצת נכנסת לתחום התצוגה', ערך של 100 פירושו 'כשהמודעה נמצאת במרחק 1 שטח תצוגה' וכן הלאה.renderMarginPercent
המרחק המינימלי מאזור התצוגה הנוכחי של משבצת חייב להיות לפני שנוכל להציג מודעה. כך אפשר לבצע אחסון מראש של המודעה, אבל להמתין לעיבוד ולהורדה של משאבי משנה אחרים. הערך פועל בדיוק כמוfetchMarginPercent
כאחוז מאזור התצוגה.mobileScaling
מכפיל שמוחל על השוליים במכשירים ניידים. כך אפשר להגדיר שוליים שונים בניידים ובמחשבים. לדוגמה, ערך של 2.0 יגרום להכפלת כל השוליים פי 2 במכשירים ניידים, וכך יגדל המרחק המינימלי שיכול להיות בין חריץ לבין אחזור והצגה (רינדור).
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): void
הפעלת טעינה מדורגת ב-GPT בהתאם להגדרה באובייקט config. דוגמאות מפורטות יותר זמינות בדוגמה של טעינה איטית.
הערה: אחזור איטי ב-SRA פועל רק אם כל הפריטים מחוץ למרווח האחזור.
פרמטרים | |
---|---|
| אובייקט התצורה מאפשר להתאים אישית את ההתנהגות העצלנית. בהגדרות שהושמטו, ייעשה שימוש בהגדרת ברירת מחדל שהוגדרה על ידי Google ותותאם עם הזמן. כדי להשבית הגדרה מסוימת, כמו שולי אחזור, מגדירים את הערך כ--1 . |
enableSingleRequest
enableSingleRequest(): boolean
הפעלת מצב בקשה יחידה לאחזור כמה מודעות בו-זמנית. לשם כך, צריך להגדיר את כל שטחי הפרסום של Publisher Ads ולהוסיף אותם ל-PubAdsService לפני הפעלת השירות. צריך להגדיר את מצב הבקשה היחידה לפני הפעלת השירות.
החזרות | |
---|---|
boolean | הפונקציה מחזירה את הערך true אם מצב הבקשה היחידה הופעל, ואת הערך false אם אי אפשר להפעיל את מצב הבקשה היחידה כי השיטה הוזמנה אחרי שהשירות הופעל. |
enableVideoAds
enableVideoAds(): void
האותות מסמנים ל-GPT שמודעות וידאו יופיעו בדף. כך ניתן להחיל מגבלות של החרגה תחרותית על מודעות לרשת המדיה ועל מודעות וידאו. אם תוכן הסרטון ידוע, צריך להפעיל את PubAdsService.setVideoContent כדי שתוכלו להשתמש בהחרגת תוכן במודעות לרשת המדיה.
get
- דוגמה
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'.
- ראה גם
get(key: string): null | string
הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון.
פרמטרים | |
---|---|
key: string | שם המאפיין שרוצים לחפש. |
החזרות | |
---|---|
null | string | הערך הנוכחי של מפתח המאפיין או null אם המפתח לא קיים. |
getAttributeKeys
- דוגמה
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'].
getAttributeKeys(): string[]
הפונקציה מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
החזרות | |
---|---|
string[] | מערך של מפתחות מאפיינים שהוגדרו בשירות הזה. הסדר לא מוגדר. |
getTargeting
- דוגמה
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).
getTargeting(key: string): string[]
הפונקציה מחזירה פרמטר טירגוט ספציפי מותאם אישית ברמת השירות, שהוגדר.
פרמטרים | |
---|---|
key: string | מפתח הטירגוט שרוצים לחפש. |
החזרות | |
---|---|
string[] | הערכים המשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה. |
getTargetingKeys
- דוגמה
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'].
getTargetingKeys(): string[]
הפונקציה מחזירה רשימה של כל מפתחות הטירגוט בהתאמה אישית ברמת השירות שהוגדרו.
החזרות | |
---|---|
string[] | מערך של מפתחות טירגוט. הסדר לא מוגדר. |
isInitialLoadDisabled
isInitialLoadDisabled(): boolean
הפונקציה מחזירה את הערך 'true' אם הבקשות הראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad, או את הערך 'false' אם לא.
החזרות | |
---|---|
boolean | הפונקציה מחזירה את הערך true אם הקריאה הקודמת ל-PubAdsService.disableInitialLoad בוצעה בהצלחה. אחרת, false . |
רענון
- דוגמה
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 });
changeCorrelator
קובע אם צריך ליצור מתאם חדש לאחזור מודעות. שרתי המודעות שלנו שומרים את ערך המתאמים הזה לזמן קצר (כרגע למשך 30 שניות, אבל זה עשוי להשתנות), כך שבקשות עם אותו מתאם שיישלחו בזמן קצר זו לזו ייחשבו כצפייה בדף יחיד. כברירת מחדל נוצר מתאם חדש לכל רענון.
הערה: לאפשרות הזו אין השפעה על צפייה ארוכת טווח בדף ב-GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות כרגע בדף ואין לה תאריך תפוגה.
refresh(slots?: null | Slot[], options?: {
changeCorrelator: boolean;
}): void
אחזור והצגה של מודעות חדשות עבור מיקומי מודעות ספציפיים או עבור כל המיקומים בדף. הפונקציה פועלת רק במצב עיבוד נתונים אסינכרוני.
כדי שההתנהגות תהיה תקינה בכל הדפדפנים, לפני הקריאה ל-refresh
צריכה להתבצע קריאה ל-display
של מקום המודעה. אם משמיטים את הקריאה ל-display
, יכול להיות שהרענון יתנהג בצורה לא צפויה. אם רוצים, אפשר להשתמש בשיטה PubAdsService.disableInitialLoad כדי למנוע מ-display
לאחזר מודעה.
רענון של מיקום מודעה מסיר את המודעה הישנה מהצגת הדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות תחרותיות שקשורות למודעה הזו.
פרמטרים | |
---|---|
| חריצי המודעות שרוצים לרענן. מערך הוא אופציונלי. אם לא יצוין מערך, כל המקומות יתרעננו. |
| אפשרויות ההגדרה שמשויכות לקריאת הרענון הזו. |
set
- דוגמה
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (קודם)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- ראה גם
set(key: string, value: string): PubAdsService
הגדרת ערכים למאפייני AdSense שחלים על כל שטחי הפרסום בשירות 'מודעות של בעלי אפליקציות'.
קריאה ל-set יותר מפעם אחת לאותו מפתח תחליף את הערכים שהוגדרו קודם לכן למפתח הזה. צריך להגדיר את כל הערכים לפני שמפעילים את display
או את refresh
.
פרמטרים | |
---|---|
key: string | שם המאפיין. |
value: string | ערך מאפיין. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעל ה-method. |
setCategoryExclusion
- דוגמה
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (קודם)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
setCategoryExclusion(categoryExclusion: string): PubAdsService
הגדרת החרגה של קטגוריית מודעות ברמת הדף עבור שם התווית הנתון.
פרמטרים | |
---|---|
categoryExclusion: string | תווית ההחרגה של קטגוריית המודעות להוספה. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעל ה-method. |
setCentering
- דוגמה
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (קודם)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
setCentering(centerAds: boolean): void
הפעלה והשבתה של מרכוז אופקי של מודעות. כברירת מחדל, מירכוז מושבת. בגרסה הקודמת של gpt_mobile.js, מרכוז מופעל כברירת מחדל.
יש להפעיל את השיטה הזו לפני הקריאה ל-display
או refresh
, כי רק מודעות שנשלחה עבורן בקשה לאחר קריאה לשיטה הזו יעברו למרכז.
פרמטרים | |
---|---|
centerAds: boolean | true כדי למרכז את המודעות, false כדי ליישר אותן לשמאל. |
setForceSafeFrame
- ההגדרה הזו תיכנס לתוקף רק לגבי בקשות לאחריות להצגת מודעות שיוגשו עבור המשבצות הרלוונטיות.
- ההגדרה ברמת השקע, אם היא צוינה, תמיד תקבל קדימות על פני ההגדרה ברמת הדף.
- אם ההגדרה היא
true
(ברמת המיקום או ברמת הדף), המערכת תמיד תיצור את המודעה באמצעות מאגר SafeFrame, ללא קשר לבחירה שבוצעה בממשק המשתמש של Google Ad Manager. - עם זאת, אם הערך של הפרמטר מוגדר כ-
false
או לא צוין ערך, המערכת תיצור את המודעה באמצעות מאגר SafeFrame, בהתאם לסוג הקריאייטיב ולבחירה שבוצעה בממשק המשתמש של Google Ad Manager. - צריך להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של נכסי קריאייטיב שמנסים לפרוץ ממסגרות ה-iframe שלהם או להסתמך על הפיכת הנכסים האלה לגרפיקה ישירות בדף של בעל התוכן הדיגיטלי.
- דוגמה
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (קודם)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
ההגדרה קובעת אם כל המודעות בדף ייאלצו לעבור עיבוד באמצעות מאגר SafeFrame.
חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:
פרמטרים | |
---|---|
forceSafeFrame: boolean | true כדי לאלץ את המערכת ליצור עיבוד של כל המודעות בדף ב-SafeFrames, ו-false כדי לשנות את ההגדרה הקודמת ל-false. הגדרת הערך false כשלא צוין ערך קודם לכן לא תשנה דבר. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעלה הפונקציה. |
setLocation
- דוגמה
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (קודם)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
setLocation(address: string): PubAdsService
העברת פרטי מיקום מאתרים כדי שתוכלו לטרגט פריטים למיקומים ספציפיים.
פרמטרים | |
---|---|
address: string | כתובת בפורמט חופשי. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעל ה-method. |
setPrivacySettings
- דוגמה
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, });
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
מאפשרת להגדיר את כל הגדרות הפרטיות מ-API יחיד באמצעות אובייקט תצורה.
פרמטרים | |
---|---|
privacySettings: PrivacySettingsConfig | אובייקט שמכיל את ההגדרות של הגדרות הפרטיות. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעלה הפונקציה. |
setPublisherProvidedId
- דוגמה
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (קודם)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
setPublisherProvidedId(ppid: string): PubAdsService
הגדרת הערך של המזהה שסופק על ידי בעל התוכן הדיגיטלי.
פרמטרים | |
---|---|
ppid: string | מזהה אלפאנומרי שסופק על ידי בעל התוכן הדיגיטלי. חייב להכיל בין 32 ל-150 תווים. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שבו הופעלה ה-method. |
setSafeFrameConfig
- דוגמה
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");
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
הגדרת ההעדפות ברמת הדף להגדרת SafeFrame. המערכת תתעלם מכל מפתחות לא מזוהים באובייקט התצורה. אם יועבר ערך לא חוקי למפתח מזוהה, המערכת תתעלם מההגדרה כולה.
העדפות ברמת הדף יבוטלו על ידי ההעדפות ברמת המיקום, אם הן יצוינו.
פרמטרים | |
---|---|
config: SafeFrameConfig | אובייקט התצורה. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעל ה-method. |
setTargeting
- דוגמה
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"]);
- ראה גם
setTargeting(key: string, value: string | string[]): PubAdsService
מגדיר פרמטרים של טירגוט בהתאמה אישית למפתח נתון, שחלים על כל מיקומי המודעות בשירות מודעות של בעלי תוכן דיגיטלי. קריאה ל-setMultiple פעמים לאותו מפתח תגרום להחליף את הערכים הישנים. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
פרמטרים | |
---|---|
key: string | מפתח פרמטר של טירגוט. |
value: string | string[] | ערך פרמטר טירגוט או מערך ערכים. |
החזרות | |
---|---|
PubAdsService | אובייקט השירות שבו הופעלה ה-method. |
setVideoContent
setVideoContent(videoContentId: string, videoCmsId: string): void
ההגדרה קובעת איזה מידע על תוכן הווידאו יישלח יחד עם בקשות להצגת מודעות, למטרות טירגוט והחרגת תוכן. מודעות הווידאו יופעלו באופן אוטומטי כשהשיטה הזו תיקרא. בשדות videoContentId
ו-videoCmsId
, צריך להשתמש בערכים שסופקו לשירות הטמעת התוכן של Google Ad Manager.
פרמטרים | |
---|---|
videoContentId: string | מזהה התוכן של הסרטון |
videoCmsId: string | מזהה ה-CMS של הסרטון. |
updateCorrelator
- דוגמה
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.
updateCorrelator(): PubAdsService
שינוי המתאמים שנשלחים עם בקשות להצגת מודעות, וכתוצאה מכך התחלת צפייה חדשה בדף. המתאמים זהים לכל הבקשות להצגת מודעות שמגיעות מצפייה אחת בדף, והם ייחודיים לכל צפייה בדף. ההגדרה רלוונטית רק למצב אסינכרוני.
הערה: ההגדרה הזו לא משפיעה על צפייה ארוכת טווח בדף ב-GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות בפועל בדף ואין לה תאריך תפוגה.
החזרות | |
---|---|
PubAdsService | אובייקט השירות שאליו הופעלה הפונקציה. |
googletag.ResponseInformation
מאפיינים | |
---|---|
advertiser | המזהה של המפרסם. |
campaign | המזהה של הקמפיין. |
creative | המזהה של הקריאייטיב. |
creative | מזהה התבנית של המודעה. |
line | המזהה של הפריט. |
מאפיינים
advertiserId
advertiserId: null | number
המזהה של המפרסם.
campaignId
campaignId: null | number
המזהה של הקמפיין.
creativeId
creativeId: null | number
המזהה של הקריאייטיב.
creativeTemplateId
creativeTemplateId: null | number
מזהה התבנית של המודעה.
lineItemId
lineItemId: null | number
המזהה של הפריט.
googletag.RewardedPayload
מאפיינים | |
---|---|
amount | מספר הפריטים שכלולים בתגמול. |
type | סוג הפריט שכלול בתגמול (לדוגמה, 'coin'). |
- ראה גם
מאפיינים
amount
amount: number
מספר הפריטים שכלולים בתגמול.
type
type: string
סוג הפריט שכלול בתגמול (לדוגמה, 'coin').
googletag.SafeFrameConfig
מאפיינים | |
---|---|
allow | האם SafeFrame יאפשר לתוכן המודעה להתרחב על ידי שכבת-על של תוכן הדף. |
allow | האם SafeFrame יאפשר לתוכן המודעה להתרחב על ידי דחיפת תוכן הדף. |
sandbox | האם SafeFrame ישתמש במאפיין ארגז החול של HTML5 כדי למנוע ניווט ברמה העליונה ללא אינטראקציה של משתמש. |
use | הוצא משימוש. אם SafeFrame ישתמש בתת-דומיינים אקראיים לנכסי קריאייטיב במכירה ישירה לא פרוגרמטית. |
מאפיינים
Optional
allowOverlayExpansion
allowOverlayExpansion?: boolean
האם SafeFrame יאפשר לתוכן המודעה להתרחב על ידי שכבת-על של תוכן הדף.
Optional
allowPushExpansion
allowPushExpansion?: boolean
האם SafeFrame צריך לאפשר לתוכן מודעה להתרחב על ידי דחיפת תוכן הדף.
Optional
ארגז חול
sandbox?: boolean
הגדרה שקובעת אם ל-SafeFrame להשתמש במאפיין ה-Sandbox של HTML5 כדי למנוע ניווט ברמה העליונה ללא אינטראקציה מצד המשתמש. הערך החוקי היחיד הוא true
(לא ניתן לאלץ את הערך להיות false
). הערה: מאפיין ארגז החול משבית יישומי פלאגין (למשל, Flash).
Optional
useUniqueDomain
useUniqueDomain?: null | boolean
האם מערכת SafeFrame צריכה להשתמש בתת-דומיינים אקראיים עבור נכסי קריאייטיב במכירה ישירה לא פרוגרמטית. מעבירים את הערך null
כדי לנקות את הערך השמור.
הערה: התכונה הזו מופעלת כברירת מחדל.
googletag.Service
שיטות | |
---|---|
add | הרשמה של מאזין שמאפשר להגדיר פונקציית JavaScript ולקרוא לה כשאירוע GPT ספציפי מתרחש בדף. |
get | הצגת רשימת המקומות שמשויכים לשירות הזה. |
remove | הסרת מעבד אירועים שרשום בעבר. |
שיטות
addEventListener
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- דוגמה
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
הרשמה של מאזין שמאפשר להגדיר פונקציית JavaScript ולקרוא לה כשאירוע GPT ספציפי מתרחש בדף. האירועים הבאים נתמכים:
פרמטרים | |
---|---|
eventType: K | מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות. |
listener: ((arg: EventTypeMap[K]) => void) | פונקציה שלוקחת ארגומנט של אובייקט אירוע יחיד. |
החזרות | |
---|---|
Service | אובייקט השירות שבו הופעלה ה-method. |
getSlots
removeEventListener
- דוגמה
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(); });
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
הסרת מעבד אירועים שרשום בעבר.
פרמטרים | |
---|---|
eventType: K | מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות. |
listener: ((event: EventTypeMap[K]) => void) | פונקציה שלוקחת ארגומנט של אובייקט אירוע יחיד. |
googletag.SizeMappingBuilder
שיטות | |
---|---|
add | הפונקציה מוסיפה מיפוי ממערך בגודל יחיד (המייצג את אזור התצוגה) למערך בגודל יחיד או רב-גודל שמייצג את יחידת הקיבולת. |
build | יצירת מפרט של מפת גודל מהמיפויים שנוספו ליוצר הזה. |
שיטות
addSize
- דוגמה
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]
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
הפונקציה מוסיפה מיפוי ממערך בגודל יחיד (המייצג את אזור התצוגה) למערך בגודל יחיד או רב-גודל שמייצג את יחידת הקיבולת.
פרמטרים | |
---|---|
viewportSize: SingleSizeArray | הגודל של אזור התצוגה של רשומת המיפוי הזו. |
slotSize: GeneralSize | הגדלים של החריץ של רשומת המיפוי הזו. |
החזרות | |
---|---|
SizeMappingBuilder | הפניה ל-builder הזה. |
build
build(): null | SizeMappingArray
יצירת מפרט של מפת גודל מהמיפויים שנוספו ל-builder הזה.
אם סיפקו מיפויים לא חוקיים, השיטה הזו תחזיר את הערך null
. אחרת, הוא מחזיר מפרט בפורמט הנכון שאפשר להעביר אל Slot.defineSizeMapping.
הערה: ההתנהגות של ה-builder אחרי הקריאה לשיטה הזו לא מוגדרת.
החזרות | |
---|---|
null | SizeMappingArray | התוצאה שנוצרה על ידי ה-builder הזה. יכול להיות null אם סופקו מיפויים לא חוקיים של גדלים. |
googletag.Slot
שיטות | |
---|---|
add | הוספת שירות למשבצת הזו. |
clear | הפונקציה מנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת המיקום המודעה. |
clear | מחיקת פרמטרים ספציפיים או את כל הפרמטרים של טירגוט מותאם אישית ברמת המיקום המודעה עבור המיקום הזה. |
define | הגדרת מערך של מיפויים מגודל מינימלי של אזור תצוגה לגודל חריץ עבור החריץ הזה. |
get | הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון עבור המשבצת הזו. |
get | הפונקציה מחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת והנתיב של יחידת המודעות. |
get | הפונקציה מחזירה את רשימת מפתחות המאפיינים שהוגדרו בחריץ הזה. |
get | הפונקציה מחזירה את תוויות ההחרגה של קטגוריות המודעות עבור המיקום הזה. |
get | הפונקציה מחזירה את פרטי התגובה למודעה. |
get | הפונקציה מחזירה את המזהה של המשבצת div שצוינה כשהוגדרה משבצת זמן. |
get | הפונקציה מחזירה פרמטר טירגוט מותאם אישית ספציפי שהוגדר במקום הזה. |
get | מחזירה את הרשימה של כל מפתחות הטירגוט בהתאמה אישית שהוגדרו במשבצת הזו. |
set | הגדרת ערך למאפיין AdSense במקום המודעה הזה. |
set | מגדיר תווית החרגה של קטגוריית מודעות ברמת מיקום המודעה הזה. |
set | הגדרת כתובת ה-URL של הקליק שאליה המשתמשים יופנו אוטומטית אחרי שהם ילחצו על המודעה. |
set | ההגדרה קובעת אם המיקום div יוסתר כשאין מודעה במיקום. |
set | הגדרת אפשרויות תצורה כלליות עבור החריץ הזה. |
set | ההגדרה קובעת אם לאלץ עיבוד של מודעות במיקום הזה באמצעות מאגר של SafeFrame. |
set | הגדרת ההעדפות ברמת המיקום להגדרת SafeFrame. |
set | מגדיר פרמטר טירגוט בהתאמה אישית למיקום הזה. |
update | הגדרת פרמטרים של טירגוט בהתאמה אישית למיקום המודעה הזה, ממפה של מפתח:ערך באובייקט JSON. |
שיטות
addService
- דוגמה
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());
addService(service: Service): Slot
הוספת שירות למשבצת הזו.
פרמטרים | |
---|---|
service: Service | השירות שרוצים להוסיף. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
clearCategoryExclusions
- דוגמה
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.
clearCategoryExclusions(): Slot
ניקוי כל תוויות ההחרגה של קטגוריות מודעות ברמת מיקום המודעה למיקום הזה.
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
clearTargeting
- דוגמה
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.
- ראה גם
clearTargeting(key?: string): Slot
מחיקת פרמטרים ספציפיים או את כל הפרמטרים של טירגוט מותאם אישית ברמת המיקום המודעה עבור המיקום הזה.
פרמטרים | |
---|---|
| מפתח פרמטר של טירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל פרמטרי הטירגוט יימחקו. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
defineSizeMapping
- דוגמה
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!);
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
הגדרת מערך של מיפויים מגודל מינימלי של אזור תצוגה לגודל חריץ עבור החריץ הזה.
פרמטרים | |
---|---|
sizeMapping: SizeMappingArray | מערך של מיפויי גדלים. אפשר להשתמש ב-SizeMappingBuilder כדי ליצור אותו. כל מיפוי גודל הוא מערך של שני רכיבים: SingleSizeArray ו-GeneralSize. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
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'.
- ראה גם
get(key: string): null | string
הפונקציה מחזירה את הערך של המאפיין AdSense שמשויך למפתח הנתון במשבצת הזו. כדי לראות את המאפיינים ברמת השירות שעברו בירושה לטבלת המשנה הזו, משתמשים ב-PubAdsService.get.
פרמטרים | |
---|---|
key: string | שם המאפיין שרוצים לחפש. |
החזרות | |
---|---|
null | string | הערך הנוכחי של מפתח המאפיין, או null אם המפתח לא קיים. |
getAdUnitPath
- דוגמה
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'.
getAdUnitPath(): string
הפונקציה מחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת ונתיב יחידת המודעות.
החזרות | |
---|---|
string | נתיב של יחידת מודעות. |
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'].
getAttributeKeys(): string[]
הפונקציה מחזירה את הרשימה של מפתחות המאפיינים שהוגדרו במשבצת הזו. כדי לראות את המפתחות של מאפיינים ברמת השירות שעברו בירושה למשבצת הזו, משתמשים ב-PubAdsService.getAttributeKeys.
החזרות | |
---|---|
string[] | מערך של מפתחות מאפיינים. הסדר לא מוגדר. |
getCategoryExclusions
- דוגמה
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'].
getCategoryExclusions(): string[]
הפונקציה מחזירה את תוויות ההחרגה של קטגוריות המודעות עבור המיקום הזה.
החזרות | |
---|---|
string[] | תוויות ההחרגה של קטגוריות המודעות עבור המיקום הזה, או מערך ריק אם לא הוגדרו תוויות כאלה. |
getResponseInformation
getResponseInformation(): null | ResponseInformation
הפונקציה מחזירה את פרטי התגובה למודעה. הערך הזה מבוסס על התגובה האחרונה של המודעה באותו מיקום. אם הפונקציה הזו תופעל כשאין מודעה במקום, הערך null
יוחזר.
החזרות | |
---|---|
null | ResponseInformation | פרטי התגובה האחרונה למודעה, או null אם אין מודעה במיקום. |
getSlotElementId
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (קודם)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
getSlotElementId(): string
הפונקציה מחזירה את המזהה של המשבצת div
שצוין כשהמשבצת הוגדרה.
החזרות | |
---|---|
string | מזהה המיקום div . |
getTargeting
- דוגמה
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).
getTargeting(key: string): string[]
הפונקציה מחזירה פרמטר טירגוט מותאם אישית ספציפי שהוגדר במקום הזה. פרמטרים של טירגוט ברמת השירות לא נכללים.
פרמטרים | |
---|---|
key: string | מפתח הטירגוט שרוצים לחפש. |
החזרות | |
---|---|
string[] | הערכים המשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה. |
getTargetingKeys
- דוגמה
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'].
getTargetingKeys(): string[]
הפונקציה מחזירה את הרשימה של כל מפתחות הטירגוט בהתאמה אישית שהוגדרו במקום הזה. מפתחות טירגוט ברמת השירות אינם כלולים.
החזרות | |
---|---|
string[] | מערך של מפתחות טירגוט. הסדר לא מוגדר. |
set
- דוגמה
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());
- ראה גם
set(key: string, value: string): Slot
הגדרת ערך למאפיין AdSense במקום המודעה הזה. הפעולה הזו תבטל את כל הערכים שהוגדרו ברמת השירות למפתח הזה.
קריאה ל-method הזה יותר מפעם אחת עבור אותו מפתח תבטל את הערכים שהוגדרו בעבר למפתח הזה. צריך להגדיר את כל הערכים לפני קריאה ל-display
או ל-refresh
.
פרמטרים | |
---|---|
key: string | שם המאפיין. |
value: string | ערך מאפיין. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
setCategoryExclusion
- דוגמה
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());
setCategoryExclusion(categoryExclusion: string): Slot
הגדרת תווית החרגה של קטגוריית מודעות ברמת המיקום.
פרמטרים | |
---|---|
categoryExclusion: string | תווית ההחרגה של קטגוריית המודעות להוספה. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
setClickUrl
- דוגמה
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());
setClickUrl(value: string): Slot
הגדרת כתובת ה-URL של הקליק שאליה המשתמשים יופנו אוטומטית אחרי שהם ילחצו על המודעה.
שרתי Google Ad Manager עדיין מתעדים קליק גם אם כתובת ה-URL של הקליק מוחלפת. כל כתובת של דף נחיתה שמשויכת לקריאייטיב שמוצג מצורפת לערך שצוין. קריאות הבאות יחליפו את הערך. האפשרות הזו פועלת רק לבקשות שאינן SRA.
פרמטרים | |
---|---|
value: string | כתובת ה-URL של הקליק להגדרה. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
setCollapseEmptyDiv
- דוגמה
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.
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
ההגדרה קובעת אם המיקום div
יוסתר כשאין מודעה במיקום. ההגדרה הזו מבטלת את ההגדרות ברמת השירות.
פרמטרים | |
---|---|
collapse: boolean | אם לסגור את המקום לפרסום אם לא מוחזרת מודעה. |
| האם לכווץ את המקום לפרסום עוד לפני אחזור המודעה. המערכת תתעלם מהמאפיין אם הערך של collapse הוא לא true . |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
setConfig
setConfig(slotConfig: SlotSettingsConfig): void
ההגדרה קובעת אפשרויות הגדרה כלליות לחריץ הזה.
פרמטרים | |
---|---|
slotConfig: SlotSettingsConfig | אובייקט התצורה. |
setForceSafeFrame
- ההגדרה הזו תיכנס לתוקף רק לגבי בקשות לאחריות להצגת מודעות שיוגשו עבור המשבצות הרלוונטיות.
- ההגדרה ברמת השקע, אם היא צוינה, תמיד תקבל קדימות על פני ההגדרה ברמת הדף.
- אם ההגדרה היא
true
(ברמת המיקום או ברמת הדף), המערכת תמיד תיצור את המודעה באמצעות מאגר SafeFrame, ללא קשר לבחירה שבוצעה בממשק המשתמש של Google Ad Manager. - עם זאת, אם הערך של הפרמטר מוגדר כ-
false
או לא צוין ערך, המערכת תיצור את המודעה באמצעות מאגר SafeFrame, בהתאם לסוג הקריאייטיב ולבחירה שבוצעה בממשק המשתמש של Google Ad Manager. - צריך להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של נכסי קריאייטיב שמנסים לפרוץ ממסגרות ה-iframe שלהם או להסתמך על הפיכת הנכסים האלה לגרפיקה ישירות בדף של בעל התוכן הדיגיטלי.
- דוגמה
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (קודם)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
setForceSafeFrame(forceSafeFrame: boolean): Slot
ההגדרה קובעת אם מודעות במקום הזה ייאלצו לעבור עיבוד באמצעות מאגר SafeFrame.
חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:
פרמטרים | |
---|---|
forceSafeFrame: boolean | true כדי לאלץ את המערכת ליצור את כל המודעות באותו מיקום באמצעות SafeFrames, ו-false כדי לבטל את ההסכמה להגדרה ברמת הדף (אם יש כזו). הגדרת הערך false כשלא צוין ברמת הדף לא תשנה דבר. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
setSafeFrameConfig
- דוגמה
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");
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
הגדרת ההעדפות ברמת המיקום להגדרת SafeFrame. המערכת תתעלם מכל מפתחות לא מזוהים באובייקט התצורה. אם יועבר ערך לא חוקי למפתח מזוהה, המערכת תתעלם מההגדרה כולה.
ההעדפות האלה ברמת המיקום, אם הן צוינו, יבטלו את ההעדפות ברמת הדף.
פרמטרים | |
---|---|
config: null | SafeFrameConfig | אובייקט התצורה. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
setTargeting
- דוגמה
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"]);
- ראה גם
setTargeting(key: string, value: string | string[]): Slot
הגדרת פרמטר טירגוט מותאם אישית למיקום המודעה הזה. קריאה של השיטה הזו כמה פעמים לאותו מפתח תגרום להחליף את הערכים הישנים. הערכים שתגדירו כאן יחליפו את פרמטרים הטירגוט שהוגדרו ברמת השירות. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
פרמטרים | |
---|---|
key: string | מפתח פרמטר של טירגוט. |
value: string | string[] | ערך פרמטר טירגוט או מערך ערכים. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
updateTargetingFromMap
- במקרה של החלפה, רק הערך האחרון יישמר.
- אם הערך הוא מערך, כל ערך קודם יבוטל ולא ימוזג.
- הערכים שתגדירו כאן יחליפו את פרמטרים הטירגוט שהוגדרו ברמת השירות.
- דוגמה
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"], });
updateTargetingFromMap(map: {
[adUnitPath: string]: string | string[];
}): Slot
הגדרת פרמטרים של טירגוט בהתאמה אישית למיקום המודעה הזה, ממפה של מפתח:ערך באובייקט JSON. הפעולה הזו זהה לקריאה ל-Slot.setTargeting לכל ערכי המפתח של האובייקט. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
הערות:
פרמטרים | |
---|---|
map: { | מפת מפתח/ערך של פרמטר טירגוט. |
החזרות | |
---|---|
Slot | אובייקט השקע שאליו ה-method נקרא. |
googletag.config
ממשקים | |
---|---|
Ad | הגדרות לשלוט בהרחבת המודעות. |
Component | אובייקט שמייצג מכרז של רכיב יחיד במכרז של מודעות במכשיר. |
Interstitial | אובייקט שמגדיר את ההתנהגות של משבצת מודעה אחת מסוג מעברון. |
Page | ממשק ההגדרות הראשי להגדרות ברמת הדף. |
Privacy | הגדרות לניהול הטיפול בפרטיות של בעלי תוכן דיגיטלי. |
Publisher | אובייקט תצורה של אותות שמספקים בעלי תוכן דיגיטלי (PPS). |
Slot | ממשק התצורה הראשי להגדרות ברמת החריץ. |
Taxonomy | אובייקט שמכיל את הערכים של טקסונומיה אחת. |
סוג כינויים | |
---|---|
Interstitial | טריגרים נתמכים של מודעות מעברון. |
Privacy | תמיכה בטיפולי פרטיות של בעלי תוכן דיגיטלי. |
Taxonomy | קטגוריות נתמכות לאותות שמספקים בעלי תוכן דיגיטלי (PPS). |
כינויים מסוג טקסט
InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar"
טריגרים נתמכים של מודעות מעברון.
PrivacyTreatment
PrivacyTreatment: "disablePersonalization"
תמיכה בטיפולי פרטיות של בעלי תוכן דיגיטלי.
טקסונומיה
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
קטגוריות נתמכות לאותות שמספקים בעלי תוכן דיגיטלי (PPS).
googletag.config.AdExpansionConfig
מאפיינים | |
---|---|
enabled | האם הרחבת המודעה מופעלת או מושבתת. |
- דוגמה
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (קודם)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
מאפיינים
Optional
מופעל
enabled?: boolean
האם הרחבת מודעות מופעלת או מושבתת.
הגדרת הערך הזה מבטלת את ברירת המחדל שהוגדרה ב-Google Ad Manager.
googletag.config.ComponentAuctionConfig
מאפיינים | |
---|---|
auction | אובייקט של הגדרת מכרז למכרז של הרכיב הזה. |
config | מפתח התצורה שמשויך למכרז הרכיב הזה. |
מאפיינים
auctionConfig
- דוגמה
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, }, ], });
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
שצוין תימחק.
configKey
configKey: string
מפתח התצורה שמשויך למכרז הרכיב הזה.
הערך הזה לא יכול להיות ריק וצריך להיות ייחודי. אם לשני אובייקטים מסוג ComponentAuctionConfig
יש את אותו ערך של configKey, ההגדרה האחרונה שתוגדר תחליף את ההגדרות הקודמות.
googletag.config.InterstitialConfig
מאפיינים | |
---|---|
triggers | הגדרת הטריגר של מודעת המעברון הזו. |
מאפיינים
Optional
טריגרים
- דוגמה
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, }, }, });
triggers?: Partial<Record<InterstitialTrigger, boolean>>
הגדרת הטריגר של המודעות המעבריות במודעה המעברית הזו.
הגדרת הערך של טריגר של מודעה מעברית כ-true
תפעיל אותו, והגדרת הערך כ-false
תשבית אותו. ההגדרה הזו תבטל את ערכי ברירת המחדל שהוגדרו ב-Google Ad Manager.
googletag.config.PageSettingsConfig
מאפשר להגדיר כמה תכונות באמצעות קריאת API אחת.
כל המאפיינים שמפורטים בהמשך הם דוגמאות, והם לא משקפים תכונות בפועל שמשתמשות ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות מסוג PageSettingsConfig בהמשך.
דוגמאות:
- רק התכונות שצוינו בקריאה googletag.setConfig משתנות.
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה מסוימת מתעדכנות בכל קריאה ל-googletag.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- כדי לנקות את כל ההגדרות של תכונה מסוימת, מעבירים את הערך
null
.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
מאפיינים | |
---|---|
ad | הגדרות לשליטה בהרחבת המודעות. |
ad | הוצא משימוש. |
pps | הגדרות לניהול אותות שמספקים בעלי תוכן דיגיטלי (PPS). |
privacy | הגדרות לניהול הטיפול בפרטיות של בעלי תוכן דיגיטלי. |
thread | הגדרה שמאפשרת לקבוע אם GPT יספק את שרשור ה-JS בזמן עיבוד הקריאייטיב. |
מאפיינים
Optional
adExpansion
adExpansion?: null | AdExpansionConfig
הגדרות לשלוט בהרחבת המודעות.
Optional
adYield
adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Optional
pps
pps?: null | PublisherProvidedSignalsConfig
הגדרות לניהול אותות שמספקים בעלי תוכן דיגיטלי (PPS).
Optional
privacyTreatments
privacyTreatments?: null | PrivacyTreatmentsConfig
הגדרות לשליטה בשמירה על הפרטיות של בעלי התוכן הדיגיטלי.
Optional
threadYield
null
(ברירת המחדל): GPT יפיק את ה-thread JS בשביל מיקומים מחוץ לאזור התצוגה.ENABLED_ALL_SLOTS
: GPT יעביר את שרשור ה-JS לכל המודעות, גם אם הן לא נמצאות בחלון התצוגה.DISABLED
: GPT לא יניב את שרשור ה-JS.- דוגמה
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript (קודם)
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- ראה גם
threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
הגדרה שמאפשרת לקבוע אם תג ה-GPT יעביר את השרשור של ה-JS לטיפול ברמה הבאה כשהמערכת תבצע רינדור של נכסי הקריאייטיב.
תג ה-GPT יעביר את השרשור לטיפול ברמה הבאה רק בדפדפנים שתומכים ב-Scheduler.postTask או ב-Scheduler.yield API.
הערכים הנתמכים:
googletag.config.PrivacyTreatmentsConfig
מאפיינים | |
---|---|
treatments | מגוון שיטות לשמירה על פרטיות של בעלי תוכן דיגיטלי שאפשר להפעיל. |
מאפיינים
טיפולים
- דוגמה
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"] }, });
treatments: "disablePersonalization"[]
מגוון שיטות לשמירה על פרטיות של בעלי תוכן דיגיטלי שאפשר להפעיל.
googletag.config.PublisherProvidedSignalsConfig
מאפיינים | |
---|---|
taxonomies | אובייקט שמכיל מיפויי טקסונומיה. |
- דוגמה
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (קודם)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
מאפיינים
טקסונומיות
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
אובייקט שמכיל מיפויים של טקסונומיה.
googletag.config.SlotSettingsConfig
מאפשר להגדיר כמה תכונות עם קריאה אחת ל-API למשבצת אחת.
כל הנכסים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות שנעשה בהן שימוש ב-setConfig. כדי לראות את קבוצת התכונות, אפשר לעיין בשדות מסוג SlotSettingsConfig בהמשך.
דוגמאות:
- רק התכונות שצוינו בקריאה Slot.setConfig משתנות.
const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה מסוימת מתעדכנות בכל קריאה ל-Slot.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- כדי לנקות את כל ההגדרות של תכונה מסוימת, מעבירים את הערך
null
.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
מאפיינים | |
---|---|
ad | הגדרות לשליטה בהרחבת המודעות. |
component | מערך של מכרזי רכיבים שכלולים במכרז של מודעה במכשיר. |
interstitial | הגדרות ששולטות בהתנהגות של מיקומי מודעות המעברון. |
מאפיינים
Optional
adExpansion
adExpansion?: AdExpansionConfig
הגדרות לשלוט בהרחבת המודעות.
Optional
componentAuction
componentAuction?: ComponentAuctionConfig[]
מגוון מכרזים של רכיבים שייכללו במכרז של מודעות במכשיר.
Optional
מודעת אינטרטיסיאל
interstitial?: InterstitialConfig
הגדרות ששולטות בהתנהגות של מיקום מודעה מעברון.
googletag.config.TaxonomyData
מאפיינים | |
---|---|
values | רשימה של ערכים של Taxonomy. |
מאפיינים
values
values: string[]
רשימה של ערכים של Taxonomy.
googletag.enums
ערכים ממוספרים | |
---|---|
Out | פורמטים מחוץ לדף שנתמכים על ידי GPT. |
Traffic | מקורות תנועה שנתמכים על ידי GPT. |
ערכים ממוספרים
OutOfPageFormat
- ראה גם
OutOfPageFormat
פורמטים מחוץ לדף שנתמכים על ידי GPT.
TrafficSource
TrafficSource
מקורות תנועה שנתמכים ב-GPT.
חברי Enumeration | |
---|---|
ORGANIC | הזנה ישירה של כתובת URL, חיפוש באתר או הורדת אפליקציה. |
PURCHASED | תנועה שהופנתה באופן אוטומטי מנכסים שאינם בבעלות בעל התוכן הדיגיטלי (פעילות נרכשת או מתומרצת בדרך אחרת). |
googletag.events
ממשקים | |
---|---|
Event | ממשק בסיס לכל אירועי ה-GPT. |
Event | זהו פסאודו-סוג שממפה שם אירוע לסוג אובייקט האירוע התואם שלו עבור Service.addEventListener ו-Service.removeEventListener. |
Game | האירוע הזה מופעל כאשר המשתמש סוגר מיקום של מודעת מעברון ידנית במשחק. |
Game | האירוע הזה מופעל כשתצוגת מעבר ידנית במשחק מוכנה להופיע למשתמש. |
Impression | האירוע הזה מופעל כשחשיפה הופכת לניתנת לצפייה, בהתאם לקריטריונים של Active View. |
Rewarded | האירוע הזה מופעל כשהמשתמש סוגר מיקום של מודעה מתגמלת. |
Rewarded | האירוע הזה מופעל כשמתקבל תגמול על צפייה במודעה מתגמלת. |
Rewarded | האירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה. |
Slot | אירוע זה מופעל כאשר ה-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. |
Slot | האירוע הזה מופעל כשקוד הקריאייטיב מוזרק לחריץ. |
Slot | האירוע הזה מופעל כשנשלחת בקשה להצגת מודעה במקום ספציפי. |
Slot | אירוע זה מופעל כאשר מתקבלת תגובה למודעה עבור משבצת מסוימת. |
Slot | האירוע הזה מופעל בכל פעם שהאחוז של אזור שטח הפרסום במסך משתנה. |
googletag.events.Event
מאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. |
slot | השקע שהפעיל את האירוע. |
מאפיינים
serviceName
serviceName: string
שם השירות שהפעיל את האירוע.
משבצת
slot: Slot
המיקום שהפעיל את האירוע.
googletag.events.EventTypeMap
מאפיינים
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
gameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
impressionViewable
impressionViewable: ImpressionViewableEvent
כינוי ל-events.ImpressionViewableEvent.
rewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEvent
כינוי ל-events.RewardedSlotClosedEvent.
rewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEvent
כינוי ל-events.RewardedSlotGrantedEvent.
rewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEvent
כינוי ל-events.RewardedSlotReadyEvent.
slotOnload
slotOnload: SlotOnloadEvent
כינוי של events.SlotOnloadEvent.
slotRenderEnded
slotRenderEnded: SlotRenderEndedEvent
כינוי ל-events.SlotRenderEndedEvent.
slotRequested
slotRequested: SlotRequestedEvent
כינוי ל-events.SlotRequestedEvent.
slotResponseReceived
slotResponseReceived: SlotResponseReceived
כינוי ל-events.SlotResponseReceived.
slotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEvent
כינוי ל-events.SlotVisibilityChangedEvent.
googletag.events.GameManualInterstitialSlotClosedEvent
הארכה שלהערה: מודעות מעברון עם הוראות למשחק הן בפורמט גישה מוגבלת.
מאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | השקע שהפעיל את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called when a game manual interstial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.GameManualInterstitialSlotReadyEvent
הארכה שלהערה: מודעות מעברון של הוראות משחק הן בפורמט גישה מוגבלת.
מאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | השקע שהפעיל את האירוע. הועברה בירושה מ- |
שיטות | |
---|---|
make | הצגת מודעה מעברון של הוראות המשחק למשתמש. |
- דוגמה
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
שיטות
makeGameManualInterstitialVisible
googletag.events.ImpressionViewableEvent
הארכהמאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | השקע שהפעיל את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.RewardedSlotClosedEvent
הארכה שלמאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
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 | אובייקט שמכיל מידע על התגמול שהוענק. |
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
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
הארכה שלמאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | השקע שהפעיל את האירוע. הועברה בירושה מ- |
שיטות | |
---|---|
make | הצגת המודעה המתגמלת. |
- דוגמה
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
googletag.events.SlotOnloadEvent
הארכהSlotOnloadEvent
.מאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | השקע שהפעיל את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.SlotRenderEndedEvent
הארכהמאפיינים | |
---|---|
advertiser | מזהה המפרסם של המודעה שעבר רינדור. |
campaign | מזהה הקמפיין של המודעה שעבר רינדור. |
company | המזהים של החברות שהגישו הצעות מחיר על המודעה למילוי החסר שעבר רינדור. |
creative | מזהה הקריאייטיב של מודעה שהוגדרה להזמנה ועברה רינדור. |
creative | מזהה תבנית הקריאייטיב של מודעת ההזמנה שעבר רינדור. |
is | האם המודעה הייתה מודעת גיבוי. |
is | האם הוחזרה מודעה למיקום המודעה. |
label | הוצא משימוש. |
line | מזהה הפריט של המודעה שהונפקה בהזמנה. |
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
size | מציין את גודל הפיקסלים של הקריאייטיב שעבר רינדור. |
slot | השקע שהפעיל את האירוע. הועברה בירושה מ- |
slot | האם תוכן המיקום השתנה עם המודעה שעבר רינדור. |
source | מזהה הקריאייטיב של ההזמנה שעבר רינדור או של המודעה למילוי חוסר (backfill). |
source | מזהה הפריט של המודעה ששמורה או של המודעה למילוי חוסר (backfill) שעבר רינדור. |
yield | המזהים של קבוצות התפוקה של המודעה שעבר רינדור למילוי שטחי הפרסום הריקים. |
- דוגמה
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
מאפיינים
advertiserId
advertiserId: null | number
מזהה המפרסם של המודעה שעבר רינדור. הערך הוא null
עבור משבצות ריקות, מודעות למילוי שטחי פרסום ריקים ונכסי קריאייטיב שנעשה בהם רינדור על ידי שירותים שאינם PubAdsService.
campaignId
campaignId: null | number
מזהה הקמפיין של המודעה שעבר רינדור. הערך הוא null
עבור משבצות ריקות, מודעות למילוי שטחי פרסום ריקים ונכסי קריאייטיב שנעשה בהם רינדור על ידי שירותים שאינם PubAdsService.
companyIds
companyIds: null | number[]
המזהים של החברות שהגישו הצעות מחיר על המודעה למילוי החסר שעבר רינדור. הערך הוא null
עבור משבצות ריקות, מודעות שמורות ונכסי קריאייטיב שנעשה בהם רינדור על ידי שירותים שאינם PubAdsService.
creativeId
creativeId: null | number
מזהה הקריאייטיב של מודעה שהוגדרה להזמנה ועברה רינדור. הערך הוא null
עבור משבצות ריקות, מודעות למילוי שטחי פרסום ריקים ונכסי קריאייטיב שנעשה בהם רינדור על ידי שירותים שאינם PubAdsService.
creativeTemplateId
creativeTemplateId: null | number
מזהה תבנית הקריאייטיב של מודעת ההזמנה שעבר רינדור. הערך הוא null
עבור משבצות ריקות, מודעות למילוי שטחי פרסום ריקים ונכסי קריאייטיב שנעשה בהם רינדור על ידי שירותים שאינם PubAdsService.
isBackfill
isBackfill: boolean
האם המודעה הייתה מודעת גיבוי. הערך הוא true
אם המודעה הייתה מודעה למילוי מקום, false
אחרת.
isEmpty
isEmpty: boolean
האם הוחזרה מודעה עבור מיקום המודעה. הערך הוא true
אם לא הוחזרה מודעה, false
אחרת.
labelIds
labelIds: null | number[]
lineItemId
lineItemId: null | number
מזהה הפריט של המודעה שהונפקה בהזמנה. הערך הוא null
למשבצות ריקות, למודעות מילוי חוסרים ולקריאייטיבים שעובדו על ידי שירותים אחרים שאינם PubAdsService.
size
size: null | string | number[]
מציין את גודל הפיקסלים של הקריאייטיב שעבר עיבוד. דוגמה: [728, 90]
הערך הוא null
עבור משבצות מודעות ריקות.
slotContentChanged
slotContentChanged: boolean
האם תוכן המיקום השתנה עם המודעה שעבר רינדור. הערך הוא true
אם התוכן השתנה, false
אחרת.
sourceAgnosticCreativeId
sourceAgnosticCreativeId: null | number
מזהה הקריאייטיב של ההזמנה שעבר רינדור או של המודעה למילוי חוסר (backfill). הערך הוא null
אם המודעה היא לא הזמנה או מילוי חוסרים של פריט, או אם הקריאייטיב עבר רינדור על ידי שירותים שאינם PubAdsService.
sourceAgnosticLineItemId
sourceAgnosticLineItemId: null | number
מזהה הפריט של המודעה ששמורה או של המודעה למילוי חוסר (backfill) שעבר רינדור. הערך הוא null
אם המודעה היא לא הזמנה או מילוי חוסרים של פריט, או אם הקריאייטיב עבר רינדור על ידי שירותים שאינם PubAdsService.
yieldGroupIds
yieldGroupIds: null | number[]
המזהים של קבוצות התפוקה של המודעה שעבר רינדור למילוי שטחי הפרסום הריקים. הערך הוא null
עבור משבצות ריקות, מודעות שמורות ונכסי קריאייטיב שנעשה בהם רינדור על ידי שירותים שאינם PubAdsService.
googletag.events.SlotRequestedEvent
הארכהמאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המיקום שהפעיל את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.SlotResponseReceived
הארכהמאפיינים | |
---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המיקום שהפעיל את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.SlotVisibilityChangedEvent
הארכה שלמאפיינים | |
---|---|
in | האחוז של השטח של המודעה שמוצג. |
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המיקום שהפעיל את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (קודם)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
מאפיינים
inViewPercentage
inViewPercentage: number
האחוז של השטח של המודעה שמוצג. הערך הוא מספר בין 0 ל-100.
googletag.secureSignals
ממשקים | |
---|---|
Bidder | הפונקציה מחזירה אות מאובטח למשתמש מסוים שמגיש הצעות מחיר. |
Publisher | הפונקציה מחזירה אות מאובטח למוציא לאור ספציפי. |
Secure | ממשק לניהול אותות מאובטחים. |
כינויים מסוג טקסט | |
---|---|
Secure | ממשק להחזרת אות מאובטח עבור מגיש הצעות מחיר או ספק ספציפיים. |
כינויים מסוג טקסט
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider
ממשק להחזרת אות מאובטח עבור מגיש הצעות מחיר או ספק ספציפיים. יש לספק אחד מהערכים id
או networkCode
, אבל לא את שניהם.
googletag.secureSignals.BidderSignalProvider
ספק אותות מאובטחים של מגיש הצעות מחיר מורכב משני חלקים:
- פונקציית אגרוף שמחזירה
Promise
שמתאים לאות מאובטח. id
שמזהה את מגיש הצעות המחיר שמשויך לאות.
מאפיינים | |
---|---|
collector | פונקציה שמחזירה Promise שמפנה לאות מאובטח. |
id | מזהה ייחודי של האוסף שמשויך לאות המאובטח הזה, כפי שהוא רשום ב-Google Ad Manager. |
- דוגמה
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (קודם)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
מאפיינים
collectorFunction
collectorFunction: (() => Promise<string>)
פונקציה שמחזירה Promise
שמתאים לאות מאובטח.
id
id: string
מזהה ייחודי של הקולקטור שמשויך לאות המאובטח הזה, כפי שרשום ב-Google Ad Manager.
googletag.secureSignals.PublisherSignalProvider
ספק אותות של בעלי תוכן דיגיטלי מורכב משני חלקים:
- פונקציית אגרוף שמחזירה
Promise
שמתאים לאות מאובטח. networkCode
שמזהה את בעל התוכן הדיגיטלי שמשויך לאות.
מאפיינים | |
---|---|
collector | פונקציה שמחזירה Promise שמתאים לאות מאובטח. |
network | קוד הרשת (כפי שהוא מופיע בנתיב של יחידת המודעות) של בעל התוכן הדיגיטלי שמשויך לאות המאובטח הזה. |
- דוגמה
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (קודם)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
מאפיינים
collectorFunction
collectorFunction: (() => Promise<string>)
פונקציה שמחזירה Promise
שמתאים לאות מאובטח.
networkCode
networkCode: string
קוד הרשת (כפי שהוא מופיע בנתיב של יחידת המודעות) של בעל התוכן הדיגיטלי שמשויך לאות המאובטח הזה.
googletag.secureSignals.SecureSignalProvidersArray
שיטות | |
---|---|
clear | ניקוי כל האותות מהמטמון לכל הקולקטורים. |
push | הקוד הזה מוסיף secureSignals.SecureSignalProvider חדש למערך של ספקי האותות ומתחיל את תהליך יצירת האות. |
שיטות
clearAllCache
clearAllCache(): void
ניקוי כל האותות של כל הקולקטורים מהמטמון.
קריאה לשיטה הזו עשויה להפחית את הסבירות שהאותות ייכללו בבקשות להצגת מודעות לגבי צפיות הנוכחיות בדפים, וגם לגבי צפיות עתידיות בדפים. לכן, צריך להפעיל אותו רק כשמתרחשים שינויים משמעותיים במצב, כמו אירועים שמציינים משתמש חדש (כניסה, יציאה, הרשמה וכו').
push
push(provider: SecureSignalProvider): void
הקוד הזה מוסיף secureSignals.SecureSignalProvider חדש למערך של ספקי האותות ומתחיל את תהליך יצירת האות.
פרמטרים | |
---|---|
provider: SecureSignalProvider | האובייקט secureSignals.SecureSignalProvider שרוצים להוסיף למערך. |