במסמך הזה נעשה שימוש בסימון של TypeScript כדי לתאר סוגים. בטבלה הבאה מופיע הסבר קצר עם דוגמאות.
| הקלדת ביטוי | |
|---|---|
string |
סוג המחרוזת הפרימיטיבית. |
string[] |
סוג מערך, שבו הערכים יכולים להיות רק מחרוזות. |
number | string |
סוג איחוד, שבו הערך יכול להיות מספר או מחרוזת. |
Array<number | string> |
סוג מערך, שבו הערכים הם סוג מורכב (איחוד). |
[number, string] |
סוג של tuple, שבו הערך הוא מערך עם שני רכיבים שחייבים להכיל מספר ומחרוזת, בסדר הזה. |
Slot |
סוג אובייקט, שבו הערך הוא מופע של googletag.Slot. |
() => void |
סוג פונקציה ללא ארגומנטים מוגדרים וללא ערך החזרה. |
מידע נוסף על סוגים נתמכים וביטויי סוגים זמין ב מדריך TypeScript .
הוספת הערות על סוגים
נקודתיים אחרי משתנה, שם פרמטר, שם נכס או חתימת פונקציה מציינות הערת טיפוס. הערות לגבי סוגים מתארות את הסוגים שהרכיב משמאל לנקודתיים יכול לקבל או להחזיר. בטבלה הבאה מוצגות דוגמאות להערות לגבי סוגים שאולי תראו במאמר הזה.
googletag
מרחב השמות הגלובלי ש-Google Publisher Tag משתמש בו עבור ה-API שלו.
| מרחבי שמות | |
|---|---|
config | ממשק ההגדרה הראשי להגדרות ברמת הדף. |
enums | זהו מרחב השמות שבו GPT משתמש עבור סוגי enum. |
events | זהו מרחב השמות שבו GPT משתמש לאירועים. |
secure | זהו מרחב השמות שבו GPT משתמש לניהול אותות מאובטחים. |
| ממשקים | |
|---|---|
Command | מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר. |
Companion | שירות המודעות הנלוות. |
Privacy | אובייקט הגדרה של הגדרות הפרטיות. |
Pub | שירות המודעות בתכנים של בעלי תוכן דיגיטלי. |
Response | אובייקט שמייצג תגובה יחידה לבקשה להצגת מודעה. |
Rewarded | אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת. |
Service | מחלקת שירות בסיסית שמכילה methods משותפים לכל השירותים. |
Size | אובייקטים של הגדרות מיפוי גדלים. |
Slot | Slot הוא אובייקט שמייצג משבצת פרסום יחידה בדף. |
| כינויי סוגים | |
|---|---|
General | הגדרת גודל תקינה של משבצת, שיכולה להיות גודל אחד או כמה גדלים. |
Multi | רשימה של גדלים תקינים. |
Named | גדלים עם שמות שבהם יכול להיות משבצת. |
Single | גודל תקין יחיד של משבצת. |
Single | מערך של שני מספרים שמייצגים [רוחב, גובה]. |
Size | מיפוי של גודל אזור התצוגה לגדלים של מודעות. |
Size | רשימה של מיפויים של גדלים. |
| משתנים | |
|---|---|
api | סימון שמציין שה-GPT API נטען ומוכן להפעלה. |
cmd | הפניה לתור הפקודות הגלובלי לביצוע אסינכרוני של קריאות שקשורות ל-GPT. |
pubads | סימון שמציין ש-PubAdsService מופעל, נטען ופועל באופן מלא. |
secure | הפניה למערך ספקי האותות המאובטחים. |
| פונקציות | |
|---|---|
companion | מחזירה הפניה אל CompanionAdsService. |
define | יוצר משבצת מודעה מחוץ לדף עם הנתיב שצוין ליחידת המודעות. |
define | יוצרת מיקום למודעה עם נתיב וגודל נתונים של יחידת מודעות, ומשייכת אותו למזהה של רכיב div בדף שיכיל את המודעה. |
destroy | הפונקציה הזו משמידה את המשבצות שצוינו, ומסירה מ-GPT את כל האובייקטים וההפניות שקשורים למשבצות האלה. |
disable | משבית את Google Publisher Console. |
display | הוראה לשירותי המשבצת לעבד את המשבצת. |
enable | ההגדרה הזו מאפשרת להפעיל את כל השירותים של GPT שהוגדרו עבור מיקומי מודעות בדף. |
get | הפונקציה מחזירה את הגרסה הנוכחית של GPT. |
open | ייפתח Google Publisher Console. |
pubads | מחזירה הפניה אל PubAdsService. |
set | הפרמטר הזה מגדיר את הכותרת לכל ה-iframe של מאגרי המודעות שנוצרו על ידי PubAdsService, החל מנקודה זו ואילך. |
set | הגדרת אפשרויות כלליות של תצורה לדף. |
size | יוצרת אובייקט חדש מסוג SizeMappingBuilder. |
כינויי סוגים
GeneralSize
GeneralSize: SingleSize | MultiSizeMultiSize
MultiSize: SingleSize[]NamedSize
NamedSize: "fluid" | ["fluid"]- fluid: הגורם המכיל של המודעה תופס 100% מהרוחב של תג div האב, ואז משנה את הגובה שלו כך שיתאים לתוכן הקריאייטיב. בדומה להתנהגות של רכיבי בלוק רגילים בדף. התג הזה משמש למודעות מותאמות (ראו מאמר שקשור לנושא). שימו לב שגם
fluidוגם['fluid']הן צורות קבילות להגדרת גודל משתנה של מיקום מודעה.
SingleSize
SingleSize: SingleSizeArray | NamedSizeSingleSizeArray
SingleSizeArray: [number, number]SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]SizeMappingArray
SizeMappingArray: SizeMapping[]משתנים
Const apiReady
apiReady: boolean | undefinedundefined עד שה-API יהיה מוכן.הערה: הדרך המומלצת לטפל בפעולות אסינכרוניות היא להשתמש ב-googletag.cmd כדי להוסיף פונקציות קריאה חוזרת לתור עד ש-GPT יהיה מוכן. אין צורך לבדוק את googletag.apiReady בפונקציות הקריאה החוזרת האלה, כי מובטח שהן יופעלו אחרי שמגדירים את ה-API.
Const cmd
cmd: ((this: typeof globalThis) => void)[] | CommandArrayהמשתנה
googletag.cmd מאותחל למערך JavaScript ריק על ידי תחביר תג GPT בדף, ו-cmd.push היא השיטה הרגילה Array.push שמוסיפה רכיב לסוף המערך. כשקוד ה-JavaScript של GPT נטען, הוא סורק את המערך ומבצע את כל הפונקציות לפי הסדר. לאחר מכן הסקריפט מחליף את cmd באובייקט CommandArray שהמתודה push שלו מוגדרת להפעלה של ארגומנט הפונקציה שמועבר אליו. המנגנון הזה מאפשר ל-GPT לצמצם את זמן האחזור הנתפס על ידי אחזור ה-JavaScript באופן אסינכרוני, תוך מתן אפשרות לדפדפן להמשיך לעבד את הדף.- דוגמה
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (גרסה קודמת)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
Const pubadsReady
pubadsReady: boolean | undefinedundefined עד להפעלת הפונקציה enableServices, ועד שהשירות PubAdsService ייטען ויאותחל.secureSignalProviders
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefinedהמערך של ספקי האותות המאובטחים מקבל רצף של פונקציות ליצירת אותות ומפעיל אותן לפי הסדר. היא נועדה להחליף מערך רגיל שמשמש להוספה לתור של פונקציות ליצירת אותות, שיופעלו אחרי שטעינת GPT תושלם.
- דוגמה
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (גרסה קודמת)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
פונקציות
companionAds
companionAds(): CompanionAdsServiceמחזירה הפניה אל CompanionAdsService.
| החזרות | |
|---|---|
CompanionAdsService | שירות המודעות הנלוות. |
defineOutOfPageSlot
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | nullיוצר משבצת מודעה מחוץ לדף עם הנתיב שצוין ליחידת המודעות.
במקרה של מודעות מותאמות אישית מחוץ לדף,
במודעות מחוץ לדף שמנוהלות על ידי GPT,
במקרה של מודעות מותאמות אישית מחוץ לדף,
div הוא המזהה של רכיב ה-div שיכיל את המודעה. פרטים נוספים זמינים במאמר בנושא נכסי קריאייטיב מחוץ לדף.במודעות מחוץ לדף שמנוהלות על ידי GPT,
div הוא OutOfPageFormat נתמך.- דוגמה
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (גרסה קודמת)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
| פרמטרים | |
|---|---|
adUnitPath: string | הנתיב המלא של יחידת המודעות עם קוד הרשת וקוד יחידת המודעות. |
| המזהה של רכיב ה-div שיכיל את יחידת המודעות הזו או את OutOfPageFormat. |
| החזרות | |
|---|---|
Slot | null | המשבצת החדשה שנוצרה, או null אם אי אפשר ליצור משבצת. |
defineSlot
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | nullיוצרת מיקום מודעה עם נתיב וגודל נתונים של יחידת מודעות, ומשייכת אותו למזהה של רכיב div בדף שיכיל את המודעה.
- דוגמה
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (גרסה קודמת)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
| פרמטרים | |
|---|---|
adUnitPath: string | הנתיב המלא של יחידת המודעות עם קוד הרשת וקוד היחידה. |
size: GeneralSize | הרוחב והגובה של מיקום המודעה שנוסף. זה הגודל שמשמש בבקשה להצגת מודעה אם לא מסופק מיפוי של גדלים רספונסיביים, או אם גודל אזור התצוגה קטן מהגודל הקטן ביותר שמופיע במיפוי. |
| המזהה של תג ה-div שיכיל את יחידת המודעות הזו. |
| החזרות | |
|---|---|
Slot | null | המשבצת החדשה שנוצרה, או null אם אי אפשר ליצור משבצת. |
destroySlots
destroySlots(slots?: Slot[]): booleanהפונקציה הזו משמידה את המשבצות שצוינו, ומסירה מ-GPT את כל האובייקטים וההפניות שקשורים למשבצות האלה. ה-API הזה לא תומך במשבצות להעברת נתונים ובמשבצות נלוות.
קריאה ל-API הזה במשבצת מנקה את המודעה ומסירה את אובייקט המשבצת מהמצב הפנימי שמתנהל על ידי GPT. הפעלה של פונקציות נוספות באובייקט של משבצת המודעה תגרום להתנהגות לא מוגדרת. הערה: יכול להיות שהדפדפן עדיין לא ישחרר את הזיכרון שמשויך למשבצת הזו אם דף בעל האתר שומר הפניה אליה. הפעלת ה-API הזה מאפשרת שימוש חוזר ב-div שמשויך למיקום הזה.
בפרט, השמדת מיקום מודעה מסירה את המודעה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות של מודעות מתחרות שקשורות למודעה הזו. אם לא תפעילו את הפונקציה הזו לפני שתסירו את ה-div של משבצת המודעה מהדף, תהיה התנהגות לא מוגדרת.
קריאה ל-API הזה במשבצת מנקה את המודעה ומסירה את אובייקט המשבצת מהמצב הפנימי שמתנהל על ידי GPT. הפעלה של פונקציות נוספות באובייקט של משבצת המודעה תגרום להתנהגות לא מוגדרת. הערה: יכול להיות שהדפדפן עדיין לא ישחרר את הזיכרון שמשויך למשבצת הזו אם דף בעל האתר שומר הפניה אליה. הפעלת ה-API הזה מאפשרת שימוש חוזר ב-div שמשויך למיקום הזה.
בפרט, השמדת מיקום מודעה מסירה את המודעה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות של מודעות מתחרות שקשורות למודעה הזו. אם לא תפעילו את הפונקציה הזו לפני שתסירו את ה-div של משבצת המודעה מהדף, תהיה התנהגות לא מוגדרת.
- דוגמה
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (גרסה קודמת)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
| פרמטרים | |
|---|---|
| מערך המשבצות שיוסר מהלוח. מערך הוא אופציונלי; אם לא מציינים מערך, כל המשבצות יושמדו. |
| החזרות | |
|---|---|
boolean | true אם משבצות הפרסום נהרסו, false אחרת. |
disablePublisherConsole
disablePublisherConsole(): voidמשבית את Google Publisher Console.
- ראה גם
תצוגה
display(divOrSlot: string | Element | Slot): voidהוראה לשירותי המשבצת לעבד את המשבצת. כל משבצת מודעות צריכה להופיע רק פעם אחת בכל דף. כדי שמשבצות יופיעו, צריך להגדיר את כולן ולשייך לכל אחת מהן שירות. הקריאה לתצוגה לא יכולה להתבצע עד שהאלמנט מופיע ב-DOM. הדרך הרגילה לעשות זאת היא להציב אותו בתוך בלוק סקריפט בתוך רכיב ה-div שצוין בקריאה לשיטה.
אם נעשה שימוש בארכיטקטורת בקשה יחידה (SRA), כל משבצות המודעות שלא אוחזרו בזמן הקריאה לשיטה הזו יאוחזרו בבת אחת. כדי לכפות על משבצת מודעה לא להציג מודעה, צריך להסיר את כל התג div.
אם נעשה שימוש בארכיטקטורת בקשה יחידה (SRA), כל משבצות המודעות שלא אוחזרו בזמן הקריאה לשיטה הזו יאוחזרו בבת אחת. כדי לכפות על משבצת מודעה לא להציג מודעה, צריך להסיר את כל התג div.
| פרמטרים | |
|---|---|
divOrSlot: string | Element | Slot | המזהה של רכיב ה-div שמכיל את מיקום המודעה או את רכיב ה-div, או את אובייקט מיקום המודעה. אם מסופק רכיב div, צריך להיות לו מאפיין id שתואם למזהה שמועבר אל defineSlot. |
enableServices
enableServices(): voidההגדרה הזו מאפשרת להפעיל את כל השירותים של GPT שהוגדרו עבור מיקומי מודעות בדף.
getVersion
getVersion(): stringמחזירה את הגרסה הנוכחית של GPT.
- ראה גם
| החזרות | |
|---|---|
string | מחרוזת גרסת ה-GPT שמופעלת כרגע. |
openConsole
openConsole(div?: string): voidפותח את Google Publisher Console.
- דוגמה
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (גרסה קודמת)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- ראה גם
| פרמטרים | |
|---|---|
| מזהה של תג div של מיקום מודעה. הערך הזה הוא אופציונלי. אם מספקים את הפרמטר הזה, מערכת Publisher Console תנסה להיפתח עם פרטים של מיקום המודעה שצוין. |
pubads
pubads(): PubAdsServiceמחזירה הפניה אל PubAdsService.
| החזרות | |
|---|---|
PubAdsService | שירות המודעות בתכנים של בעלי תוכן דיגיטלי. |
setAdIframeTitle
setAdIframeTitle(title: string): voidהפונקציה מגדירה את הכותרת לכל מסגרות ה-iframe של מאגר המודעות שנוצרו על ידי PubAdsService, החל מנקודה זו ואילך.
- דוגמה
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (גרסה קודמת)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
| פרמטרים | |
|---|---|
title: string | הכותרת החדשה של כל מסגרות ה-iframe של מאגרי התגים של המודעות. |
setConfig
setConfig(config: PageSettingsConfig): voidהגדרת אפשרויות כלליות של תצורה לדף.
| פרמטרים | |
|---|---|
config: PageSettingsConfig | |
sizeMapping
sizeMapping(): SizeMappingBuilderיוצר SizeMappingBuilder חדש.
| החזרות | |
|---|---|
SizeMappingBuilder | כלי בנייה חדש. |
googletag.CommandArray
מערך הפקודות מקבל רצף של פונקציות ומפעיל אותן לפי הסדר. היא נועדה להחליף מערך רגיל שמשמש להוספת פונקציות לתור כדי להפעיל אותן אחרי שטעינת GPT מסתיימת.
| Methods | |
|---|---|
push | מבצעת את רצף הפונקציות שצוין בארגומנטים לפי הסדר. |
Methods
דחיפה
push(...f: ((this: typeof globalThis) => void)[]): numberמבצעת את רצף הפונקציות שצוין בארגומנטים לפי הסדר.
- דוגמה
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (גרסה קודמת)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
| פרמטרים | |
|---|---|
| פונקציית JavaScript להרצה. הקישור בזמן הריצה תמיד יהיה globalThis. מומלץ להעביר פונקציית חץ כדי לשמור על הערך this של ההקשר הלקסיקלי המצורף. |
| החזרות | |
|---|---|
number | מספר הפקודות שעובדו עד עכשיו. הערך הזה תואם לערך ההחזרה של Array.push (האורך הנוכחי של המערך). |
googletag.CompanionAdsService
הארכה
Serviceשירות המודעות הנלוות. השירות הזה משמש מודעות וידאו להצגת מודעות נלוות.
| Methods | |
|---|---|
add | הפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. הועברה בירושה מ- |
get | אחזור רשימת המשבצות שמשויכות לשירות הזה. הועברה בירושה מ- |
remove | הסרה של מעבד אירוע שנרשם קודם. הועברה בירושה מ- |
set | ההגדרה קובעת אם משבצות של מודעות נלוות שלא מולאו ימולאו אוטומטית. |
Methods
setRefreshUnfilledSlots
setRefreshUnfilledSlots(value: boolean): voidהשיטה הזו מגדירה אם משבצות של מודעות משלימות שלא מולאו ימולאו אוטומטית.
אפשר להפעיל את השיטה הזו כמה פעמים במהלך חיי הדף כדי להפעיל או להשבית את המילוי החוזר. רק משבצות שרשומות גם ב-PubAdsService ימולאו מחדש. עקב הגבלות מדיניות, השיטה הזו לא מיועדת למילוי משבצות ריקות של מודעות נלוות כשמוצגת מודעת וידאו ב-Ad Exchange.
אפשר להפעיל את השיטה הזו כמה פעמים במהלך חיי הדף כדי להפעיל או להשבית את המילוי החוזר. רק משבצות שרשומות גם ב-PubAdsService ימולאו מחדש. עקב הגבלות מדיניות, השיטה הזו לא מיועדת למילוי משבצות ריקות של מודעות נלוות כשמוצגת מודעת וידאו ב-Ad Exchange.
- דוגמה
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (גרסה קודמת)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
| פרמטרים | |
|---|---|
value: boolean | true כדי למלא אוטומטית משבצות זמן שלא נבחרו, false כדי להשאיר אותן ללא שינוי. |
googletag.PrivacySettingsConfig
אובייקט הגדרה של הגדרות הפרטיות.
| מאפיינים | |
|---|---|
child | מציין אם הדף צריך להיות מסווג כתוכן שמיועד לילדים. |
limited | ההגדרה הזו מאפשרת להציג מודעות במצב מודעות מוגבלות כדי לעזור לבעלי תוכן דיגיטלי לעמוד בדרישות הרגולטוריות. |
non | ההגדרה מאפשרת להציג מודעות במצב מודעות ללא התאמה אישית כדי לעזור לבעלי האתרים לעמוד בדרישות הרגולטוריות. |
restrict | ההגדרה הזו מאפשרת להציג מודעות במצב עיבוד מוגבל כדי לעזור לבעלי תוכן דיגיטלי לעמוד בדרישות הרגולטוריות. |
traffic | השדה מציין אם הבקשות מייצגות תנועה שנרכשה או תנועה אורגנית. |
under | מציין אם לסמן בקשות להצגת מודעות כבקשות שמגיעות ממשתמשים מתחת לגיל ההסכמה. |
- ראה גם
מאפיינים
Optional childDirectedTreatment
childDirectedTreatment?: booleannull כדי למחוק את ההגדרה.Optional limitedAds
limitedAds?: booleanיש שתי דרכים להגדיר ב-GPT בקשה להצגת מודעות מוגבלות:
- באופן אוטומטי, באמצעות אות ממערכת לניהול הסכמה (CMP) של IAB TCF בגרסה 2.0.
- באופן ידני, על ידי הגדרת הערך של השדה הזה כ-
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, });
- ראה גם
Optional nonPersonalizedAds
nonPersonalizedAds?: booleanOptional restrictDataProcessing
restrictDataProcessing?: booleanOptional trafficSource
trafficSource?: TrafficSourceundefined בדוחות.- דוגמה
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (גרסה קודמת)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
Optional underAgeOfConsent
underAgeOfConsent?: booleannull כדי למחוק את ההגדרה.googletag.PubAdsService
הארכה
Serviceשירות המודעות בתכנים של בעלי תוכן דיגיטלי. השירות הזה משמש לאחזור ולהצגה של מודעות מחשבון Google Ad Manager שלכם.
| Methods | |
|---|---|
add | הפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. הועברה בירושה מ- |
clear | המודעות יוסרו מהמשבצות שצוינו ויוחלפו בתוכן ריק. |
clear | מנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. |
clear | מנקה פרמטרים מותאמים אישית של טירגוט למפתח ספציפי או לכל המפתחות. |
collapse | ההגדרה הזו מאפשרת לכווץ את תגי ה-div של מיקומי המודעות כך שהם לא יתפסו מקום בדף כשאין תוכן מודעה להצגה. |
disable | ההגדרה הזו משביתה את הבקשות להצגת מודעות במהלך טעינת הדף, אבל מאפשרת לשלוח בקשות להצגת מודעות באמצעות קריאה ל-PubAdsService.refresh. |
display | יוצר משבצת מודעה ומציג אותה עם הנתיב והגודל שצוינו של יחידת המודעות. |
enable | הפונקציה מאפשרת טעינה עצלה ב-GPT, כפי שמוגדר באובייקט ההגדרות. |
enable | ההגדרה הזו מפעילה מצב של בקשה יחידה לאחזור של כמה מודעות בו-זמנית. |
enable | אותות ל-GPT שמודעות וידאו יוצגו בדף. |
get | הפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון. |
get | מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה. |
get | אחזור רשימת המשבצות שמשויכות לשירות הזה. הועברה בירושה מ- |
get | הפונקציה מחזירה פרמטר ספציפי של טירגוט ברמת השירות שהוגדר. |
get | מחזירה את רשימת כל מפתחות הטירגוט המותאמים אישית ברמת השירות שהוגדרו. |
is | הפונקציה מחזירה ערך בוליאני שמציין אם בקשות ראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad. |
refresh | מאחזר ומציג מודעות חדשות במשבצות ספציפיות או בכל המשבצות בדף. |
remove | הסרה של מעבד אירוע שנרשם קודם. הועברה בירושה מ- |
set | הפונקציה מגדירה ערכים למאפייני AdSense שחלים על כל מיקומי המודעות בשירות Publisher Ads. |
set | מגדירה החרגה של קטגוריית מודעות ברמת הדף לשם התווית שצוין. |
set | הגדרה שמאפשרת להפעיל ולהשבית את המיקום של המודעות במרכז המסך לרוחב. |
set | המדיניות קובעת אם כל המודעות בדף צריכות לעבור עיבוד בכוח באמצעות מאגר SafeFrame. |
set | התכונה מעבירה מידע על מיקום מאתרים, כדי שתוכלו לטרגט פריטים ספציפיים למיקומים גיאוגרפיים ספציפיים. |
set | מאפשרת להגדיר את כל הגדרות הפרטיות באמצעות API יחיד, באמצעות אובייקט הגדרה. |
set | מגדיר את הערך של המזהה שסופק על ידי בעל האתר. |
set | ההגדרה הזו קובעת את ההעדפות ברמת הדף להגדרת SafeFrame. |
set | הגדרת פרמטרים מותאמים אישית של טירגוט למפתח נתון, שחלים על כל משבצות הפרסום בשירות Publisher Ads. |
set | הפונקציה מגדירה את פרטי תוכן הווידאו שיישלחו עם בקשות להצגת מודעות לצורכי טירגוט והחרגת תוכן. |
update | הפונקציה משנה את הקורלטור שנשלח עם בקשות להצגת מודעות, ובעצם מתחילה צפייה חדשה בדף. |
Methods
ניקוי
clear(slots?: Slot[]): booleanהמודעות יוסרו מהמשבצות שצוינו ויוחלפו בתוכן ריק. המשבצות יסומנו כמשבצות שלא נשלפו מהן מודעות.
בפרט, ניקוי משבצת מסיר את המודעה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות תחרותיות שקשורות למודעה הזו.
בפרט, ניקוי משבצת מסיר את המודעה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות תחרותיות שקשורות למודעה הזו.
- דוגמה
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (גרסה קודמת)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
| פרמטרים | |
|---|---|
| מערך המשבצות לניקוי. מערך הוא אופציונלי; אם לא מציינים אותו, כל המשבצות ינוקו. |
| החזרות | |
|---|---|
boolean | הפונקציה מחזירה true אם המשבצות פונו, אחרת היא מחזירה false. |
clearCategoryExclusions
clearCategoryExclusions(): PubAdsServiceמנקה את כל תוויות ההחרגה של קטגוריות מודעות ברמת הדף. האפשרות הזו שימושית אם רוצים לרענן את משבצת המודעה.
- דוגמה
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (גרסה קודמת)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
clearTargeting
clearTargeting(key?: string): PubAdsServiceמנקה פרמטרים מותאמים אישית של טירגוט למפתח ספציפי או לכל המפתחות.
- דוגמה
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (גרסה קודמת)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- ראה גם
| פרמטרים | |
|---|---|
| מפתח פרמטר הטירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל פרמטרי הטירגוט ינוקו. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
collapseEmptyDivs
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): booleanההגדרה הזו מאפשרת לכווץ את תגי ה-div של מיקומי המודעות כך שהם לא יתפסו מקום בדף כשאין תוכן מודעה להצגה. צריך להגדיר את המצב הזה לפני שמפעילים את השירות.
| פרמטרים | |
|---|---|
| האם לכווץ את משבצות המודעות עוד לפני שליפת המודעות. הפרמטר הזה הוא אופציונלי. אם לא תספקו ערך, המערכת תשתמש בערך ברירת המחדל false. |
| החזרות | |
|---|---|
boolean | מחזירה true אם מצב הכיווץ של רכיב ה-div הופעל, ו-false אם אי אפשר להפעיל את מצב הכיווץ כי השיטה נקראה אחרי שהשירות הופעל. |
disableInitialLoad
disableInitialLoad(): voidההגדרה הזו משביתה את הבקשות להצגת מודעות במהלך טעינת הדף, אבל מאפשרת לשלוח בקשות להצגת מודעות באמצעות קריאה ל-PubAdsService.refresh. צריך להגדיר את זה לפני שמפעילים את השירות. חובה להשתמש במצב אסינכרוני, אחרת לא ניתן לשלוח בקשות להצגת מודעות באמצעות
refresh.תצוגה
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): voidיוצר משבצת מודעה ומציג אותה עם הנתיב והגודל שצוינו של יחידת המודעות. השיטה הזו לא פועלת במצב של בקשה יחידה.
הערה: כשמפעילים את השיטה הזו, נוצרת תמונת מצב של מצב המשבצת והדף כדי להבטיח עקביות כששולחים את בקשת המודעה ומעבדים את התגובה. כל שינוי שמתבצע במצב של משבצת או דף אחרי הקריאה למתודה הזו (כולל טירגוט, הגדרות פרטיות, הפעלה של SafeFrame וכו') יחול רק על בקשות עוקבות של
הערה: כשמפעילים את השיטה הזו, נוצרת תמונת מצב של מצב המשבצת והדף כדי להבטיח עקביות כששולחים את בקשת המודעה ומעבדים את התגובה. כל שינוי שמתבצע במצב של משבצת או דף אחרי הקריאה למתודה הזו (כולל טירגוט, הגדרות פרטיות, הפעלה של SafeFrame וכו') יחול רק על בקשות עוקבות של
display() או refresh().- דוגמה
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (גרסה קודמת)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
| פרמטרים | |
|---|---|
adUnitPath: string | נתיב יחידת המודעות של מיקום המודעה שיוצג. |
size: GeneralSize | הרוחב והגובה של משבצת המודעה. |
| המזהה של ה-div שמכיל את מיקום המודעה או רכיב ה-div עצמו. |
| כתובת ה-URL של הקליק לשימוש במשבצת הזו. |
enableLazyLoad
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): voidהפונקציה מאפשרת טעינה עצלה ב-GPT, כפי שמוגדר באובייקט ההגדרות. דוגמאות מפורטות יותר זמינות בדוגמה Lazy loading.
הערה: אחזור עצלני ב-SRA פועל רק אם כל המיקומים נמצאים מחוץ למרווח האחזור.
הערה: אחזור עצלני ב-SRA פועל רק אם כל המיקומים נמצאים מחוץ למרווח האחזור.
- דוגמה
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (גרסה קודמת)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
| פרמטרים | |
|---|---|
| אובייקט ההגדרה מאפשר התאמה אישית של התנהגות עצלה. אם לא תגדירו הגדרות מסוימות, המערכת תשתמש בהגדרות ברירת מחדל שנקבעו על ידי Google, והן ישתנו עם הזמן. כדי להשבית הגדרה מסוימת, כמו מרווח אחזור, מגדירים את הערך ל--1.
|
enableSingleRequest
enableSingleRequest(): booleanההגדרה הזו מפעילה מצב של בקשה יחידה לאחזור של כמה מודעות בו-זמנית. לשם כך, צריך להגדיר את כל משבצות המודעות של בעל האתר ולהוסיף אותן ל-PubAdsService לפני שמפעילים את השירות. צריך להגדיר את מצב בקשה יחידה לפני שמפעילים את השירות.
| החזרות | |
|---|---|
boolean | הפונקציה מחזירה true אם הופעל מצב של בקשה יחידה, ו-false אם אי אפשר להפעיל מצב של בקשה יחידה כי הפונקציה נקראה אחרי שהשירות הופעל. |
enableVideoAds
enableVideoAds(): voidאותות ל-GPT שמודעות וידאו יוצגו בדף. ההגדרה הזו מאפשרת להגדיר אילוצים של החרגת מודעות מתחרות במודעות לרשת המדיה ובמודעות וידאו. אם תוכן הווידאו ידוע, צריך להתקשר אל PubAdsService.setVideoContent כדי להשתמש בהחרגת תוכן למודעות לרשת המדיה.
get
get(key: string): stringהפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון.
- דוגמה
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (גרסה קודמת)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין שרוצים לחפש. |
| החזרות | |
|---|---|
string | הערך הנוכחי של מפתח המאפיין, או null אם המפתח לא קיים. |
getAttributeKeys
getAttributeKeys(): string[]מחזירה את מפתחות המאפיינים שהוגדרו בשירות הזה.
- דוגמה
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (גרסה קודמת)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות מאפיינים שהוגדרו בשירות הזה. ההזמנה לא מוגדרת. |
getTargeting
getTargeting(key: string): string[]הפונקציה מחזירה פרמטר ספציפי של טירגוט ברמת השירות שהוגדר.
- דוגמה
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (גרסה קודמת)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
| פרמטרים | |
|---|---|
key: string | מפתח הטירגוט שצריך לחפש. |
| החזרות | |
|---|---|
string[] | הערכים שמשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה. |
getTargetingKeys
getTargetingKeys(): string[]הפונקציה מחזירה את רשימת כל מפתחות הטירגוט המותאמים אישית ברמת השירות שהוגדרו.
- דוגמה
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (גרסה קודמת)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות טירגוט. ההזמנה לא מוגדרת. |
isInitialLoadDisabled
isInitialLoadDisabled(): booleanהפונקציה מחזירה ערך בוליאני שמציין אם בקשות ראשוניות להצגת מודעות הושבתו בהצלחה על ידי קריאה קודמת ל-PubAdsService.disableInitialLoad.
| החזרות | |
|---|---|
boolean | הפונקציה מחזירה true אם שיחה קודמת אל PubAdsService.disableInitialLoad הצליחה, אחרת היא מחזירה false. |
רענון
refresh(slots?: Slot[], options?: {
changeCorrelator: boolean;
}): voidמאחזר ומציג מודעות חדשות במשבצות ספציפיות או בכל המשבצות בדף. הפונקציה פועלת רק במצב עיבוד אסינכרוני.
כדי שהפונקציה תפעל בצורה תקינה בכל הדפדפנים, צריך להוסיף קריאה ל-
רענון של מיקום מודעה מסיר את המודעה הישנה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות של מודעות מתחרות שקשורות למודעה הזו.
כדי שהפונקציה תפעל בצורה תקינה בכל הדפדפנים, צריך להוסיף קריאה ל-
refresh לפני הקריאה ל-display משבצת המודעה. אם לא מציינים את השיחה אל display, יכול להיות שהרענון לא יפעל כמו שצריך. אם רוצים, אפשר להשתמש בשיטה PubAdsService.disableInitialLoad כדי למנוע מ-display לאחזר מודעה.רענון של מיקום מודעה מסיר את המודעה הישנה מהצפייה בדף לטווח ארוך של GPT, כך שבקשות עתידיות לא יושפעו מחסימות או מהחרגות של מודעות מתחרות שקשורות למודעה הזו.
- דוגמה
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (גרסה קודמת)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
| פרמטרים | |
|---|---|
| המשבצות לרענון. מערך הוא אופציונלי; אם לא מציינים מערך, כל המשבצות ירועננו. |
| אפשרויות ההגדרה שמשויכות לקריאת הרענון הזו.
|
הגדרה
set(key: string, value: string): PubAdsServiceהפונקציה הזו מגדירה ערכים למאפייני AdSense שחלים על כל שטחי הפרסום במסגרת השירות Publisher Ads.
אם קוראים לפונקציה הזו יותר מפעם אחת עבור אותו מפתח, הערכים שהוגדרו קודם עבור המפתח הזה יוחלפו. צריך להגדיר את כל הערכים לפני שמבצעים קריאה ל-
אם קוראים לפונקציה הזו יותר מפעם אחת עבור אותו מפתח, הערכים שהוגדרו קודם עבור המפתח הזה יוחלפו. צריך להגדיר את כל הערכים לפני שמבצעים קריאה ל-
display או ל-refresh.- דוגמה
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (גרסה קודמת)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין. |
value: string | ערך המאפיין. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): PubAdsServiceמגדירה החרגה של קטגוריית מודעות ברמת הדף לשם התווית שצוין.
- דוגמה
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (גרסה קודמת)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
| פרמטרים | |
|---|---|
categoryExclusion: string | התווית להחרגת קטגוריות של מודעות שרוצים להוסיף. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setCentering
setCentering(centerAds: boolean): voidהגדרה שמאפשרת להפעיל ולהשבית את המיקום של המודעות במרכז המסך לרוחב. ההגדרה 'מרכוז' מושבתת כברירת מחדל. ב-gpt_mobile.js מדור קודם, ההגדרה של המיקום במרכז מופעלת כברירת מחדל.
צריך להפעיל את השיטה הזו לפני שמפעילים את
צריך להפעיל את השיטה הזו לפני שמפעילים את
display או את refresh, כי רק מודעות שמתבקשות אחרי הפעלת השיטה הזו יוצבו במרכז.- דוגמה
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (גרסה קודמת)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
| פרמטרים | |
|---|---|
centerAds: boolean | true כדי למרכז את המודעות, false כדי ליישר אותן לשמאל. |
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): PubAdsServiceההגדרה הזו קובעת אם כל המודעות בדף צריכות לעבור עיבוד בכוח באמצעות מאגר SafeFrame.
חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:
חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:
- ההגדרה הזו תיכנס לתוקף רק לגבי בקשות להצגת מודעות עתידיות שיישלחו לגבי המשבצות הרלוונטיות.
- אם מציינים הגדרה ברמת המשבצת, היא תמיד תבטל את ההגדרה ברמת הדף.
- אם ההגדרה היא
true(ברמת משבצת המודעה או ברמת הדף), המודעה תמיד תוצג באמצעות מאגר SafeFrame, ללא קשר לבחירה שנעשתה בממשק המשתמש של Google Ad Manager. - עם זאת, אם הערך מוגדר כ-
falseאו לא מוגדר, המודעה תוצג באמצעות מאגר SafeFrame, בהתאם לסוג הקריאייטיב ולבחירה שנעשתה בממשק המשתמש של Google Ad Manager. - חשוב להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של נכסי קריאייטיב שמנסים לצאת ממסגרות ה-iframe שלהם או שמסתמכים על כך שהם מוצגים ישירות בדף של בעל האתר.
- דוגמה
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (גרסה קודמת)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
| פרמטרים | |
|---|---|
forceSafeFrame: boolean | true כדי לחייב את כל המודעות בדף לעבור רינדור ב-SafeFrames ו-false כדי לשנות את ההגדרה הקודמת ל-false. אם לא צוין ערך קודם והגדרתם את הערך הזה ל-false, לא יחול שינוי. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שהפונקציה נקראה בו. |
setLocation
setLocation(address: string): PubAdsServiceהעברת נתוני מיקום מאתרים כדי שתוכלו לטרגט פריטי קמפיין למיקומים ספציפיים.
- דוגמה
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (גרסה קודמת)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
| פרמטרים | |
|---|---|
address: string | כתובת בפורמט חופשי. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setPrivacySettings
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsServiceאפשר להגדיר את כל הגדרות הפרטיות באמצעות API יחיד, באמצעות אובייקט הגדרה.
- דוגמה
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (גרסה קודמת)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
| פרמטרים | |
|---|---|
privacySettings: PrivacySettingsConfig | אובייקט שמכיל את הגדרות הפרטיות. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שהפונקציה נקראה בו. |
setPublisherProvidedId
setPublisherProvidedId(ppid: string): PubAdsServiceמגדיר את הערך של המזהה שסופק על ידי בעל האתר.
- דוגמה
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (גרסה קודמת)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
| פרמטרים | |
|---|---|
ppid: string | מזהה אלפאנומרי שסופק על ידי בעל האתר. הסיסמה צריכה לכלול בין 32 ל-150 תווים. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setSafeFrameConfig
setSafeFrameConfig(config: SafeFrameConfig): PubAdsServiceההגדרה הזו קובעת את ההעדפות ברמת הדף להגדרת SafeFrame. המערכת תתעלם ממפתחות לא מזוהים באובייקט ההגדרות. המערכת תתעלם מכל ההגדרות אם יועבר ערך לא תקין למפתח מוכר.
העדפות ברמת הדף יוחלפו בהעדפות ברמת יחידת המודעות, אם הן יצוינו.
העדפות ברמת הדף יוחלפו בהעדפות ברמת יחידת המודעות, אם הן יצוינו.
- דוגמה
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (גרסה קודמת)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
| פרמטרים | |
|---|---|
config: SafeFrameConfig | אובייקט ההגדרה. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setTargeting
setTargeting(key: string, value: string | string[]): PubAdsServiceהגדרת פרמטרים מותאמים אישית של טירגוט למפתח נתון, שחלים על כל משבצות הפרסום בשירות Publisher Ads. אם קוראים לפונקציה הזו כמה פעמים לאותו מפתח, הערכים הישנים יימחקו. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
- דוגמה
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (גרסה קודמת)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- ראה גם
| פרמטרים | |
|---|---|
key: string | מפתח פרמטר הטירגוט. |
value: string | string[] | ערך פרמטר טירגוט או מערך של ערכים. |
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שבו הופעלה השיטה. |
setVideoContent
setVideoContent(videoContentId: string, videoCmsId: string): voidהפונקציה מגדירה את פרטי תוכן הווידאו שיישלחו עם בקשות להצגת מודעות לצורכי טירגוט והחרגת תוכן. מודעות הווידאו יופעלו אוטומטית כשקוראים לשיטה הזו. במקרה של
videoContentId ו-videoCmsId, צריך להשתמש בערכים שמועברים לשירות להטמעת תוכן ב-Google Ad Manager.| פרמטרים | |
|---|---|
videoContentId: string | מזהה תוכן הווידאו. |
videoCmsId: string | מזהה מערכת ניהול התוכן של הסרטון. |
updateCorrelator
updateCorrelator(): PubAdsServiceהפונקציה משנה את הקורלטור שנשלח עם בקשות להצגת מודעות, ובעצם מתחילה צפייה חדשה בדף. הערך של פרמטר הקורלציה זהה לכל בקשות המודעות שמגיעות מצפייה אחת בדף, והוא ייחודי לכל צפייה בדף. ההגדרה רלוונטית רק למצב אסינכרוני.
הערה: ההגדרה הזו לא משפיעה על צפייה בדף לטווח ארוך ב-GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות בפועל בדף ואין לה תוקף.
הערה: ההגדרה הזו לא משפיעה על צפייה בדף לטווח ארוך ב-GPT, שמשקפת באופן אוטומטי את המודעות שמוצגות בפועל בדף ואין לה תוקף.
- דוגמה
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (גרסה קודמת)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
| החזרות | |
|---|---|
PubAdsService | אובייקט השירות שהפונקציה נקראה בו. |
googletag.ResponseInformation
אובייקט שמייצג תגובה יחידה לבקשה להצגת מודעה.
| מאפיינים | |
|---|---|
advertiser | המזהה של המפרסם. |
campaign | מזהה הקמפיין. |
creative | המזהה של הקריאייטיב. |
creative | מזהה התבנית של המודעה. |
line | המזהה של פריט ההזמנה. |
מאפיינים
advertiserId
advertiserId: numbercampaignId
campaignId: numbercreativeId
creativeId: numbercreativeTemplateId
creativeTemplateId: numberlineItemId
lineItemId: numbergoogletag.RewardedPayload
אובייקט שמייצג את התגמול שמשויך למודעה מתגמלת
| מאפיינים | |
|---|---|
amount | מספר הפריטים שכלולים בתגמול. |
type | סוג הפריט שנכלל בתגמול (לדוגמה, 'מטבע'). |
- ראה גם
מאפיינים
amount
amount: numbertype
type: stringgoogletag.Service
מחלקת שירות בסיסית שמכילה methods משותפים לכל השירותים.
| Methods | |
|---|---|
add | הפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. |
get | אחזור רשימת המשבצות שמשויכות לשירות הזה. |
remove | הסרה של מעבד אירוע שנרשם קודם. |
Methods
addEventListener
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Serviceהפונקציה registerListener מאפשרת להגדיר ולקרוא לפונקציית JavaScript כשאירוע GPT ספציפי מתרחש בדף. יש תמיכה באירועים הבאים:
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- דוגמה
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (גרסה קודמת)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
| פרמטרים | |
|---|---|
eventType: K | מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות. |
listener: ((arg: EventTypeMap[K]) => void) | פונקציה שמקבלת ארגומנט אחד של אובייקט אירוע. |
| החזרות | |
|---|---|
Service | אובייקט השירות שבו הופעלה השיטה. |
getSlots
removeEventListener
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): voidמסירה מעבד אירוע שנרשם בעבר.
- דוגמה
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (גרסה קודמת)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
| פרמטרים | |
|---|---|
eventType: K | מחרוזת שמייצגת את סוג האירוע שנוצר על ידי GPT. סוגי האירועים הם תלויי אותיות רישיות. |
listener: ((event: EventTypeMap[K]) => void) | פונקציה שמקבלת ארגומנט אחד של אובייקט אירוע. |
googletag.SizeMappingBuilder
אובייקטים של הגדרות מיפוי גדלים. הכלי הזה נועד לעזור לכם ליצור בקלות מפרטים של גדלים.
| Methods | |
|---|---|
add | הוספת מיפוי ממערך בגודל יחיד (שמייצג את אזור התצוגה) למערך בגודל יחיד או בגדלים מרובים שמייצג את מיקום המודעה. |
build | יוצר מפרט של מפת גדלים מהמיפויים שנוספו לכלי הזה. |
Methods
addSize
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilderהפונקציה מוסיפה מיפוי ממערך בגודל יחיד (שמייצג את אזור התצוגה) למערך בגודל יחיד או בגדלים מרובים שמייצג את מיקום המודעה.
- דוגמה
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (גרסה קודמת)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
| פרמטרים | |
|---|---|
viewportSize: SingleSizeArray | הגודל של אזור התצוגה עבור רשומת המיפוי הזו. |
slotSize: GeneralSize | הגדלים של משבצת המודעה לרשומה הזו של מיפוי. |
| החזרות | |
|---|---|
SizeMappingBuilder | הפניה לבונה הזה. |
build
build(): SizeMappingArrayיוצר מפרט של מפת מידות מהמיפויים שנוספו לאובייקט ה-builder הזה.
אם סופקו מיפויים לא תקינים, השיטה הזו תחזיר
הערה: ההתנהגות של הכלי לבניית מודעות אחרי קריאה לשיטה הזו לא מוגדרת.
אם סופקו מיפויים לא תקינים, השיטה הזו תחזיר
null. אחרת, היא מחזירה מפרט בפורמט הנכון כדי להעביר אותו אל Slot.defineSizeMapping.הערה: ההתנהגות של הכלי לבניית מודעות אחרי קריאה לשיטה הזו לא מוגדרת.
| החזרות | |
|---|---|
SizeMappingArray | התוצאה שנוצרה על ידי הכלי הזה. יכול להיות null אם סופקו מיפויים לא תקינים של גדלים. |
googletag.Slot
Slot הוא אובייקט שמייצג משבצת פרסום יחידה בדף.
| Methods | |
|---|---|
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. |
Methods
addService
addService(service: Service): Slotהוספת שירות למשבצת הזו.
- דוגמה
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (גרסה קודמת)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
| פרמטרים | |
|---|---|
service: Service | השירות שרוצים להוסיף. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
clearCategoryExclusions
clearCategoryExclusions(): Slotמנקה את כל התוויות של החרגות קטגוריות של מודעות ברמת המשבצת עבור המשבצת הזו.
- דוגמה
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (גרסה קודמת)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
clearTargeting
clearTargeting(key?: string): Slotמנקה פרמטרים ספציפיים או את כל פרמטרים של טירגוט מותאם אישית ברמת מיקום המודעה.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- ראה גם
| פרמטרים | |
|---|---|
| מפתח פרמטר הטירגוט. המפתח הוא אופציונלי. אם לא מציינים אותו, כל פרמטרי הטירגוט ינוקו. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
defineSizeMapping
defineSizeMapping(sizeMapping: SizeMappingArray): Slotמגדיר מערך של מיפויים מגודל מינימלי של אזור התצוגה לגודל של משבצת המודעה הזו.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping!);
| פרמטרים | |
|---|---|
sizeMapping: SizeMappingArray | מערך של מיפויי גדלים. אפשר להשתמש ב-SizeMappingBuilder כדי ליצור אותו. כל מיפוי גודל הוא מערך של שני רכיבים: SingleSizeArray ו-GeneralSize. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
get
get(key: string): stringהפונקציה מחזירה את הערך של מאפיין AdSense שמשויך למפתח הנתון של משבצת הפרסום הזו. כדי לראות את המאפיינים ברמת השירות שמועברים בירושה למשבצת הזו, משתמשים ב-PubAdsService.get.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין שרוצים לחפש. |
| החזרות | |
|---|---|
string | הערך הנוכחי של מפתח המאפיין, או null אם המפתח לא קיים. |
getAdUnitPath
getAdUnitPath(): stringמחזירה את הנתיב המלא של יחידת המודעות, עם קוד הרשת והנתיב של יחידת המודעות.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
| החזרות | |
|---|---|
string | נתיב של יחידת מודעות. |
getAttributeKeys
getAttributeKeys(): string[]הפונקציה מחזירה את רשימת מפתחות המאפיינים שהוגדרו במשבצת הזו. כדי לראות את המפתחות של מאפיינים ברמת השירות שעברו בירושה למשבצת הזו, משתמשים ב-PubAdsService.getAttributeKeys.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות מאפיינים. ההזמנה לא מוגדרת. |
getCategoryExclusions
getCategoryExclusions(): string[]מחזירה את התוויות להחרגת קטגוריות של מודעות במשבצת הזו.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
| החזרות | |
|---|---|
string[] | תוויות ההחרגה של קטגוריות המודעות במשבצת הזו, או מערך ריק אם לא הוגדרו תוויות. |
getResponseInformation
getResponseInformation(): ResponseInformationמחזירה את פרטי התגובה של המודעה. הנתון הזה מבוסס על התגובה האחרונה של המודעה למשבצת. אם הפונקציה הזו נקראת כשאין מודעה במשבצת, המערכת תחזיר את הערך
null.| החזרות | |
|---|---|
ResponseInformation | המידע העדכני על תגובת המודעה, או null אם אין מודעה במשבצת. |
getSlotElementId
getSlotElementId(): stringהפונקציה מחזירה את המזהה של מיקום המודעה
div שצוין כשמיקום המודעה הוגדר.- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
| החזרות | |
|---|---|
string | מזהה מיקום מודעה div. |
getTargeting
getTargeting(key: string): string[]הפונקציה מחזירה פרמטר מותאם אישית ספציפי לטירגוט שהוגדר במשבצת הזו. פרמטרים של טירגוט ברמת השירות לא נכללים.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
| פרמטרים | |
|---|---|
key: string | מפתח הטירגוט שצריך לחפש. |
| החזרות | |
|---|---|
string[] | הערכים שמשויכים למפתח הזה, או מערך ריק אם אין מפתח כזה. |
getTargetingKeys
getTargetingKeys(): string[]מחזירה את רשימת כל מפתחות הטירגוט בהתאמה אישית שהוגדרו במשבצת הזו. לא נכללים מפתחות טירגוט ברמת השירות.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
| החזרות | |
|---|---|
string[] | מערך של מפתחות טירגוט. ההזמנה לא מוגדרת. |
הגדרה
set(key: string, value: string): Slotהתג הזה מגדיר ערך למאפיין AdSense במשבצת המודעה הזו. הפעולה הזו תבטל את כל הערכים שהוגדרו ברמת השירות עבור המפתח הזה.
קריאה לשיטה הזו יותר מפעם אחת עבור אותו מפתח תבטל את הערכים שהוגדרו קודם למפתח הזה. צריך להגדיר את כל הערכים לפני שמבצעים קריאה ל-
קריאה לשיטה הזו יותר מפעם אחת עבור אותו מפתח תבטל את הערכים שהוגדרו קודם למפתח הזה. צריך להגדיר את כל הערכים לפני שמבצעים קריאה ל-
display או ל-refresh.- דוגמה
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (גרסה קודמת)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- ראה גם
| פרמטרים | |
|---|---|
key: string | שם המאפיין. |
value: string | ערך המאפיין. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): Slotהגדרת תווית להחרגת קטגוריות של מודעות ברמת המשבצת במשבצת הזו.
- דוגמה
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (גרסה קודמת)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
| פרמטרים | |
|---|---|
categoryExclusion: string | התווית להחרגת קטגוריות של מודעות שרוצים להוסיף. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
setClickUrl
setClickUrl(value: string): Slotמגדיר את כתובת ה-URL של הקליק שאליה המשתמשים יופנו אחרי שהם ילחצו על המודעה.
השרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת ה-URL של הקליק מוחלפת. כל כתובת URL של דף נחיתה שמשויכת לקריאייטיב שמוצג מתווספת לערך שצוין. שיחות שמתבצעות לאחר מכן מחליפות את הערך. האפשרות הזו זמינה רק לבקשות שלא קשורות ל-SRA.
השרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת ה-URL של הקליק מוחלפת. כל כתובת URL של דף נחיתה שמשויכת לקריאייטיב שמוצג מתווספת לערך שצוין. שיחות שמתבצעות לאחר מכן מחליפות את הערך. האפשרות הזו זמינה רק לבקשות שלא קשורות ל-SRA.
- דוגמה
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (גרסה קודמת)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
| פרמטרים | |
|---|---|
value: string | כתובת ה-URL של הקליק שרוצים להגדיר. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
setCollapseEmptyDiv
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slotההגדרה קובעת אם משבצת המודעה
div תוסתר כשאין מודעה במשבצת. ההגדרה הזו מבטלת את ההגדרות ברמת השירות.- דוגמה
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (גרסה קודמת)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
| פרמטרים | |
|---|---|
collapse: boolean | האם לכווץ את מיקום המודעה אם לא מוחזרת מודעה. |
| האם לכווץ את משבצת המודעה עוד לפני שליפת המודעה. המערכת מתעלמת מההגדרה אם הערך של collapse הוא לא true. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
setConfig
setConfig(slotConfig: SlotSettingsConfig): voidהגדרת אפשרויות כלליות של חריץ הזמן הזה.
| פרמטרים | |
|---|---|
slotConfig: SlotSettingsConfig | אובייקט ההגדרה. |
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): Slotההגדרה הזו קובעת אם המערכת צריכה להציג את המודעות במשבצת הזו באמצעות מאגר SafeFrame.
חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:
חשוב לזכור את הנקודות הבאות כשמשתמשים ב-API הזה:
- ההגדרה הזו תיכנס לתוקף רק לגבי בקשות להצגת מודעות עתידיות שיישלחו לגבי המשבצות הרלוונטיות.
- אם מציינים הגדרה ברמת המשבצת, היא תמיד תבטל את ההגדרה ברמת הדף.
- אם ההגדרה היא
true(ברמת משבצת המודעה או ברמת הדף), המודעה תמיד תוצג באמצעות מאגר SafeFrame, ללא קשר לבחירה שנעשתה בממשק המשתמש של Google Ad Manager. - עם זאת, אם הערך מוגדר כ-
falseאו לא מוגדר, המודעה תוצג באמצעות מאגר SafeFrame, בהתאם לסוג הקריאייטיב ולבחירה שנעשתה בממשק המשתמש של Google Ad Manager. - חשוב להשתמש ב-API הזה בזהירות, כי הוא עלול להשפיע על ההתנהגות של נכסי קריאייטיב שמנסים לצאת ממסגרות ה-iframe שלהם או שמסתמכים על כך שהם מוצגים ישירות בדף של בעל האתר.
- דוגמה
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (גרסה קודמת)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
| פרמטרים | |
|---|---|
forceSafeFrame: boolean | true כדי לחייב את כל המודעות במשבצת הזו לעבור עיבוד ב-SafeFrame, ו-false כדי לבטל את ההסכמה להגדרה ברמת הדף (אם קיימת). הגדרת הערך false כשלא מציינים אותו ברמת הדף לא תשנה שום דבר. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
setSafeFrameConfig
setSafeFrameConfig(config: SafeFrameConfig): Slotההגדרה הזו קובעת את ההעדפות ברמת משבצת המודעה להגדרת SafeFrame. המערכת תתעלם ממפתחות לא מזוהים באובייקט ההגדרות. המערכת תתעלם מכל ההגדרות אם יועבר ערך לא תקין למפתח מוכר.
אם צוינו העדפות ברמת משבצת המודעה, הן יחליפו את ההעדפות ברמת הדף.
אם צוינו העדפות ברמת משבצת המודעה, הן יחליפו את ההעדפות ברמת הדף.
- דוגמה
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (גרסה קודמת)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
| פרמטרים | |
|---|---|
config: SafeFrameConfig | אובייקט ההגדרה. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
setTargeting
setTargeting(key: string, value: string | string[]): Slotהגדרת פרמטר מותאם אישית לטירגוט במשבצת הזו. אם קוראים לשיטה הזו כמה פעמים עבור אותו מפתח, הערכים הישנים יימחקו. ערכים שמוגדרים כאן יחליפו פרמטרים לטירגוט שהוגדרו ברמת השירות. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- ראה גם
| פרמטרים | |
|---|---|
key: string | מפתח פרמטר הטירגוט. |
value: string | string[] | ערך פרמטר טירגוט או מערך של ערכים. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
updateTargetingFromMap
updateTargetingFromMap(map: {
[adUnitPath: string]: string | string[];
}): Slotהפונקציה מגדירה פרמטרים מותאמים אישית לטירגוט במשבצת הזו, ממיפוי של מפתח:ערך באובייקט JSON. הפעולה הזו זהה לקריאה לפונקציה Slot.setTargeting לכל ערכי המפתח של האובייקט. המפתחות האלה מוגדרים בחשבון Google Ad Manager.
הערות:
הערות:
- במקרה של החלפה, רק הערך האחרון יישמר.
- אם הערך הוא מערך, כל ערך קודם יוחלף ולא ימוזג.
- ערכים שמוגדרים כאן יחליפו פרמטרים לטירגוט שהוגדרו ברמת השירות.
- דוגמה
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (גרסה קודמת)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
| פרמטרים | |
|---|---|
map: { | מיפוי של צמד מפתח/ערך של פרמטר טירגוט. |
| החזרות | |
|---|---|
Slot | אובייקט המשבצת שעליו הופעלה השיטה. |
googletag.config
ממשק ההגדרה הראשי להגדרות ברמת הדף.
| ממשקים | |
|---|---|
Ad | הגדרות לשליטה בהרחבת המודעות. |
Ad | הגדרות לשליטה בהתנהגות של מודעות AdSense. |
Component | אובייקט שמייצג מכירה פומבית אחת של רכיבים במכירה פומבית של מודעות במכשיר. |
Interstitial | אובייקט שמגדיר את ההתנהגות של משבצת מודעות מעברון יחידה. |
Lazy | הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT. |
Page | ממשק ההגדרה הראשי להגדרות ברמת הדף. |
Privacy | הגדרות לשליטה בטיפול בפרטיות של בעלי אתרים. |
Publisher | אובייקט ההגדרה של אותות שמספקים בעלי תוכן דיגיטלי (PPS). |
Safe | הגדרות לשליטה ב-SafeFrame ב-GPT. |
Slot | ממשק ההגדרות הראשי להגדרות ברמת המשבצת. |
Taxonomy | אובייקט שמכיל את הערכים של Taxonomy יחיד. |
Video | הגדרות לקביעת הגדרות שקשורות למודעות וידאו. |
| כינויי סוגים | |
|---|---|
Interstitial | טריגרים נתמכים של מודעות מעברון. |
Privacy | אמצעי הגנה על פרטיות שנתמכים ב-AdSense לבעלי תוכן דיגיטלי. |
Taxonomy | טקסונומיות נתמכות לאותות שמספקים בעלי תוכן דיגיטלי (PPS). |
כינויי סוגים
InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar"PrivacyTreatment
PrivacyTreatment: "disablePersonalization"טקסונומיה
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"googletag.config.AdExpansionConfig
הגדרות לשליטה בהרחבת המודעות.
| מאפיינים | |
|---|---|
enabled | האם הרחבת המודעות מופעלת או מושבתת. |
- דוגמה
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (גרסה קודמת)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
מאפיינים
Optional מופעל
enabled?: booleanהגדרת הערך הזה מבטלת את ברירת המחדל שהוגדרה ב-Google Ad Manager.
googletag.config.AdSenseAttributesConfig
הגדרות לשליטה בהתנהגות של מודעות AdSense.
אפשר להשתמש במאפיינים האלה כדי לשנות הגדרות בצד השרת על בסיס כל בקשה.
אפשר להשתמש במאפיינים האלה כדי לשנות הגדרות בצד השרת על בסיס כל בקשה.
| מאפיינים | |
|---|---|
adsense | פורמט מודעה ב-AdSense. |
adsense | מזהי ערוצים ב-AdSense. |
adsense | האם מצב הבדיקה מופעל או לא. |
document | השפה של הדף שבו מוצגות המודעות. |
page | כתובת ה-URL של הדף שבו מוצגות המודעות. |
מאפיינים
Optional adsense_ad_format
adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"Optional adsense_channel_ids
adsense_channel_ids?: stringהערכים המותרים הם מזהי ערוצים שמופרדים באמצעות '+'.
דוגמה:
271828183+314159265Optional adsense_test_mode
adsense_test_mode?: "on"כשהערך הוא
on, המודעות מסומנות כמודעות לבדיקה בלבד, והן לא ייכללו בספירה או בחיוב. צריך לבטל את ההגדרה הזו בתנועה בסביבת הייצור, שאינה תנועת בדיקה.Optional document_language
document_language?: stringהערכים המותרים הם קודי שפה תקינים לפי תקן ISO 639-1.
דוגמה:
enOptional page_url
page_url?: stringהערכים המותרים הם כתובות URL תקינות.
דוגמה:
http://www.example.comgoogletag.config.ComponentAuctionConfig
אובייקט שמייצג מכירה פומבית אחת של רכיבים במכירה פומבית של מודעות במכשיר.
| מאפיינים | |
|---|---|
auction | אובייקט של הגדרת מכרז לרכיב הזה. |
config | מפתח ההגדרה שמשויך למכרז הרכיבים הזה. |
מאפיינים
auctionConfig
auctionConfig: {
auctionSignals?: unknown;
decisionLogicURL: string;
interestGroupBuyers?: string[];
perBuyerExperimentGroupIds?: {
[buyer: string]: number;
};
perBuyerGroupLimits?: {
[buyer: string]: number;
};
perBuyerSignals?: {
[buyer: string]: unknown;
};
perBuyerTimeouts?: {
[buyer: string]: number;
};
seller: string;
sellerExperimentGroupId?: number;
sellerSignals?: unknown;
sellerTimeout?: number;
trustedScoringSignalsURL?: string;
}אם הערך הזה מוגדר כ-
null, כל הגדרה קיימת של configKey שצוין תימחק.- דוגמה
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (גרסה קודמת)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
configKey
configKey: stringהערך הזה לא יכול להיות ריק והוא צריך להיות ייחודי. אם לשני אובייקטים של
ComponentAuctionConfig יש אותו ערך configKey, האובייקט האחרון שהוגדר יחליף את ההגדרות הקודמות.googletag.config.InterstitialConfig
אובייקט שמגדיר את ההתנהגות של משבצת מודעות מעברון יחידה.
| מאפיינים | |
|---|---|
require | האם נדרשת הסכמה לאחסון מקומי כדי להציג את מודעת המעברון הזו. |
triggers | הגדרת הטריגר של מודעת המעברון הזו. |
מאפיינים
Optional requireStorageAccess
requireStorageAccess?: booleanGPT משתמש באחסון מקומי כדי לאכוף מכסת תדירות למודעות מעברון. עם זאת, משתמשים שלא הביעו הסכמה לאחסון מקומי עדיין עומדים בדרישות להצגת מודעות מעברון. הגדרת המאפיין הזה לערך
true מבטלת את התנהגות ברירת המחדל, ומבטיחה שמודעות מעברון יוצגו רק למשתמשים שנתנו הסכמה לאחסון מקומי.- דוגמה
JavaScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
JavaScript (גרסה קודמת)
// Opt out of showing interstitials to users // without local storage consent. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
TypeScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
Optional טריגרים
triggers?: Partial<Record<InterstitialTrigger, boolean>>הגדרת הערך של טריגר למודעה בין-דףית ל-
true תפעיל אותו, והגדרת הערך ל-false תשבית אותו. הפעולה הזו תבטל את ערכי ברירת המחדל שהוגדרו ב-Google Ad Manager.- דוגמה
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (גרסה קודמת)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- ראה גם
googletag.config.LazyLoadConfig
הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT.
| מאפיינים | |
|---|---|
fetch | המרחק המינימלי מהאזור הנוכחי של חלון התצוגה שנדרש כדי שמשבצת תהיה כשירה לשליחת בקשה להצגת מודעה, בערך שמוצג כאחוז מגודל חלון התצוגה. |
mobile | מכפיל שמוחל על שוליים במכשירים ניידים. |
render | המרחק המינימלי מאזור התצוגה הנוכחי שנדרש כדי שמשבצת תהיה מוכנה להצגת מודעה, מבוטא כאחוז מגודל אזור התצוגה. |
מאפיינים
Optional fetchMarginPercent
fetchMarginPercent?: numberההגדרה הזו משמשת בשילוב עם renderMarginPercent, ומאפשרת אחזור מראש של מודעה, אבל המתנה להצגה ולהורדה של משאבי משנה אחרים. לכן, הערך הזה תמיד צריך להיות גדול מ-renderMarginPercent או שווה לו.
ערך של
0 פירושו 'כשהמשבצת נכנסת לאזור התצוגה', ערך של 100 פירושו 'כשהמודעה נמצאת במרחק של אזור תצוגה אחד' וכן הלאה.Optional mobileScaling
mobileScaling?: numberכך אפשר להגדיר שוליים שונים בנייד ובמחשב, כי גדלי אזור התצוגה ומהירויות הגלילה עשויים להיות שונים. לדוגמה, ערך של 2.0 יכפיל את כל השוליים בניידים, ויגדיל את המרחק המינימלי שבו מיקום מודעה יכול להיות מחוץ לאזור התצוגה לפני שליפה ועיבוד.
Optional renderMarginPercent
renderMarginPercent?: numberההגדרה הזו משמשת בשילוב עם fetchMarginPercent, ומאפשרת אחזור מראש של מודעה, אבל המתנה לעיבוד ולהורדה של משאבי משנה אחרים. לכן, הערך הזה תמיד צריך להיות קטן מהערך של fetchMarginPercent או שווה לו.
ערך של
0 פירושו 'כשהמשבצת נכנסת לאזור התצוגה', ערך של 100 פירושו 'כשהמודעה נמצאת במרחק של אזור תצוגה אחד' וכן הלאה.googletag.config.PageSettingsConfig
ממשק ההגדרה הראשי להגדרות ברמת הדף.
אפשר להגדיר כמה תכונות באמצעות קריאת API אחת.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. לרשימת התכונות, אפשר לעיין בשדות בסוג PageSettingsConfig שבהמשך.
דוגמאות:
אפשר להגדיר כמה תכונות באמצעות קריאת API אחת.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. לרשימת התכונות, אפשר לעיין בשדות בסוג PageSettingsConfig שבהמשך.
דוגמאות:
- רק תכונות שמצוינות בקריאה googletag.setConfig משתנות.
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה מסוימת מתעדכנות בכל קריאה ל-googletag.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- כדי לנקות את כל ההגדרות של תכונה מסוימת, מעבירים את הערך
null.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
| מאפיינים | |
|---|---|
ad | הגדרות לשליטה בהרחבת המודעות. |
adsense | הגדרה לקביעת מאפייני AdSense. |
ad | הוצא משימוש. |
category | הגדרה להחרגת קטגוריות של מודעות. |
centering | הגדרה לשליטה במיקום המודעות במרכז האופקי. |
collapse | הגדרה לשליטה בהתנהגות של צמצום מיקומי מודעות. |
disable | הגדרה לשליטה במועד שליחת הבקשות להצגת מודעות. |
lazy | הגדרות לשליטה בשימוש בטעינה מדורגת ב-GPT. |
location | הגדרה לטירגוט גיאוגרפי של פריטי מידע למיקומים גיאוגרפיים. |
pps | הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS). |
privacy | הגדרות לשליטה בטיפול בפרטיות של בעלי אתרים. |
safe | הגדרות לשליטה בשימוש ב-SafeFrame ב-GPT. |
single | הגדרה להפעלה או להשבתה של ארכיטקטורת בקשה בודדת (SRA). |
targeting | הגדרה לשליטה בטירגוט של צמדי מפתח/ערך. |
thread | הגדרה שקובעת אם GPT צריך להחזיר את השרשור של JavaScript כשמבקשים קריאייטיבים ומעבדים אותם. |
video | הגדרות לשליטה במודעות וידאו. |
מאפיינים
Optional adExpansion
adExpansion?: AdExpansionConfigOptional adsenseAttributes
adsenseAttributes?: AdSenseAttributesConfigמאפייני AdSense שמוגדרים באמצעות ההגדרה הזו יחולו על כל מיקומי המודעות בדף. אפשר לקרוא להגדרה הזו כמה פעמים כדי להגדיר כמה ערכים של מאפיינים, או כדי להחליף ערכים קיימים.
שינויים במאפייני AdSense חלים רק על מודעות שהבקשה להצגתן נשלחה אחרי הקריאה לשיטה הזו. לכן מומלץ לקרוא לשיטה הזו לפני כל קריאה ל-googletag.display או ל-PubAdsService.refresh.
- דוגמה
JavaScript
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
JavaScript (גרסה קודמת)
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
TypeScript
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
Optional adYield
adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"Optional categoryExclusion
categoryExclusion?: string[]- דוגמה
JavaScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
JavaScript (גרסה קודמת)
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
TypeScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
Optional centering
centering?: booleanשינויים במרכוז אופקי חלים רק על מודעות שהבקשה להצגתן נשלחה אחרי שהופעלה השיטה הזו. לכן מומלץ לקרוא לשיטה הזו לפני כל קריאה ל-googletag.display או ל-PubAdsService.refresh.
- דוגמה
JavaScript
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
JavaScript (גרסה קודמת)
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
TypeScript
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
Optional collapseDiv
collapseDiv?: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"משבצת מודעה מצומצמת לא תופסת מקום בדף.
ערכים נתמכים:
-
null(ברירת מחדל): המשבצת לא תכווץ. -
DISABLED: המיקום לא יתכווץ, בין אם מוחזרת מודעה ובין אם לא. -
BEFORE_FETCH: המיקום יתחיל במצב מכווץ, ויתרחב כשמודעה תוחזר. -
ON_NO_FILL: המיקום יתחיל כמוצג במצב מורחב, ויתכווץ אם לא תוחזר מודעה.
- דוגמה
JavaScript
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
JavaScript (גרסה קודמת)
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
TypeScript
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
Optional disableInitialLoad
disableInitialLoad?: booleanכברירת מחדל, השיטה googletag.display רושמת משבצות פרסום ושולחת בקשות להצגת מודעות במשבצות האלה. עם זאת, יש מקרים שבהם עדיף להפריד בין הפעולות האלה, כדי לשלוט בצורה מדויקת יותר במועד הטעינה של תוכן המודעה.
אם מפעילים את ההגדרה הזו, לא תוגש בקשה להצגת מודעות במשבצות רשומות כשקוראים לפונקציה
display(). במקום זאת, צריך לבצע קריאה נפרדת אל PubAdsService.refresh כדי ליזום בקשה להצגת מודעה.חובה לקרוא לשיטה הזו לפני שקוראים ל-googletag.enableServices.
- דוגמה
JavaScript
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
JavaScript (גרסה קודמת)
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
TypeScript
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
Optional lazyLoad
lazyLoad?: LazyLoadConfigטעינה עצלה היא טכניקה לעיכוב הבקשה להצגת מודעות והעיבוד שלהן עד שהן מתקרבות לאזור התצוגה של המשתמש. דוגמה מפורטת יותר אפשר לראות בדוגמה של טעינה עצלה.
הערה: אם האפשרות
singleRequest מופעלת, אחזור עצלני פועל רק כשכל המשבצות נמצאות מחוץ למרווח האחזור.כל הגדרות הטעינה העצלה שלא צוינו כשקוראים ל-
setConfig() ישתמשו בערך ברירת מחדל שהוגדר על ידי Google. יכול להיות שברירות המחדל האלה ישתנו עם הזמן. כדי להשבית הגדרה מסוימת, מגדירים את הערך ל-null.- דוגמה
JavaScript
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
JavaScript (גרסה קודמת)
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
TypeScript
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
Optional מיקום
location?: string- דוגמה
JavaScript
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
JavaScript (גרסה קודמת)
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
TypeScript
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
Optional pps
הגדרות לשליטה באותות שמספקים בעלי תוכן דיגיטלי (PPS).
Optional privacyTreatments
privacyTreatments?: PrivacyTreatmentsConfigOptional safeFrame
safeFrame?: SafeFrameConfigהערכים שמוגדרים באמצעות ההגדרה הזו יחולו על כל שטחי הפרסום בדף. יכול להיות שערכים של משבצות מודעות ספציפיות יגברו על הערכים האלה באמצעות SlotSettingsConfig.safeFrame.
- דוגמה
JavaScript
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
JavaScript (גרסה קודמת)
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
TypeScript
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
Optional singleRequest
singleRequest?: booleanכש-SRA מופעלת, כל משבצות המודעות שהוגדרו לפני קריאה ל-googletag.display או ל-PubAdsService.refresh יצורפו לבקשה אחת להצגת מודעה. השיטה הזו משפרת את הביצועים, אבל היא גם נחוצה כדי לוודא שהמערכת מכבדת את ההגבלות על חסימות ואת ההחרגות התחרותיות.
כש-SRA מושבת, כל משבצת פרסום נשלחת בבקשה בנפרד. זו התנהגות ברירת המחדל של GPT.
חובה להפעיל את השיטה הזו לפני שמפעילים את השיטה googletag.enableServices.
- דוגמה
JavaScript
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
JavaScript (גרסה קודמת)
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
TypeScript
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
Optional טירגוט
targeting?: Record<string, string | string[]>הטירגוט שמוגדר באמצעות ההגדרה הזו יחול על כל שטחי הפרסום בדף. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה צמדים של מפתח/ערך לטירגוט, או כדי להחליף ערכים קיימים. מגדירים את מילות המפתח לטירגוט בחשבון Google Ad Manager.
- דוגמה
JavaScript
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
JavaScript (גרסה קודמת)
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
TypeScript
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
- ראה גם
Optional threadYield
threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"GPT יעביר את השרשור רק לדפדפנים שתומכים ב-API Scheduler.postTask או Scheduler.yield.
ערכים נתמכים:
-
null(ברירת מחדל): GPT יפנה את השרשור של JavaScript למיקומים מחוץ לאזור התצוגה. -
ENABLED_ALL_SLOTS: תג GPT יחזיר את השרשור של JavaScript לכל המיקומים, בלי קשר לשאלה אם המיקום נמצא באזור התצוגה. -
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 });
- ראה גם
Optional videoAds
videoAds?: VideoAdsConfig- דוגמה
JavaScript
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
JavaScript (גרסה קודמת)
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
TypeScript
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
- ראה גם
googletag.config.PrivacyTreatmentsConfig
הגדרות לשליטה בטיפול בפרטיות של בעלי אתרים.
| מאפיינים | |
|---|---|
treatments | מערך של אמצעים לשמירה על פרטיות בעלי התוכן הדיגיטלי שאפשר להפעיל. |
מאפיינים
טיפולים
treatments: "disablePersonalization"[]- דוגמה
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (גרסה קודמת)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvidedSignalsConfig
אובייקט ההגדרה של אותות שמספקים בעלי תוכן דיגיטלי (PPS).
| מאפיינים | |
|---|---|
taxonomies | אובייקט שמכיל מיפויים של Taxonomy או null כדי לנקות את ההגדרה. |
- דוגמה
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (גרסה קודמת)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
מאפיינים
טקסונומיות
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>googletag.config.SafeFrameConfig
הגדרות לשליטה ב-SafeFrame ב-GPT.
| מאפיינים | |
|---|---|
allow | האם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי כיסוי תוכן הדף. |
allow | האם SafeFrame צריך לאפשר לתוכן המודעה להתרחב על ידי דחיפת תוכן הדף. |
force | האם צריך לכפות הצגה של מודעות באמצעות מאגר SafeFrame. |
sandbox | האם צריך להשתמש במאפיין ארגז החול של HTML5 ב-SafeFrame כדי למנוע ניווט ברמה העליונה ללא אינטראקציה של המשתמש. |
use | הוצא משימוש. האם SafeFrame צריך להשתמש בתת-דומיינים אקראיים עבור נכסי קריאייטיב במכירה ישירה לא פרוגרמטית. |
מאפיינים
Optional allowOverlayExpansion
allowOverlayExpansion?: booleanOptional allowPushExpansion
allowPushExpansion?: booleanOptional forceSafeFrame
forceSafeFrame?: booleanOptional ארגז חול
sandbox?: booleantrue (אי אפשר להגדיר אותו כ-false). שימו לב שהמאפיין sandbox משבית תוספים (לדוגמה, Flash).Optional useUniqueDomain
useUniqueDomain?: booleannull כדי לנקות את הערך המאוחסן.הערה: התכונה הזו מופעלת כברירת מחדל.
googletag.config.SlotSettingsConfig
ממשק ההגדרה הראשי להגדרות ברמת משבצת המודעה.
אפשר להגדיר כמה תכונות באמצעות קריאת API אחת למשבצת מודעה אחת.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. לרשימת התכונות, אפשר לעיין בשדות בסוג SlotSettingsConfig שבהמשך.
דוגמאות:
אפשר להגדיר כמה תכונות באמצעות קריאת API אחת למשבצת מודעה אחת.
כל המאפיינים שמפורטים בהמשך הם דוגמאות ולא משקפים תכונות בפועל שמשתמשות ב-setConfig. לרשימת התכונות, אפשר לעיין בשדות בסוג SlotSettingsConfig שבהמשך.
דוגמאות:
- רק תכונות שמצוינות בקריאה Slot.setConfig משתנות.
const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- כל ההגדרות של תכונה נתונה מתעדכנות בכל קריאה ל-Slot.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- כדי לנקות את כל ההגדרות של תכונה מסוימת, מעבירים את הערך
null.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
| מאפיינים | |
|---|---|
ad | הגדרות להרחבת המודעות. |
adsense | הגדרה לקביעת מאפייני AdSense. |
category | הגדרה להחרגת קטגוריות של מודעות. |
click | הגדרה לקביעת כתובת ה-URL שאליה המשתמשים יופנו אחרי שהם ילחצו על המודעה. |
collapse | הגדרה לקביעת אופן הכיווץ של משבצת המודעה. |
component | מערך של מכרזים של רכיבים שייכללו במכרז של מודעות במכשיר. |
interstitial | הגדרות שקובעות את אופן הפעולה של משבצת למודעה מעברית. |
safe | הגדרות לקביעת השימוש ב-SafeFrame ב-GPT. |
targeting | הגדרה לקביעת טירגוט לפי זוגות מפתח/ערך. |
מאפיינים
Optional adExpansion
adExpansion?: AdExpansionConfig- ראה גם
Optional adsenseAttributes
adsenseAttributes?: AdSenseAttributesConfigמאפייני AdSense שמוגדרים באמצעות ההגדרה הזו יחולו רק על מיקום המודעה. אפשר לקרוא להגדרה הזו כמה פעמים כדי להגדיר כמה ערכים של מאפיינים, או כדי להחליף ערכים קיימים.
שינויים במאפייני AdSense חלים רק על מודעות שהבקשה להצגתן נשלחה אחרי הקריאה לשיטה הזו. לכן מומלץ לקרוא לשיטה הזו לפני כל קריאה ל-googletag.display או ל-PubAdsService.refresh.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
Optional categoryExclusion
categoryExclusion?: string[]- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
Optional clickUrl
clickUrl?: stringהשרתים של Google Ad Manager עדיין מתעדים קליק גם אם כתובת ה-URL של הקליק מוחלפת. כל כתובת URL של דף נחיתה שמשויכת לקריאייטיב שמוצג מתווספת לערך שצוין. אם תגדירו את הערך הזה יותר מפעם אחת, הוא יחליף את הערך שהוגדר קודם. העברת הערך
null תנקה את הערך.הערה: ההגדרה הזו רלוונטית רק לבקשות שאינן SRA.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
Optional collapseDiv
collapseDiv?: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"מיקום מודעה מכווץ לא תופס מקום בדף.
ערכים נתמכים:
-
null(ברירת מחדל): המשבצת לא תכווץ. -
DISABLED: המיקום לא יתכווץ, בין אם מוחזרת מודעה ובין אם לא. -
BEFORE_FETCH: המיקום יתחיל במצב מכווץ, ויתרחב כשמודעה תוחזר. -
ON_NO_FILL: המיקום יתחיל כמוצג במצב מורחב, ויתכווץ אם לא תוחזר מודעה.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
Optional componentAuction
componentAuction?: ComponentAuctionConfig[]Optional interstitial
interstitial?: InterstitialConfigOptional safeFrame
safeFrame?: SafeFrameConfigהערכים שמוגדרים באמצעות ההגדרה הזו יחולו רק על מיקום המודעה, ויגברו על הערכים שמוגדרים באמצעות PageSettingsConfig.safeFrame.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
Optional טירגוט
targeting?: Record<string, string | string[]>הטירגוט שמוגדר באמצעות ההגדרה הזו יחול רק על משבצת המודעה. אפשר להפעיל את ההגדרה הזו כמה פעמים כדי להגדיר כמה צמדים של מפתח/ערך לטירגוט, או כדי להחליף ערכים קיימים. מגדירים את מילות המפתח לטירגוט בחשבון Google Ad Manager.
- דוגמה
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
JavaScript (גרסה קודמת)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
- ראה גם
googletag.config.TaxonomyData
אובייקט שמכיל את הערכים של Taxonomy יחיד.
| מאפיינים | |
|---|---|
values | רשימה של ערכים של טקסונומיה. |
מאפיינים
ערכים
values: readonly string[]googletag.config.VideoAdsConfig
הגדרות לקביעת הגדרות שקשורות למודעות וידאו.
| מאפיינים | |
|---|---|
enable | האם מודעות וידאו יוצגו בדף. |
video | מזהה מקור תוכן הווידאו. |
video | מזהה תוכן הווידאו. |
מאפיינים
enableVideoAds
enableVideoAds: booleanאם הערך הוא
true, מופעלות הגבלות על החרגת תוכן במודעות לרשת המדיה ובמודעות וידאו.אם תוכן הווידאו ידוע, צריך להגדיר את videoContentId ואת videoCmsId לערכים שסופקו לשירות הטמעת התוכן של Google Ad Manager כדי להשתמש בהחרגת תוכן במודעות לרשת המדיה.
Optional videoCmsId
videoCmsId?: stringזהו ערך ייחודי שמוקצה על ידי שירות הטמעת התוכן של Google Ad Manager כדי לזהות את המקור של תוכן הווידאו שצוין על ידי videoContentId.
- ראה גם
Optional videoContentId
videoContentId?: stringזהו ערך ייחודי שמזהה סרטון מסוים ממקור התוכן שצוין על ידי videoCmsId. הערך הזה מוקצה על ידי מערכת ניהול התוכן שמארחת את תוכן הווידאו שלכם.
- ראה גם
googletag.enums
זהו מרחב השמות שבו GPT משתמש עבור סוגי enum.
| ערכי ספירה | |
|---|---|
Out | פורמטים של מודעות מחוץ לדף שנתמכים על ידי GPT. |
Traffic | מקורות תנועה שנתמכים על ידי GPT. |
ערכי ספירה
OutOfPageFormat
OutOfPageFormat- ראה גם
| חברים בספירה | |
|---|---|
BOTTOM_ | פורמט עוגן שבו מיקום המודעה מוצמד לתחתית אזור התצוגה. |
GAME_ | פורמט של מודעת מעברון במשחק שמוצגת באופן ידני. הערה: מודעת מעברון במשחק שמוצגת באופן ידני היא פורמט עם גישה מוגבלת. |
INTERSTITIAL | פורמט של קריאייטיב של מעברון באתר. |
LEFT_ | פורמט של מסילת צד ימנית. |
REWARDED | פורמט מודעה מתגמלת. |
RIGHT_ | פורמט של מעקה צד ימני. |
TOP_ | פורמט של מיקום מודעה שבו המיקום נשאר בחלק העליון של אזור התצוגה. |
TrafficSource
googletag.events
זהו מרחב השמות שבו GPT משתמש לאירועים. הקוד יכול להגיב לאירועים האלה באמצעות Service.addEventListener.
| ממשקים | |
|---|---|
Event | ממשק בסיסי לכל אירועי GPT. |
Event | זהו סוג פסאודו שממפה שם של אירוע לסוג האובייקט של האירוע התואם עבור Service.addEventListener ו-Service.removeEventListener. |
Game | האירוע הזה מופעל כשמשתמש סוגר משבצת של מודעת מעברון במדריך למשחק. |
Game | האירוע הזה מופעל כשמשבצת של מודעה מתגמלת במדריך למשחק מוכנה להצגה למשתמש. |
Impression | האירוע הזה מופעל כשחשיפה הופכת לניתנת לצפייה, בהתאם לקריטריונים של Active View. |
Rewarded | האירוע הזה מופעל כשמשתמש סוגר משבצת של מודעה מתגמלת. |
Rewarded | האירוע הזה מופעל כשמוענק תגמול על צפייה במודעה מתגמלת. |
Rewarded | האירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה. |
Slot | האירוע הזה מופעל כש-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. |
Slot | האירוע הזה מופעל כשקוד הקריאייטיב מוחדר למקום להצגת מודעה. |
Slot | האירוע הזה מופעל כשמתבצעת בקשה להצגת מודעה במשבצת מסוימת. |
Slot | האירוע הזה מופעל כשמתקבלת תגובה למודעה במשבצת מסוימת. |
Slot | האירוע הזה מופעל בכל פעם שמשתנה אחוז השטח של מיקום מודעה במסך. |
googletag.events.Event
ממשק בסיסי לכל אירועי GPT. כל אירועי ה-GPT שמופיעים בהמשך יכללו את השדות הבאים.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. |
slot | המשבצת שהפעילה את האירוע. |
מאפיינים
serviceName
serviceName: stringslot
slot: Slotgoogletag.events.EventTypeMap
זהו סוג פסאודו שממפה שם של אירוע לסוג האובייקט של האירוע התואם עבור Service.addEventListener ו-Service.removeEventListener. הוא מתועד למטרות עיון בלבד, ולמטרות בטיחות סוגים.
מאפיינים
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEventgameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEventimpressionViewable
impressionViewable: ImpressionViewableEventrewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEventrewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEventrewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEventslotOnload
slotOnload: SlotOnloadEventslotRenderEnded
slotRenderEnded: SlotRenderEndedEventslotRequested
slotRequested: SlotRequestedEventslotResponseReceived
slotResponseReceived: SlotResponseReceivedslotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEventgoogletag.events.GameManualInterstitialSlotClosedEvent
הארכה
Eventהאירוע הזה מופעל כשמשתמש סוגר משבצת של מודעת מעברון עם הוראות למשחק.
הערה: מודעת מעברון עם הוראות למשחק היא פורמט עם גישה מוגבלת.
הערה: מודעת מעברון עם הוראות למשחק היא פורמט עם גישה מוגבלת.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (גרסה קודמת)
// This listener is called when a game manual interstitial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
googletag.events.GameManualInterstitialSlotReadyEvent
הארכה
Eventהאירוע הזה מופעל כשמשבצת של מודעת מעברון להוראות משחק מוכנה להצגה למשתמש.
הערה: מודעת מעברון להוראות משחק היא פורמט עם גישה מוגבלת.
הערה: מודעת מעברון להוראות משחק היא פורמט עם גישה מוגבלת.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
| Methods | |
|---|---|
make | הצגת מודעת מעברון של מדריך המשחק למשתמש. |
- דוגמה
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (גרסה קודמת)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
Methods
makeGameManualInterstitialVisible
makeGameManualInterstitialVisible(): voidהצגת מודעת מעברון של מדריך המשחק למשתמש.
googletag.events.ImpressionViewableEvent
הארכה
Eventהאירוע הזה מופעל כשחשיפה הופכת לניתנת לצפייה, בהתאם לקריטריונים של Active View.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (גרסה קודמת)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.RewardedSlotClosedEvent
הארכה
Eventהאירוע הזה מופעל כשמשתמש סוגר משבצת של מודעה מתגמלת. התג עשוי להיות מופעל לפני או אחרי שהפרס ניתן. כדי לקבוע אם הוענק פרס, צריך להשתמש במקומו ב-events.RewardedSlotGrantedEvent.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (גרסה קודמת)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
googletag.events.RewardedSlotGrantedEvent
הארכה
Eventהאירוע הזה מופעל כשמוענק תגמול על צפייה במודעה מתגמלת. אם המשתמש סוגר את המודעה לפני שהקריטריונים למתן תגמול מתקיימים, האירוע הזה לא יופעל.
| מאפיינים | |
|---|---|
payload | אובייקט שמכיל מידע על התגמול שניתן. |
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (גרסה קודמת)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount, ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
מאפיינים
payload
payload: RewardedPayloadgoogletag.events.RewardedSlotReadyEvent
הארכה
Eventהאירוע הזה מופעל כשמודעה מתגמלת מוכנה להצגה. בעל האתר אחראי להציג למשתמש אפשרות לצפות במודעה לפני שהוא מציג אותה.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
| Methods | |
|---|---|
make | הצגת המודעה המתגמלת. |
- דוגמה
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (גרסה קודמת)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
Methods
makeRewardedVisible
makeRewardedVisible(): voidהצגת המודעה המתגמלת. אין לקרוא לשיטה הזו עד שהמשתמש יביע הסכמה לצפייה במודעה.
googletag.events.SlotOnloadEvent
הארכה
Eventהאירוע הזה מופעל כש-iframe של הקריאייטיב מפעיל את אירוע הטעינה שלו. כשמעבדים מודעות מדיה עשירה במצב עיבוד סינכרוני, לא נעשה שימוש ב-iframe ולכן לא יופעל
SlotOnloadEvent.| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (גרסה קודמת)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.SlotRenderEndedEvent
הארכה
Eventהאירוע הזה מופעל כשקוד הקריאייטיב מוחדר למקום להצגת מודעה. האירוע הזה יתרחש לפני שליפת המשאבים של הקריאייטיב, ולכן יכול להיות שהקריאייטיב עדיין לא יוצג. אם אתם רוצים לדעת מתי הסתיימה הטעינה של כל משאבי הקריאייטיב של מיקום מודעה, כדאי להשתמש במקום זאת ב-events.SlotOnloadEvent.
| מאפיינים | |
|---|---|
advertiser | מזהה המפרסם של המודעה שמוצגת. |
campaign | מזהה הקמפיין של המודעה שמוצגת. |
company | מזהים של החברות שהגישו הצעות מחיר על המודעה למילוי חוסרים שמוצגת. |
creative | מזהה הקריאייטיב של מודעת ההזמנה שעברה רינדור. |
creative | מזהה תבנית הקריאייטיב של מודעת ההזמנה שעברה עיבוד. |
is | האם המודעה הייתה מודעת גיבוי. |
is | האם הוחזרה מודעה למיקום המודעה. |
label | הוצא משימוש. |
line | מזהה הפריט של מודעת ההזמנה שעברה עיבוד. |
response | מזהה התגובה הוא מזהה ייחודי של התגובה לבקשת המודעה. |
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
size | גודל הקריאייטיב בפיקסלים לאחר העיבוד. |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
slot | אם תוכן משבצת המודעה השתנה בעקבות רינדור המודעה. |
source | מזהה הקריאייטיב של מודעת ההזמנה או המודעה למילוי חוסרים שעברה רינדור. |
source | מזהה הפריט של המודעה שהוצגה בהזמנה או במילוי חוסר. |
yield | מזהים של קבוצות התפוקה של המודעה למילוי חוסר שהוצגה. |
- דוגמה
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (גרסה קודמת)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
מאפיינים
advertiserId
advertiserId: numbernull עבור משבצות ריקות, מודעות למילוי חוסרים ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.campaignId
campaignId: numbernull עבור משבצות ריקות, מודעות למילוי חוסרים ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.companyIds
companyIds: number[]null עבור משבצות ריקות, מודעות הזמנה ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.creativeId
creativeId: numbernull עבור משבצות ריקות, מודעות למילוי חוסרים ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.creativeTemplateId
creativeTemplateId: numbernull עבור משבצות ריקות, מודעות למילוי חוסרים ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.isBackfill
isBackfill: booleantrue אם המודעה הייתה מודעת מילוי שטחי פרסום, ו-false אחרת.isEmpty
isEmpty: booleantrue אם לא הוחזרה מודעה, ו-false בכל מקרה אחר.labelIds
labelIds: number[]lineItemId
lineItemId: numbernull עבור משבצות ריקות, מודעות למילוי חוסרים ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.responseIdentifier
responseIdentifier: stringsize
size: string | number[][728, 90] הערך הוא null אם משבצת המודעה ריקה.slotContentChanged
slotContentChanged: booleantrue אם התוכן השתנה, אחרת הערך הוא false.sourceAgnosticCreativeId
sourceAgnosticCreativeId: numbernull אם המודעה לא מוצגת בהזמנה או במילוי חוסרים של פריט, או אם הקריאייטיב מוצג על ידי שירותים אחרים מלבד PubAdsService.sourceAgnosticLineItemId
sourceAgnosticLineItemId: numbernull אם המודעה לא מוצגת בהזמנה או במילוי חוסרים של פריט, או אם הקריאייטיב מוצג על ידי שירותים אחרים מלבד PubAdsService.yieldGroupIds
yieldGroupIds: number[]null עבור משבצות ריקות, מודעות הזמנה ונכסי קריאייטיב שעברו עיבוד על ידי שירותים שאינם PubAdsService.googletag.events.SlotRequestedEvent
הארכה
Eventהאירוע הזה מופעל כשמתבצעת בקשה להצגת מודעה במשבצת מסוימת.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (גרסה קודמת)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.SlotResponseReceived
הארכה
Eventהאירוע הזה מופעל כשמתקבלת תגובה למודעה במשבצת מסוימת.
| מאפיינים | |
|---|---|
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (גרסה קודמת)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.SlotVisibilityChangedEvent
הארכה
Eventהאירוע הזה מופעל בכל פעם שמשתנה אחוז השטח של מיקום מודעה במסך. האירוע מוגבל ולא יופעל בתדירות גבוהה יותר מפעם אחת בכל 200 אלפיות השנייה.
| מאפיינים | |
|---|---|
in | אחוז השטח של המודעה שגלוי למשתמש. |
service | שם השירות שהפעיל את האירוע. הועברה בירושה מ- |
slot | המשבצת שהפעילה את האירוע. הועברה בירושה מ- |
- דוגמה
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (גרסה קודמת)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
מאפיינים
inViewPercentage
inViewPercentage: numbergoogletag.secureSignals
זהו מרחב השמות שבו GPT משתמש לניהול אותות מאובטחים.
| ממשקים | |
|---|---|
Bidder | מחזירה אות מאובטח עבור משתתף ספציפי במכרז. |
Publisher | מחזירה אות מאובטח למוציא לאור ספציפי. |
Secure | ממשק לניהול אותות מאובטחים. |
| כינויי סוגים | |
|---|---|
Secure | ממשק להחזרת אות מאובטח למגיש הצעות מחיר או לספק ספציפיים. |
כינויי סוגים
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProviderid או את networkCode, אבל לא את שניהם.googletag.secureSignals.BidderSignalProvider
הפונקציה מחזירה אות מאובטח למגיש הצעות מחיר ספציפי.
ספק אותות מאובטחים למגישי הצעות מחיר מורכב מ-2 חלקים:
ספק אותות מאובטחים למגישי הצעות מחיר מורכב מ-2 חלקים:
- פונקציית איסוף שמחזירה
Promiseשמוביל לאות מאובטח. idשמזהה את המגיש של הצעת המחיר שמשויך לאות.
| מאפיינים | |
|---|---|
collector | פונקציה שמחזירה Promise שמומר לאות מאובטח. |
id | מזהה ייחודי של כלי האיסוף שמשויך לאות המאובטח הזה, כפי שנרשם ב-Google Ad Manager. |
- דוגמה
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (גרסה קודמת)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
מאפיינים
collectorFunction
collectorFunction: (() => Promise<string>)Promise שמומר לאות מאובטח.id
id: stringgoogletag.secureSignals.PublisherSignalProvider
מחזירה אות מאובטח למוציא לאור ספציפי.
ספק אותות של מוציא לאור מורכב מ-2 חלקים:
ספק אותות של מוציא לאור מורכב מ-2 חלקים:
- פונקציית איסוף שמחזירה
Promiseשמוביל לאות מאובטח. networkCodeשמזהה את בעל האתר שמשויך לאות.
| מאפיינים | |
|---|---|
collector | פונקציה שמחזירה Promise שמומר לאות מאובטח. |
network | קוד הרשת (כפי שמופיע בנתיב של יחידת המודעות) של בעל התוכן הדיגיטלי שמשויך לאות המאובטח הזה. |
- דוגמה
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (גרסה קודמת)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
מאפיינים
collectorFunction
collectorFunction: (() => Promise<string>)Promise שמומר לאות מאובטח.networkCode
networkCode: stringgoogletag.secureSignals.SecureSignalProvidersArray
ממשק לניהול אותות מאובטחים.
| Methods | |
|---|---|
clear | מנקה את כל האותות של כל כלי האיסוף מהמטמון. |
push | הפונקציה מוסיפה secureSignals.SecureSignalProvider חדש למערך ספקי האותות ומתחילה את תהליך יצירת האותות. |
Methods
clearAllCache
clearAllCache(): voidמחיקת כל האותות של כל אמצעי האיסוף מהמטמון.
הפעלת השיטה הזו עשויה להקטין את הסיכוי שאותות ייכללו בבקשות להצגת מודעות בתצוגות הדפים הנוכחיות ובתצוגות דפים עתידיות. לכן, צריך להפעיל את הפונקציה הזו רק כשמתרחשים שינויים משמעותיים במצב, כמו אירועים שמציינים משתמש חדש (כניסה, יציאה, הרשמה וכו').
הפעלת השיטה הזו עשויה להקטין את הסיכוי שאותות ייכללו בבקשות להצגת מודעות בתצוגות הדפים הנוכחיות ובתצוגות דפים עתידיות. לכן, צריך להפעיל את הפונקציה הזו רק כשמתרחשים שינויים משמעותיים במצב, כמו אירועים שמציינים משתמש חדש (כניסה, יציאה, הרשמה וכו').
דחיפה
push(provider: SecureSignalProvider): voidהפונקציה מוסיפה secureSignals.SecureSignalProvider חדש למערך ספקי האותות ומתחילה את תהליך יצירת האותות.
| פרמטרים | |
|---|---|
provider: SecureSignalProvider | האובייקט secureSignals.SecureSignalProvider שרוצים להוסיף למערך. |