مرجع علامة "ناشر Google"

يستخدم هذا المرجع تدوين TypeScript لوصف الأنواع. يقدّم الجدول التالي شرحًا موجزًا من خلال مثال.

اكتب تعبيرًا
string نوع السلسلة الأساسي
string[] نوع مصفوفة، حيث يمكن أن تكون القيم سلاسل فقط.
number | string نوع اتحاد، حيث قد تكون القيمة إما رقمًا أو سلسلة.
Array<number | string> نوع مصفوفة، حيث تكون القيم من نوع معقّد (اتحاد).
[number, string] نوع صف، حيث تكون القيمة مصفوفة من عنصرين يجب أن تحتوي على رقم وسلسلة بهذا الترتيب.
Slot نوع كائن، حيث تكون القيمة مثيلاً لـ googletag.Slot.
() => void نوع دالة بدون وسيطات محدّدة وبدون قيمة عرض

لمزيد من المعلومات حول الأنواع وتعبيرات الأنواع المتوافقة، يُرجى الرجوع إلى دليل TypeScript .

التعليقات التوضيحية للنوع

تشير النقطتان بعد متغير أو اسم مَعلمة أو اسم خاصية أو توقيع دالة إلى تعليق توضيحي للنوع. تصف التعليقات التوضيحية للنوع الأنواع التي يمكن للعنصر الموجود على يسار النقطتين قبولها أو إرجاعها. يعرض الجدول التالي أمثلة على التعليقات التوضيحية للأنواع التي قد تظهر في هذا المرجع.

تعليق توضيحي للنوع
param: string يشير إلى أنّ param يقبل قيمة سلسلة أو يعرضها. يتم استخدام هذه البنية للمتغيّرات والمَعلمات والسمات وأنواع القيم التي تم إرجاعها.
param?: number | string يشير إلى أنّ السمة param اختيارية، ولكنّها تقبل إما رقمًا أو سلسلة عند تحديدها. يتم استخدام هذه البنية للمَعلمات والسمات.
...params: Array<() => void> يشير إلى أنّ params هي مَعلمة rest تقبل الدوال. تقبل معلَمات Rest عددًا غير محدود من القيم من النوع المحدّد.

googletag

مساحة الاسم العامة التي تستخدمها "علامة ناشر Google" لواجهة برمجة التطبيقات الخاصة بها.
مساحات الاسم
config
واجهة الضبط الرئيسية للإعدادات على مستوى الصفحة
enums
هذه هي مساحة الاسم التي تستخدمها علامة GPT لأنواع التعداد.
events
هذه هي مساحة الاسم التي تستخدمها GPT للأحداث.
secureSignals
هذه هي مساحة الاسم التي تستخدمها علامة GPT لإدارة الإشارات الآمنة.
واجهات
CommandArray
تقبل مصفوفة الأوامر تسلسلاً من الدوال وتستدعيها بالترتيب.
CompanionAdsService
خدمة "الإعلانات المصاحبة"
PrivacySettingsConfig
عنصر ضبط لإعدادات الخصوصية
PubAdsService
خدمة "إعلانات الناشرين"
RequestHook
دالّة رد الاتصال التي يتم استدعاؤها قبل كل طلب عرض إعلان عند التسجيل من خلال PubAdsService.registerRequestHook.
ResponseInformation
عنصر يمثّل استجابة إعلان واحدة
RewardedPayload
عنصر يمثّل المكافأة المرتبطة بـ إعلان مقابل مكافأة.
Service
فئة الخدمة الأساسية التي تحتوي على طرق شائعة لجميع الخدمات.
SizeMappingBuilder
أداة إنشاء لعناصر مواصفات تعيين الحجم
Slot
الخانة هي عنصر يمثّل خانة إعلانية واحدة على صفحة.
الأسماء المستعارة للأنواع
FluidSize
سلسلة الحجم التي تشغل فيها حاوية الإعلان% 100 من عرض عنصر div الرئيسي، ثم يتم تغيير حجم ارتفاعها ليتناسب مع محتوى تصميم الإعلان.
GeneralSize
إعدادات حجم صالحة لموضع إعلان، ويمكن أن تكون حجمًا واحدًا أو أحجامًا متعددة.
MultiSize
قائمة بالأحجام الصالحة الفردية
NamedSize
الأحجام المُسمّاة التي يمكن أن تتوفّر في خانة إعلانية معيّنة
SingleSize
حجم واحد صالح لموضع إعلان
SingleSizeArray
مصفوفة من رقمَين يمثّلان [العرض، الارتفاع]
SizeMapping
تمثيل بياني لحجم إطار العرض بالنسبة إلى أحجام الإعلانات
SizeMappingArray
قائمة بعمليات ربط الأحجام
المتغيّرات
apiReady
علامة تشير إلى أنّه تم تحميل واجهة برمجة التطبيقات GPT API وأنّها جاهزة للاستدعاء
cmd
يشير هذا إلى قائمة انتظار الأوامر العامة لتنفيذ الطلبات ذات الصلة بعلامة GPT بشكل غير متزامن.
pubadsReady
علامة تشير إلى أنّ PubAdsService مفعَّلة ومحمَّلة وتعمل بشكل كامل
secureSignalProviders
يشير إلى مصفوفة مقدّمي الإشارات الآمنة.
الدوال
companionAds
تعرض مرجعًا إلى CompanionAdsService.
defineOutOfPageSlot
تنشئ هذه الطريقة خانة إعلانية خارج الصفحة باستخدام مسار الوحدة الإعلانية المحدّد.
defineSlot
تنشئ هذه الدالة خانة إعلانية بمسار وحدة إعلانية وحجم محدّدَين وتربطها برقم تعريف عنصر div على الصفحة التي ستحتوي على الإعلان.
destroySlots
يؤدي ذلك إلى تدمير الخانات المحدّدة، وإزالة جميع العناصر والمراجع ذات الصلة بهذه الخانات من GPT.
disablePublisherConsole
يؤدي هذا الخيار إلى إيقاف وحدة تحكم ناشري Google.
display
توجّه خدمات الخانات لعرض الخانة.
enableServices
يتيح هذا الخيار تفعيل جميع خدمات GPT التي تم تحديدها للخانة الإعلانية على الصفحة.
getConfig
تتيح هذه الطريقة الحصول على نسخة ثابتة من خيارات الإعدادات العامة للصفحة التي تم ضبطها من خلال setConfig.
getVersion
تعرض هذه الدالة الإصدار الحالي من GPT.
openConsole
يفتح "وحدة تحكم ناشري Google".
pubads
تعرض مرجعًا إلى PubAdsService.
setAdIframeTitle
يضبط هذا الإعداد عنوانًا لجميع إطارات iframe الخاصة بحاويات الإعلانات التي أنشأتها PubAdsService، من هذه النقطة فصاعدًا.
setConfig
تضبط خيارات الإعدادات العامة للصفحة.
sizeMapping
تنشئ هذه الطريقة SizeMappingBuilder جديدًا.

الأسماء المستعارة للأنواع

FluidSize

FluidSize: "fluid"
سلسلة الحجم التي تشغل فيها حاوية الإعلان% 100 من عرض عنصر div الرئيسي، ثم يتم تغيير حجم ارتفاعها ليتناسب مع محتوى تصميم الإعلان. يشبه سلوك عناصر الكتلة العادية في الصفحة. يُستخدَم لـ "الإعلانات المدمجة مع المحتوى" و"إعلانات البانر" (يُرجى الاطّلاع على المقالة ذات الصلة).

GeneralSize

GeneralSize: SingleSize | MultiSize
إعدادات حجم صالحة لموضع إعلان، ويمكن أن تكون حجمًا واحدًا أو أحجامًا متعددة.

MultiSize

MultiSize: SingleSize[]
قائمة بالأحجام الصالحة الفردية

NamedSize

NamedSize: FluidSize | [FluidSize]
الأحجام المُسمّاة التي يمكن أن تتوفّر في خانة إعلانية معيّنة في معظم الحالات، يكون الحجم مستطيلاً ثابتًا، ولكن هناك بعض الحالات التي نحتاج فيها إلى أنواع أخرى من مواصفات الحجم. في ما يلي الأحجام المسمّاة الصالحة فقط:
  • fluid: تأخذ حاوية الإعلان% 100 من عرض عنصر div الرئيسي، ثم يتم تغيير حجم ارتفاعها ليتناسب مع محتوى تصميم الإعلان. يشبه سلوك عناصر الكتلة العادية في الصفحة. يُستخدَم لـ "الإعلانات المدمجة مع المحتوى" و"إعلانات البانر" (يُرجى الاطّلاع على المقالة ذات الصلة). يُرجى العِلم أنّ كلاً من fluid و['fluid'] هما شكلان مقبولان للإعلان عن حجم خانة إعلانية على أنّه مرن.

SingleSize

حجم واحد صالح لموضع إعلان

SingleSizeArray

SingleSizeArray: [number, number]
مصفوفة من رقمَين يمثّلان [العرض، الارتفاع]

SizeMapping

تمثيل بياني لحجم إطار العرض بالنسبة إلى أحجام الإعلانات يُستخدَم للإعلانات المتجاوبة.

SizeMappingArray

SizeMappingArray: SizeMapping[]
قائمة بعمليات ربط الأحجام

المتغيّرات

Const apiReady

apiReady: boolean | undefined
علامة تشير إلى أنّه تم تحميل واجهة برمجة التطبيقات GPT API وأنّها جاهزة للاستدعاء ستكون هذه السمة ببساطة undefined إلى أن تصبح واجهة برمجة التطبيقات جاهزة.

يُرجى العِلم أنّ الطريقة المقترَحة للتعامل مع الطلبات غير المتزامنة هي استخدام googletag.cmd لوضع عمليات معاودة الاتصال في قائمة انتظار عندما تصبح علامة GPT جاهزة. لا تحتاج عمليات الاستدعاء هذه إلى التحقّق من googletag.apiReady لأنّه من المضمون تنفيذها بعد إعداد واجهة برمجة التطبيقات.

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray
يشير هذا إلى قائمة انتظار الأوامر العامة للتنفيذ غير المتزامن لطلبات GPT.

تتم تهيئة المتغيّر googletag.cmd إلى مصفوفة JavaScript فارغة من خلال بنية علامة GPT على الصفحة، وcmd.push هي طريقة Array.push العادية التي تضيف عنصرًا إلى نهاية المصفوفة. عند تحميل JavaScript في GPT، يتم البحث في الصفيف وتنفيذ جميع الدوال بالترتيب. يستبدل النص البرمجي بعد ذلك cmd بعنصر CommandArray يتم تحديد طريقة الدفع الخاصة به لتنفيذ وسيطة الدالة التي تم تمريرها إليه. تسمح هذه الآلية لـ GPT بتقليل وقت الاستجابة الملحوظ من خلال جلب JavaScript بشكل غير متزامن مع السماح للمتصفّح بمواصلة عرض الصفحة.
مثال

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

Const pubadsReady

pubadsReady: boolean | undefined
علامة تشير إلى أنّ PubAdsService مفعَّلة ومحمَّلة وتعمل بشكل كامل ستكون هذه السمة ببساطة undefined إلى أن يتم استدعاء 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");
  },
});

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
تنشئ هذه الدالة خانة إعلانية خارج الصفحة باستخدام مسار الوحدة الإعلانية المحدّد.

بالنسبة إلى الإعلانات المخصّصة خارج الصفحة، تمثّل السمة 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);

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مسار الوحدة الإعلانية الكامل مع رمز الشبكة ورمز الوحدة الإعلانية
Optional div: string | OutOfPageFormatرقم تعريف عنصر 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");

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
انظر أيضًا
المعلمات
adUnitPath: stringمسار الوحدة الإعلانية الكامل مع رمز الشبكة ورمز الوحدة
size: GeneralSizeعرض الخانة الإعلانية المضافة وارتفاعها هذا هو الحجم المستخدَم في طلب عرض الإعلان في حال عدم توفير أيّ تعيين للحجم المتجاوب أو إذا كان حجم إطار العرض أصغر من أصغر حجم تم توفيره في التعيين.
Optional div: stringرقم تعريف div الذي سيحتوي على هذه الوحدة الإعلانية.
المرتجعات
Slot | nullالخانة التي تم إنشاؤها حديثًا، أو null إذا تعذّر إنشاء خانة

destroySlots

destroySlots(slots?: Slot[]): boolean
يؤدي ذلك إلى تدمير الخانات المحدّدة، وإزالة جميع العناصر والمراجع ذات الصلة بهذه الخانات من GPT. لا تتوافق واجهة برمجة التطبيقات هذه مع خانات الإعلانات الاحتياطية وخانات الإعلانات المصاحبة.

يؤدي طلب واجهة برمجة التطبيقات هذه في خانة إعلانية إلى محو الإعلان وإزالة عنصر الخانة من الحالة الداخلية التي تحتفظ بها علامة GPT. سيؤدي استدعاء أي دوال أخرى على عنصر الخانة إلى سلوك غير محدّد. يُرجى العِلم أنّ المتصفّح قد لا يحرّر الذاكرة المرتبطة بهذه الخانة إذا تم الاحتفاظ بمرجع لها في صفحة الناشر. يؤدي استدعاء واجهة برمجة التطبيقات هذه إلى إتاحة عنصر 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();

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();
المعلمات
Optional slots: Slot[]مصفوفة الخانات المطلوب تدميرها. تُعدّ المصفوفة اختيارية، وسيتم تدمير جميع الخانات إذا لم يتم تحديدها.
المرتجعات
boolean‫true إذا تم تدمير الخانات، وfalse في الحالات الأخرى

disablePublisherConsole

disablePublisherConsole(): void
إيقاف "وحدة تحكم ناشري Google"
انظر أيضًا

display

display(divOrSlot: string | Element | Slot): void
توجّه خدمات الخانات لعرض الخانة. يجب عرض كل خانة إعلانية مرة واحدة فقط في كل صفحة. يجب تحديد جميع الخانات وربطها بخدمة قبل عرضها. يجب عدم إجراء طلب العرض إلا بعد توفّر العنصر في نموذج العناصر في المستند (DOM). الطريقة المعتادة لتحقيق ذلك هي وضعه داخل مجموعة نصوص برمجية ضمن عنصر div المذكور في طلب الإجراء.

في حال استخدام بنية الإعلان الأحادي الطلب (SRA)، سيتم جلب جميع الخانات الإعلانية التي لم يتم جلبها في وقت طلب هذا الإجراء دفعة واحدة. لفرض عدم عرض خانة إعلانية، يجب إزالة عنصر div بالكامل.
انظر أيضًا
المعلمات
divOrSlot: string | Element | Slotإما معرّف عنصر div الذي يحتوي على الخانة الإعلانية أو عنصر div أو عنصر الخانة. إذا تم توفير عنصر div، يجب أن يتضمّن سمة "id" تتطابق مع المعرّف الذي تم تمريره إلى defineSlot.

enableServices

enableServices(): void
يتيح هذا الخيار تفعيل جميع خدمات GPT التي تم تحديدها للخانة الإعلانية على الصفحة.

getConfig

getConfig(keys: string | string[]): Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>
تُستخدَم هذه الطريقة للحصول على نسخة ثابتة من خيارات الإعدادات العامة للصفحة التي تم ضبطها من خلال setConfig.

لا تتوافق بعض سمات setConfig() مع هذه الطريقة. السمات المتوافقة هي:
مثال

JavaScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
المعلمات
keys: string | string[]مفاتيح خيارات الضبط التي تريد الحصول عليها
المرتجعات
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>نسخة مجمّدة من خيارات ضبط الصفحة

getVersion

getVersion(): string
تعرض هذه الدالة الإصدار الحالي من GPT.
انظر أيضًا
المرتجعات
stringسلسلة إصدار GPT التي يتم تنفيذها حاليًا

openConsole

openConsole(div?: string): void
يفتح وحدة تحكم ناشري Google.
مثال

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();
انظر أيضًا
المعلمات
Optional div: stringرقم تعريف div لخانة إعلانية هذه القيمة اختيارية. عند توفير هذه السمة، ستحاول "وحدة تحكّم الناشر" فتح تفاصيل الخانة الإعلانية المحدّدة في العرض.

pubads

pubads(): PubAdsService
تعرض مرجعًا إلى PubAdsService.
المرتجعات
PubAdsServiceخدمة "إعلانات الناشر"

setAdIframeTitle

setAdIframeTitle(title: string): void
يضبط هذا الإعداد عنوانًا لجميع إطارات iframe الخاصة بحاويات الإعلانات التي أنشأتها PubAdsService، من هذه النقطة فصاعدًا.
مثال

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.
الطُرق
push
تنفّذ هذه الدالة تسلسل الدوال المحدّدة في الوسيطات بالترتيب.

الطُرق

push

push(...f: ((this: typeof globalThis) => void)[]): number
تنفّذ هذه الدالة تسلسل الدوال المحدّدة في الوسيطات بالترتيب.
مثال

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});
المعلمات
Rest ...f: ((this: typeof globalThis) => void)[]دالة JavaScript المطلوب تنفيذها ستكون عملية الربط في وقت التشغيل دائمًا globalThis. ننصحك بتمرير دالة سهمية للاحتفاظ بقيمة this للسياق المعجمي المضمّن.
المرتجعات
numberعدد الأوامر التي تمت معالجتها حتى الآن يتوافق ذلك مع القيمة المعروضة من Array.push (الطول الحالي للمصفوفة).

googletag.CompanionAdsService

يضيف Service
خدمة "الإعلانات المصاحبة" تستخدم إعلانات الفيديو هذه الخدمة لعرض الإعلانات المصاحبة.
الطُرق
addEventListener
يتم تسجيل أداة مراقبة أحداث تتيح لك إعداد دالة JavaScript واستدعائها عند وقوع حدث GPT معيّن على الصفحة.
getSlots
احصل على قائمة الفترات الزمنية المرتبطة بهذه الخدمة.
removeEventListener
لإزالة مستمع تم تسجيله سابقًا
setRefreshUnfilledSlots
يحدّد هذا الإعداد ما إذا كان سيتم تلقائيًا ملء الخانات الإعلانية المصاحبة التي لم يتم ملؤها.
انظر أيضًا

الطُرق

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void
تحدّد هذه الطريقة ما إذا كان سيتم تلقائيًا ملء الخانات الإعلانية المصاحبة التي لم يتم ملؤها.

يمكن استدعاء هذه الطريقة عدة مرات خلال فترة بقاء الصفحة لتفعيل الملء التلقائي وإيقافه. سيتم فقط ملء الخانات المسجَّلة أيضًا في PubAdsService. بسبب قيود السياسة، لم يتم تصميم هذه الطريقة لملء خانات الإعلانات المصاحبة الفارغة عند عرض فيديو من Ad Exchange.
مثال

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);
المعلمات
value: boolean‫true لملء الخانات الفارغة تلقائيًا، وfalse لتركها بدون تغيير

googletag.PrivacySettingsConfig

عنصر ضبط لإعدادات الخصوصية
الخصائص
childDirectedTreatment?
تشير هذه المَعلمة إلى ما إذا كان يجب تصنيف الصفحة على أنّها موجّهة للأطفال.
limitedAds?
تتيح هذه الميزة عرض الإعلانات في وضع الإعلانات المحدودة للمساعدة في تلبية احتياجات الامتثال التنظيمي للناشرين.
nonPersonalizedAds?
تتيح هذه الميزة عرض الإعلانات في وضع الإعلانات غير المخصّصة للمساعدة في تلبية احتياجات الامتثال التنظيمي للناشرين.
restrictDataProcessing?
يتيح هذا الإعداد عرض الإعلانات في وضع المعالجة المحدودة للمساعدة في تلبية احتياجات الامتثال التنظيمي للناشرين.
tagForAgeTreatment?
المعالجة المحظورة على فئات عمرية معيّنة، والتي تشير إلى ما إذا كان يجب التعامل مع طلب عرض الإعلان على أنّه موجّه إلى الأطفال أو المراهقين أو غير محدّد
trafficSource?
يشير هذا العمود إلى ما إذا كانت الطلبات تمثّل زيارات مدفوعة أو الزيارات الواردة من نتائج البحث المجانية.
underAgeOfConsent?
تشير هذه المَعلمة إلى ما إذا كان يجب وضع علامة على طلبات عرض الإعلانات بأنّها واردة من مستخدمين دون سن الرشد.
انظر أيضًا

الخصائص

Optional childDirectedTreatment

childDirectedTreatment?: boolean
تشير هذه المَعلمة إلى ما إذا كان يجب تصنيف الصفحة على أنّها موجّهة للأطفال. اضبط القيمة على null لمحو الإعدادات.

Optional limitedAds

limitedAds?: boolean
تتيح هذه الميزة عرض الإعلانات في وضع الإعلانات المحدودة للمساعدة في تلبية احتياجات الامتثال التنظيمي للناشر.

يمكنك توجيه GPT لطلب إعلانات محدودة بطريقتَين: لا يمكن ضبط الإعلانات المحدودة يدويًا إلا عند تحميل GPT من عنوان URL للإعلانات المحدودة. ستؤدي محاولة تعديل هذا الإعداد عند تحميل GPT من عنوان URL العادي إلى إنشاء تحذير في "وحدة تحكّم الناشر".

يُرجى العِلم أنّه ليس من الضروري تفعيل الإعلانات المحدودة يدويًا عند استخدام منصة لإدارة الموافقة.
مثال

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?: boolean
تتيح هذه الميزة عرض الإعلانات في وضع الإعلانات غير المخصّصة للمساعدة في تلبية احتياجات الامتثال التنظيمي للناشرين.

Optional restrictDataProcessing

restrictDataProcessing?: boolean
يتيح هذا الإعداد عرض الإعلانات في وضع المعالجة المحدودة للمساعدة في تلبية احتياجات الامتثال التنظيمي للناشرين.

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment
المعالجة المحظورة على فئات عمرية معيّنة، والتي تشير إلى ما إذا كان يجب التعامل مع طلب عرض الإعلان على أنّه موجّه إلى الأطفال أو المراهقين أو غير محدّد.

يُرجى الرجوع إلى مستشارك القانوني لتحديد إعدادات المعالجة الموجّهة للفئات العمرية في ما يتعلّق بمستخدِمي موقعك الإلكتروني استنادًا إلى متطلّباتك القانونية والتنظيمية. لمزيد من المعلومات حول هذا الإعداد، يُرجى مراجعة مقالة مركز المساعدة هذه.

من خلال ضبط هذه السمة، أنت تقرّ بأنّ هذا الإشعار دقيق وأنّك مفوَّض للتصرّف نيابةً عن مالك الموقع الإلكتروني. أنت تدرك أنّ إساءة استخدام هذا الإعداد قد تؤدي إلى إغلاق حسابك على Google.
مثال

JavaScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

TypeScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

Optional trafficSource

trafficSource?: TrafficSource
يشير هذا العمود إلى ما إذا كانت الطلبات تمثّل زيارات مدفوعة أو الزيارات الواردة من نتائج البحث المجانية. تتم تعبئة هذه القيمة في سمة مصدر الزيارات في تقارير "إدارة إعلانات Google". في حال عدم ضبط هذه السمة، يتم ضبط مصدر الزيارات تلقائيًا على undefined في التقارير.
مثال

JavaScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

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?: boolean
تشير هذه المَعلمة إلى ما إذا كان يجب وضع علامة على طلبات عرض الإعلانات بأنّها واردة من مستخدمين دون سن الرشد. اضبط القيمة على null لمحو الإعدادات.

googletag.PubAdsService

يضيف Service
خدمة "إعلانات الناشرين" تُستخدَم هذه الخدمة لجلب الإعلانات وعرضها من حسابك على "إدارة إعلانات Google".
الطُرق
addEventListener
يتم تسجيل أداة مراقبة أحداث تتيح لك إعداد دالة JavaScript واستدعائها عند وقوع حدث GPT معيّن على الصفحة.
clear
تزيل هذه الطريقة الإعلانات من الخانات المحدّدة وتستبدلها بمحتوى فارغ.
clearCategoryExclusions
تمّت إزالة هذا العمود. تؤدي هذه الطريقة إلى محو جميع تصنيفات استبعاد فئات الإعلانات على مستوى الصفحة.
clearTargeting
تمّت إزالة هذا العمود. لمحو مَعلمات الاستهداف المخصّص لمفتاح معيّن أو لجميع المفاتيح.
collapseEmptyDivs
تمّت إزالة هذا العمود. يؤدي ذلك إلى تفعيل تصغير عناصر div الخاصة بالخانات الإعلانية كي لا تشغل أي مساحة على الصفحة في حال عدم توفّر محتوى إعلاني لعرضه.
disableInitialLoad
تمّت إزالة هذا العمود. يؤدي ذلك إلى إيقاف طلبات الإعلانات عند تحميل الصفحة، ولكن يسمح بطلب الإعلانات باستخدام طلب PubAdsService.refresh.
display
تنشئ هذه الدالة خانة إعلانية وتعرضها باستخدام مسار الوحدة الإعلانية وحجمها المحدّدَين.
enableLazyLoad
تمّت إزالة هذا العمود. تتيح هذه الطريقة تفعيل ميزة "التحميل الكسول" في علامة GPT على النحو المحدّد في عنصر الضبط.
enableSingleRequest
تمّت إزالة هذا العمود. يتم تفعيل وضع "إرسال الطلبات دفعةً واحدة" لجلب إعلانات متعددة في الوقت نفسه.
enableVideoAds
تمّت إزالة هذا العمود. يُعلم GPT بأنّ إعلانات الفيديو ستظهر على الصفحة.
get
تمّت إزالة هذا العمود. تعرض هذه الدالة قيمة سمة AdSense المرتبطة بالمفتاح المحدّد.
getAttributeKeys
تمّت إزالة هذا العمود. تعرض هذه الطريقة مفاتيح السمات التي تم ضبطها في هذه الخدمة.
getSlots
احصل على قائمة الفترات الزمنية المرتبطة بهذه الخدمة.
getTargeting
تمّت إزالة هذا العمود. تعرض هذه الطريقة مَعلمة استهداف مخصّصة محدّدة على مستوى الخدمة تم ضبطها.
getTargetingKeys
تمّت إزالة هذا العمود. تعرض هذه الطريقة قائمة بجميع مفاتيح الاستهداف المخصّصة على مستوى الخدمة التي تم ضبطها.
isInitialLoadDisabled
تمّت إزالة هذا العمود. تُرجع هذه الطريقة ما إذا تم إيقاف الطلبات الأولية للإعلانات بنجاح من خلال استدعاء سابق للدالة PubAdsService.disableInitialLoad أم لا.
refresh
تجلب هذه الدالة إعلانات جديدة وتعرضها في خانات معيّنة أو في جميع الخانات على الصفحة.
registerRequestHook
يتم تسجيل دالة ربط ليتم تنفيذها بالتوازي مع دوال الربط المسجَّلة الأخرى قبل كل طلب عرض إعلان على الصفحة خلال مهلة عامة.
removeEventListener
لإزالة مستمع تم تسجيله سابقًا
set
تمّت إزالة هذا العمود. تضبط هذه الطريقة قيم سمات AdSense التي تنطبق على جميع الخانات الإعلانية ضمن خدمة Publisher Ads.
setCategoryExclusion
تمّت إزالة هذا العمود. يتم ضبط استبعاد فئة إعلانية على مستوى الصفحة لاسم التصنيف المحدّد.
setCentering
تمّت إزالة هذا العمود. يؤدي هذا الإعداد إلى تفعيل التوسيط الأفقي للإعلانات أو إيقافه.
setForceSafeFrame
تمّت إزالة هذا العمود. تحدّد هذه السياسة ما إذا كان يجب فرض عرض جميع الإعلانات على الصفحة باستخدام حاوية SafeFrame.
setLocation
تمّت إزالة هذا العمود. يمرّر معلومات عن الموقع الجغرافي للجهاز من المواقع الإلكترونية حتى تتمكّن من استهداف المواقع الجغرافية في البنود الإعلانية لمواقع جغرافية معيّنة.
setPrivacySettings
يتيح هذا الإعداد ضبط جميع إعدادات الخصوصية من واجهة برمجة تطبيقات واحدة باستخدام عنصر ضبط.
setPublisherProvidedId
يضبط قيمة المعرّف المقدَّم من الناشر.
setSafeFrameConfig
تمّت إزالة هذا العمود. تحدّد هذه السمة الإعدادات المفضّلة على مستوى الصفحة لضبط SafeFrame.
setTargeting
تمّت إزالة هذا العمود. يتم ضبط مَعلمات الاستهداف المخصّصة لمفتاح معيّن ينطبق على جميع الخانات الإعلانية في خدمة "إعلانات الناشرين".
setVideoContent
تمّت إزالة هذا العمود. تضبط هذه السمة معلومات محتوى الفيديو التي سيتم إرسالها مع طلبات عرض الإعلانات لأغراض الاستهداف واستبعاد المحتوى.
updateCorrelator
يغيّر هذا الإجراء الارتباط الذي يتم إرساله مع طلبات عرض الإعلانات، ما يؤدي إلى بدء مشاهدة صفحة جديدة بشكل فعّال.

الطُرق

clear

clear(slots?: Slot[]): boolean
تزيل هذه الطريقة الإعلانات من الخانات المحدّدة وتستبدلها بمحتوى فارغ. سيتم وضع علامة على الخانات بأنّها غير مسترجَعة.

وعلى وجه التحديد، يؤدي محو خانة إلى إزالة الإعلان من مشاهدة الصفحة على الويب الطويلة الأمد في GPT، وبالتالي لن تتأثر الطلبات المستقبلية بحملات الاستحواذ على المساحات الإعلانية أو عمليات الاستبعاد التنافسية التي تتضمّن هذا الإعلان.
مثال

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

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();
المعلمات
Optional slots: Slot[]مصفوفة الخانات المطلوب محوها المصفوفة اختيارية، وسيتم محو جميع الخانات إذا لم يتم تحديدها.
المرتجعات
booleanتعرض هذه الدالة القيمة true إذا تم محو الخانات، وfalse في الحالات الأخرى.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService
لمحو جميع تصنيفات استبعاد فئات الإعلانات على مستوى الصفحة يكون هذا الإجراء مفيدًا إذا أردت إعادة تحميل الخانة.
مثال

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.
انظر أيضًا
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

clearTargeting

clearTargeting(key?: string): PubAdsService
تؤدي هذه الطريقة إلى محو مَعلمات الاستهداف المخصّصة لمفتاح معيّن أو لجميع المفاتيح.
مثال

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.
انظر أيضًا
المعلمات
Optional key: stringمفتاح مَعلمة الاستهداف المفتاح اختياري، وسيتم محو جميع مَعلمات الاستهداف إذا لم يتم تحديده.
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
تتيح هذه الميزة تصغير عناصر div الخاصة بالخانات الإعلانية كي لا تشغل أي مساحة على الصفحة في حال عدم توفّر محتوى إعلاني لعرضه. يجب ضبط هذا الوضع قبل تفعيل الخدمة.
انظر أيضًا
المعلمات
Optional collapseBeforeAdFetch: booleanما إذا كان سيتم تصغير الخانات حتى قبل جلب الإعلانات. هذه المَعلمة اختيارية، وفي حال عدم توفيرها، سيتم استخدام false كقيمة تلقائية.
المرتجعات
booleanتعرض هذه الطريقة القيمة true في حال تفعيل وضع تصغير div، والقيمة false في حال تعذّر تفعيل وضع التصغير بسبب استدعاء الطريقة بعد تفعيل الخدمة.

disableInitialLoad

disableInitialLoad(): void
يؤدي ذلك إلى إيقاف طلبات الإعلانات عند تحميل الصفحة، ولكن يسمح بطلب الإعلانات باستخدام طلب PubAdsService.refresh. يجب ضبط هذا الإعداد قبل تفعيل الخدمة. يجب استخدام الوضع غير المتزامن، وإلا لن يكون من الممكن طلب الإعلانات باستخدام refresh.
انظر أيضًا

display

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
تنشئ هذه الطريقة خانة إعلانية وتعرضها باستخدام مسار الوحدة الإعلانية وحجمها المحدّدَين.

هذه الطريقة هي اختصار يعادل استدعاء googletag.defineSlot متبوعًا مباشرةً بـ googletag.display.

يعتمد سلوك هذه الطريقة على ما إذا كانت بنية الإعلان الأحادي الطلب (SRA) مفعَّلة:
  • تفعيل SRA: سيتم تجميع كل الخانات الإعلانية المحدّدة حتى وقت هذا الطلب وطلبها معًا.
  • إيقاف SRA (الإعداد التلقائي): سيتم طلب الخانة الإعلانية بشكل فردي.
ملاحظة: عند استدعاء هذه الطريقة، يتم إنشاء لقطة من حالة الخانة والصفحة لضمان الاتساق عند إرسال طلب عرض الإعلان وعرض الاستجابة. وأي تغييرات يتم إجراؤها على حالة الخانة أو الصفحة بعد استدعاء هذه الطريقة (بما في ذلك الاستهداف وإعدادات الخصوصية وفرض SafeFrame وما إلى ذلك) لن تنطبق إلا على طلبات display() أو refresh() اللاحقة.
مثال

JavaScript

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

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
انظر أيضًا
المعلمات
adUnitPath: stringمسار الوحدة الإعلانية للخانة التي سيتم عرضها
size: GeneralSizeعرض الخانة وارتفاعها
Optional div: string | Elementإما رقم تعريف div الذي يحتوي على الخانة أو عنصر div نفسه.
Optional clickUrl: stringعنوان URL للنقرة المطلوب استخدامه في هذه الخانة

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void
تتيح هذه الطريقة التحميل الكسول في GPT على النحو المحدّد في عنصر الإعدادات. للاطّلاع على أمثلة أكثر تفصيلاً، يمكنك مراجعة نموذج التحميل الكسول.

ملاحظة: لا تعمل ميزة "الجلب الكسول" في بنية الإعلان الأحادي الطلب (SRA) إلا إذا كانت جميع الخانات خارج هامش الجلب.
مثال

JavaScript

googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

TypeScript

googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});
انظر أيضًا
المعلمات
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}		يسمح عنصر الإعدادات بتخصيص سلوك التحميل الكسول. ستستخدم أي إعدادات محذوفة إعدادًا تلقائيًا تضبطه Google وسيتم تعديله بمرور الوقت. لإيقاف إعداد معيّن، مثل هامش الجلب، اضبط القيمة على -1.
  • fetchMarginPercent

    الحد الأدنى للمسافة من إطار العرض الحالي الذي يجب أن تكون فيه خانة إعلانية قبل جلب الإعلان كنسبة مئوية من حجم إطار العرض. تعني القيمة 0 "عندما تدخل الخانة إطار العرض"، وتعني القيمة 100 "عندما يكون الإعلان على بُعد إطار عرض واحد"، وهكذا.
  • renderMarginPercent

    الحد الأدنى للمسافة بين الخانة ونافذة العرض الحالية قبل عرض الإعلان. يتيح ذلك جلب الإعلان مسبقًا، ولكن مع الانتظار لعرض الموارد الفرعية الأخرى وتنزيلها. تعمل القيمة تمامًا مثل fetchMarginPercent كنسبة مئوية من إطار العرض.
  • mobileScaling

    يشير ذلك إلى مُضاعِف يتم تطبيقه على الهوامش على الأجهزة الجوّالة. يتيح ذلك استخدام هوامش مختلفة على الأجهزة الجوّالة مقارنةً بأجهزة الكمبيوتر المكتبي. على سبيل المثال، ستؤدي القيمة 2.0 إلى مضاعفة جميع الهوامش في 2 على الأجهزة الجوّالة، ما يزيد من الحد الأدنى للمسافة التي يمكن أن تكون عليها الخانة قبل الجلب والعرض.

enableSingleRequest

enableSingleRequest(): boolean
يتم تفعيل وضع "إرسال الطلبات دفعةً واحدة" لجلب إعلانات متعددة في الوقت نفسه. يتطلّب ذلك تحديد جميع خانات "إعلانات الناشرين" وإضافتها إلى PubAdsService قبل تفعيل الخدمة. يجب ضبط وضع "إرسال الطلبات دفعةً واحدة" قبل تفعيل الخدمة.
انظر أيضًا
المرتجعات
booleanتعرض هذه الدالة القيمة true في حال تفعيل وضع "إرسال الطلبات دفعةً واحدة"، والقيمة false في حال تعذّر تفعيل هذا الوضع بسبب استدعاء الطريقة بعد تفعيل الخدمة.

enableVideoAds

enableVideoAds(): void
يرسل إشارة إلى GPT بأنّ إعلانات الفيديو ستظهر على الصفحة. يؤدي ذلك إلى تفعيل قيود الاستبعاد التنافسي على "الإعلانات الصورية" و"إعلانات الفيديو". إذا كان محتوى الفيديو معروفًا، يمكنك استدعاء PubAdsService.setVideoContent لتتمكّن من استخدام استبعاد المحتوى للإعلانات الصورية.

get

get(key: string): string
تعرض هذه الطريقة قيمة سمة AdSense المرتبطة بالمفتاح المحدّد.
مثال

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.
انظر أيضًا
المعلمات
key: stringاسم السمة المطلوب البحث عنها
المرتجعات
stringالقيمة الحالية لمفتاح السمة، أو null إذا لم يكن المفتاح متوفّرًا.

getAttributeKeys

getAttributeKeys(): string[]
تعرض هذه الطريقة مفاتيح السمات التي تم ضبطها في هذه الخدمة.
مثال

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].
المرتجعات
string[]مصفوفة من مفاتيح السمات التي تم ضبطها في هذه الخدمة الترتيب غير محدّد.

getTargeting

getTargeting(key: string): string[]
تعرض هذه الطريقة مَعلمة استهداف مخصّصة محدّدة على مستوى الخدمة تم ضبطها.
مثال

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).
المعلمات
key: stringمفتاح الاستهداف المطلوب البحث عنه
المرتجعات
string[]القيم المرتبطة بهذا المفتاح، أو مصفوفة فارغة في حال عدم توفّر هذا المفتاح

getTargetingKeys

getTargetingKeys(): string[]
تعرض هذه الطريقة قائمة بجميع مفاتيح الاستهداف المخصّصة على مستوى الخدمة التي تم ضبطها.
مثال

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].
المرتجعات
string[]مصفوفة من مفاتيح الاستهداف الترتيب غير محدّد.

isInitialLoadDisabled

isInitialLoadDisabled(): boolean
تعرض هذه الطريقة ما إذا تم إيقاف الطلبات الأولية للإعلانات بنجاح من خلال طلب PubAdsService.disableInitialLoad سابق.
المرتجعات
booleanتعرض القيمة true إذا كان الطلب السابق إلى PubAdsService.disableInitialLoad ناجحًا، وfalse في الحالات الأخرى.

إعادة تحميل

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void
تجلب هذه الدالة إعلانات جديدة وتعرضها في خانات معيّنة أو في جميع الخانات على الصفحة. تعمل هذه الطريقة فقط في وضع العرض غير المتزامن.

لضمان السلوك الصحيح في جميع المتصفحات، يجب أن يسبق استدعاء refresh استدعاء display للخانة الإعلانية. في حال حذف الاستدعاء إلى display، قد تعمل عملية إعادة التحميل بشكل غير متوقّع. إذا أردت، يمكنك استخدام طريقة PubAdsService.disableInitialLoad لمنع display من جلب إعلان.

تؤدي إعادة تحميل خانة إعلانية إلى إزالة الإعلان القديم من مشاهدة الصفحة على الويب الطويلة الأمد في GPT، وبالتالي لن تتأثر الطلبات المستقبلية بالإعلانات الحصرية أو الاستبعادات التنافسية التي تتضمّن هذا الإعلان.
مثال

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

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 });
انظر أيضًا
المعلمات
Optional slots: Slot[]الخانات المطلوب إعادة تحميلها تكون المصفوفة اختيارية، وسيتم إعادة تحميل جميع الخانات الإعلانية إذا لم يتم تحديدها.
Optional options: {
  changeCorrelator: boolean;
}		خيارات الإعداد المرتبطة بطلب إعادة التحميل هذا
  • changeCorrelator

    تحدّد هذه السمة ما إذا كان سيتم إنشاء رابط جديد لجلب الإعلانات أم لا. تحتفظ خوادم الإعلانات بقيمة الارتباط هذه لفترة وجيزة (حاليًا لمدة 30 ثانية، ولكنها قابلة للتغيير)، بحيث يتم اعتبار الطلبات التي تتضمّن الارتباط نفسه والتي يتم تلقّيها في وقت متقارب مشاهدة صفحة واحدة. يتم تلقائيًا إنشاء رابط جديد لكل عملية إعادة تحميل.

    ملاحظة: لا يؤثّر هذا الخيار في مشاهدة الصفحة على الويب الطويلة الأمد في GPT، والتي تعكس تلقائيًا الإعلانات المعروضة حاليًا على الصفحة وليس لها وقت انتهاء صلاحية.

registerRequestHook

registerRequestHook(hook: RequestHook, hookId: string): (() => void)
Experimental لتسجيل دالة ربط يتم تنفيذها بالتوازي مع دوال الربط المسجَّلة الأخرى قبل كل طلب عرض إعلان على الصفحة خلال مهلة عامة
مثال

JavaScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

TypeScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();
المعلمات
hook: RequestHookدالة تأخذ عنصرًا يحتوي على قائمة الخانات المطلوبة وتُرجع وعدًا يتم تنفيذه بعد اكتمال جميع الإجراءات غير المتزامنة.
hookId: stringرقم تعريف لتصنيف الخطاف من أجل تحسين بيانات التشخيص
المرتجعات
(() => void)دالة لإلغاء تسجيل الخطاف.

set

set(key: string, value: string): PubAdsService
تحدّد هذه الدالة قيمًا لسمات AdSense التي تنطبق على جميع الخانات الإعلانية ضمن خدمة Publisher Ads.

سيؤدي استدعاء هذه الدالة أكثر من مرة للمفتاح نفسه إلى إلغاء القيم المحدّدة سابقًا لذلك المفتاح. يجب ضبط جميع القيم قبل استدعاء display أو refresh.
مثال

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});
انظر أيضًا
المعلمات
key: stringاسم السمة
value: stringقيمة السمة
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService
تضبط هذه الطريقة استبعاد فئة إعلانية على مستوى الصفحة لاسم التصنيف المحدّد.
مثال

JavaScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

TypeScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});
انظر أيضًا
المعلمات
categoryExclusion: stringتصنيف استبعاد فئة الإعلان المطلوب إضافته
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

setCentering

setCentering(centerAds: boolean): void
تفعيل التوسيط الأفقي للإعلانات وإيقافه يكون خيار التوسيط غير مفعَّل تلقائيًا. في gpt_mobile.js القديم، يتم تفعيل التوسيط تلقائيًا.

يجب استدعاء هذه الطريقة قبل استدعاء display أو refresh لأنّه سيتم توسيط الإعلانات التي يتم طلبها بعد استدعاء هذه الطريقة فقط.
مثال

JavaScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

TypeScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});
المعلمات
centerAds: booleantrue لتوسيط الإعلانات، وfalse لمحاذاتها إلى اليمين.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
تحدّد هذه المَعلمة ما إذا كان يجب فرض عرض جميع الإعلانات على الصفحة باستخدام حاوية SafeFrame.

يُرجى مراعاة ما يلي أثناء استخدام واجهة برمجة التطبيقات هذه:
  • لن يسري هذا الإعداد إلا على طلبات عرض الإعلانات اللاحقة التي يتم إجراؤها للخانات الإعلانية المعنيّة.
  • في حال تحديد الإعداد على مستوى الخانة الإعلانية، سيتم دائمًا إلغاء الإعداد على مستوى الصفحة.
  • في حال ضبطها على true (على مستوى الخانة الإعلانية أو الصفحة)، سيتم دائمًا عرض الإعلان باستخدام حاوية SafeFrame بغض النظر عن الخيار المحدّد في واجهة مستخدم "إدارة إعلانات Google".
  • ومع ذلك، إذا تم ضبطها على false أو تُركت بدون تحديد، سيتم عرض الإعلان باستخدام حاوية SafeFrame استنادًا إلى نوع تصميم الإعلان والاختيار الذي تم إجراؤه في واجهة مستخدم "مدير إعلانات Google".
  • يجب استخدام واجهة برمجة التطبيقات هذه بحذر لأنّها قد تؤثر في سلوك تصاميم الإعلانات التي تحاول الخروج من إطارات iFrame أو تعتمد على عرضها مباشرةً في صفحة الناشر.
مثال

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

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

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

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

TypeScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

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

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

googletag.display("div-1");
googletag.display("div-2");
انظر أيضًا
المعلمات
forceSafeFrame: booleantrue لفرض عرض جميع الإعلانات على الصفحة في SafeFrames وfalse لتغيير الإعداد السابق إلى "خطأ". لن يؤدي ضبط هذا الخيار على false إلى تغيير أي شيء إذا لم يتم تحديده سابقًا.
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

setLocation

setLocation(address: string): PubAdsService
يتم تمرير معلومات الموقع الجغرافي من المواقع الإلكترونية لتتمكّن من استهداف مواقع جغرافية معيّنة في تفاصيل الإعلان.
مثال

JavaScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

TypeScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});
المعلمات
address: stringعنوان بتنسيق حر
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
تتيح ضبط جميع إعدادات الخصوصية من واجهة برمجة تطبيقات واحدة باستخدام عنصر ضبط.
مثال

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");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
انظر أيضًا
المعلمات
ppid: stringمعرّف أبجدي رقمي يقدّمه الناشر يجب أن يتراوح عدد الأحرف بين 22 و150 حرفًا.
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
تضبط هذه الطريقة الإعدادات المفضّلة على مستوى الصفحة لإعدادات SafeFrame. سيتم تجاهل أي مفاتيح غير معروفة في عنصر الإعدادات. سيتم تجاهل الإعدادات بالكامل إذا تم تمرير قيمة غير صالحة لمفتاح معروف.

سيتم إلغاء هذه الإعدادات المفضّلة على مستوى الصفحة من خلال الإعدادات المفضّلة على مستوى الخانة، في حال تحديدها.
مثال

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

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

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

TypeScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

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

googletag.display("div-1");
googletag.display("div-2");
انظر أيضًا
المعلمات
config: SafeFrameConfigعنصر الإعدادات
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService
تضبط هذه الطريقة مَعلمات استهداف مخصّصة لمفتاح معيّن تنطبق على جميع الخانات الإعلانية في خدمة "إعلانات الناشرين". سيؤدي استدعاء هذه الدالة عدة مرات للمفتاح نفسه إلى استبدال القيم القديمة. يتم تحديد هذه المفاتيح في حسابك على "إدارة إعلانات Google".
مثال

JavaScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});
انظر أيضًا
المعلمات
key: stringمفتاح مَعلمة الاستهداف
value: string | string[]قيمة مَعلمة الاستهداف أو مصفوفة القيم
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الطريقة عليه

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void
تحدّد هذه المَعلمة معلومات محتوى الفيديو التي سيتم إرسالها مع طلبات عرض الإعلان لأغراض الاستهداف واستبعاد المحتوى. سيتم تفعيل إعلانات الفيديو تلقائيًا عند استدعاء هذه الطريقة. بالنسبة إلى videoContentId وvideoCmsId، استخدِم القيم المقدَّمة لخدمة تحليل المحتوى في "إدارة إعلانات Google".
انظر أيضًا
المعلمات
videoContentId: stringمعرّف محتوى الفيديو
videoCmsId: stringمعرّف الفيديو في نظام إدارة المحتوى

updateCorrelator

updateCorrelator(): PubAdsService
يغيّر هذا الإجراء الارتباط الذي يتم إرساله مع طلبات عرض الإعلانات، ما يؤدي إلى بدء مشاهدة صفحة جديدة بشكل فعّال. ويكون الارتباط هو نفسه لجميع طلبات عرض الإعلانات الواردة من مشاهدة صفحة واحدة، ويكون فريدًا في جميع مشاهدات الصفحة. ينطبق ذلك على الوضع غير المتزامن فقط.

ملاحظة: لا يؤثر ذلك في مشاهدة الصفحة على الويب الطويلة الأمد في علامة GPT، والتي تعكس تلقائيًا الإعلانات المعروضة فعليًا على الصفحة وليس لها وقت انتهاء صلاحية.
مثال

JavaScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

TypeScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.
المرتجعات
PubAdsServiceعنصر الخدمة الذي تم استدعاء الدالة عليه

googletag.RequestHook

دالّة رد الاتصال التي يتم استدعاؤها قبل كل طلب عرض إعلان عند التسجيل من خلال PubAdsService.registerRequestHook.

googletag.ResponseInformation

عنصر يمثّل استجابة إعلان واحدة
الخصائص
advertiserId
رقم تعريف المعلِن
campaignId
رقم تعريف الحملة.
creativeId
رقم تعريف تصميم الإعلان
creativeTemplateId
رقم تعريف نموذج الإعلان.
lineItemId
رقم تعريف البند الإعلاني
انظر أيضًا

الخصائص

advertiserId

advertiserId: number
رقم تعريف المعلِن

campaignId

campaignId: number
رقم تعريف الحملة.

creativeId

creativeId: number
رقم تعريف تصميم الإعلان

creativeTemplateId

creativeTemplateId: number
رقم تعريف نموذج الإعلان.

lineItemId

lineItemId: number
رقم تعريف البند الإعلاني

googletag.RewardedPayload

عنصر يمثّل المكافأة المرتبطة بـ إعلان مقابل مكافأة
الخصائص
amount
عدد العناصر المضمّنة في المكافأة
type
نوع العنصر المضمَّن في المكافأة (على سبيل المثال، "عملة").
انظر أيضًا

الخصائص

amount

amount: number
عدد العناصر المضمّنة في المكافأة

type

type: string
نوع العنصر المضمَّن في المكافأة (على سبيل المثال، "عملة").

googletag.Service

فئة الخدمة الأساسية التي تحتوي على طرق شائعة لجميع الخدمات.
الطُرق
addEventListener
يتم تسجيل أداة مراقبة أحداث تتيح لك إعداد دالة JavaScript واستدعائها عند وقوع حدث GPT معيّن على الصفحة.
getSlots
احصل على قائمة الفترات الزمنية المرتبطة بهذه الخدمة.
removeEventListener
لإزالة مستمع تم تسجيله سابقًا

الطُرق

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
يتم تسجيل أداة مراقبة أحداث تتيح لك إعداد دالة JavaScript واستدعائها عند وقوع حدث GPT معيّن على الصفحة. في ما يلي الأحداث المتوافقة: يتم تمرير عنصر من نوع الحدث المناسب إلى المستمع عند استدعائه.
مثال

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

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

getSlots(): Slot[]
احصل على قائمة الفترات الزمنية المرتبطة بهذه الخدمة.
المرتجعات
Slot[]الخانات حسب ترتيب إضافتها إلى الخدمة

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
لإزالة مستمع تم تسجيله سابقًا
مثال

JavaScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

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

أداة إنشاء لعناصر مواصفات تعيين الحجم يتم توفير أداة الإنشاء هذه للمساعدة في إنشاء مواصفات الحجم بسهولة.
الطُرق
addSize
تضيف هذه الطريقة عملية ربط من مصفوفة ذات حجم واحد (تمثّل إطار العرض) إلى مصفوفة ذات حجم واحد أو مصفوفات متعددة الأحجام تمثّل خانة الإعلان.
build
تنشئ مواصفات خريطة الأحجام من عمليات الربط التي تمت إضافتها إلى أداة الإنشاء هذه.
انظر أيضًا

الطُرق

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 &lt; 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 &lt; 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
تنشئ هذه الطريقة مواصفات لعمليات ربط الأحجام من عمليات الربط التي تمت إضافتها إلى أداة الإنشاء هذه.

في حال تقديم أي عمليات ربط غير صالحة، ستعرض هذه الطريقة null. بخلاف ذلك، تعرض المواصفات بالتنسيق الصحيح لتمريرها إلى Slot.defineSizeMapping.

ملاحظة: سلوك أداة الإنشاء بعد استدعاء هذه الطريقة غير محدّد.
المرتجعات
SizeMappingArrayالنتيجة التي تم إنشاؤها بواسطة أداة الإنشاء هذه يمكن أن تكون القيمة فارغة إذا تم تقديم تعيينات أحجام غير صالحة.

googletag.Slot

الخانة هي عنصر يمثّل خانة إعلانية واحدة على صفحة.
الطُرق
addService
يضيف هذا الإجراء خدمة إلى هذه الخانة.
clearCategoryExclusions
تمّت إزالة هذا العمود. يؤدي هذا الإجراء إلى محو جميع تصنيفات استبعاد فئات الإعلانات على مستوى الخانة لهذه الخانة.
clearTargeting
تمّت إزالة هذا العمود. يمحو هذا الخيار مَعلمات استهداف معيّنة أو جميع مَعلمات الاستهداف المخصّصة على مستوى الخانة لهذه الخانة.
defineSizeMapping
يتم ضبط مصفوفة من عمليات الربط من الحد الأدنى لحجم إطار العرض إلى حجم الخانة لهذه الخانة.
get
تمّت إزالة هذا العمود. تعرض هذه الطريقة قيمة سمة AdSense المرتبطة بالمفتاح المحدّد لهذه الخانة.
getAdUnitPath
تعرض هذه السمة المسار الكامل للوحدة الإعلانية، مع رمز الشبكة ومسار الوحدة الإعلانية.
getAttributeKeys
تمّت إزالة هذا العمود. تعرض هذه الطريقة قائمة بمفاتيح السمات التي تم ضبطها في هذه الخانة.
getCategoryExclusions
تمّت إزالة هذا العمود. تعرض تصنيفات استبعاد فئات الإعلانات لهذه الخانة.
getConfig
تحصل على نسخة مجمّدة من خيارات الإعدادات العامة للمساحة الإعلانية التي تم ضبطها من خلال setConfig.
getResponseInformation
يعرض معلومات استجابة الإعلان.
getSlotElementId
تعرض هذه الدالة رقم تعريف الخانة div الذي تم تقديمه عند تحديد الخانة.
getTargeting
تمّت إزالة هذا العمود. تعرض هذه الطريقة معلَمة استهداف مخصّصة معيّنة تم ضبطها على هذه الخانة.
getTargetingKeys
تمّت إزالة هذا العمود. تعرض هذه الطريقة قائمة بجميع مفاتيح الاستهداف المخصّصة التي تم ضبطها في هذه الخانة.
set
تمّت إزالة هذا العمود. تحدّد هذه الطريقة قيمة لسمة AdSense في هذه الخانة الإعلانية.
setCategoryExclusion
تمّت إزالة هذا العمود. يضبط تصنيفًا لاستبعاد فئات الإعلانات على مستوى الخانة في هذه الخانة.
setClickUrl
تمّت إزالة هذا العمود. يضبط عنوان URL للنقرة الذي ستتم إعادة توجيه المستخدمين إليه بعد النقر على الإعلان.
setCollapseEmptyDiv
تمّت إزالة هذا العمود. يحدّد ما إذا كان يجب إخفاء الخانة div في حال عدم توفّر إعلان فيها.
setConfig
يضبط خيارات الإعدادات العامة لهذه الخانة.
setForceSafeFrame
تمّت إزالة هذا العمود. تحدّد هذه السياسة ما إذا كان يجب فرض عرض الإعلانات في هذه الخانة باستخدام حاوية SafeFrame.
setSafeFrameConfig
تمّت إزالة هذا العمود. تضبط الإعدادات المفضّلة على مستوى الخانة لإعدادات SafeFrame.
setTargeting
تمّت إزالة هذا العمود. يتم ضبط مَعلمة استهداف مخصّصة لهذه الخانة.
updateTargetingFromMap
تمّت إزالة هذا العمود. تحدّد هذه الطريقة مَعلمات الاستهداف المخصّصة لهذه الخانة الإعلانية، من خريطة مفتاح:قيمة في عنصر JSON.

الطُرق

addService

addService(service: Service): Slot
يضيف هذا الإجراء خدمة إلى هذه الخانة.
مثال

JavaScript

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

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
انظر أيضًا
المعلمات
service: Serviceالخدمة التي ستتم إضافتها
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

clearCategoryExclusions

clearCategoryExclusions(): Slot
تؤدي هذه الطريقة إلى محو جميع تصنيفات استبعاد فئات الإعلانات على مستوى الخانة لهذه الخانة.
مثال

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

clearTargeting

clearTargeting(key?: string): Slot
تؤدي هذه الطريقة إلى محو معلَمات استهداف معيّنة أو جميعها على مستوى الخانة لهذه الخانة.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.
انظر أيضًا
المعلمات
Optional key: stringمفتاح مَعلمة الاستهداف المفتاح اختياري، وسيتم محو جميع مَعلمات الاستهداف إذا لم يتم تحديده.
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot
يضبط مصفوفة من عمليات الربط من الحد الأدنى لحجم إطار العرض إلى حجم الخانة لهذه الخانة.
مثال

JavaScript

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

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

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")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.
انظر أيضًا
المعلمات
key: stringاسم السمة المطلوب البحث عنها
المرتجعات
stringالقيمة الحالية لمفتاح السمة، أو null إذا لم يكن المفتاح متوفّرًا.

getAdUnitPath

getAdUnitPath(): string
تعرض هذه السمة المسار الكامل للوحدة الإعلانية، مع رمز الشبكة ومسار الوحدة الإعلانية.
مثال

JavaScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.

TypeScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.
المرتجعات
stringمسار الوحدة الإعلانية

getAttributeKeys

getAttributeKeys(): string[]
تعرض قائمة مفاتيح السمات التي تم ضبطها في هذه الخانة. للاطّلاع على مفاتيح السمات على مستوى الخدمة التي تكتسبها خانة الإعلان هذه، استخدِم PubAdsService.getAttributeKeys.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].
المرتجعات
string[]مصفوفة من مفاتيح السمات الترتيب غير محدّد.

getCategoryExclusions

getCategoryExclusions(): string[]
تعرض هذه الدالة تصنيفات استبعاد فئات الإعلانات لهذه الخانة.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].
المرتجعات
string[]تصنيفات استبعاد فئات الإعلانات لهذه الخانة، أو مصفوفة فارغة في حال عدم ضبط أي تصنيفات

getConfig

getConfig(keys: string | string[]): Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>
تتيح هذه الطريقة الحصول على نسخة ثابتة من خيارات الإعدادات العامة للمساحة الإعلانية التي تم ضبطها من خلال setConfig.

لا تتوافق بعض سمات setConfig() مع هذه الطريقة. السمات المتوافقة هي:
مثال

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
المعلمات
keys: string | string[]مفاتيح خيارات الضبط التي تريد الحصول عليها
المرتجعات
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>نسخة مجمّدة من خيارات الضبط الخاصة بالخانة

getResponseInformation

getResponseInformation(): ResponseInformation
يعرض معلومات استجابة الإعلان. ويستند ذلك إلى آخر استجابة للإعلان في الخانة. إذا تم استدعاء هذه الدالة عندما لا تتضمّن الخانة أي إعلان، سيتم عرض القيمة null.
المرتجعات
ResponseInformationأحدث معلومات استجابة الإعلان، أو null إذا لم تكن الخانة تحتوي على إعلان.

getSlotElementId

getSlotElementId(): string
تعرض هذه الدالة رقم تعريف الخانة div الذي تم تقديمه عند تحديد الخانة.
مثال

JavaScript

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

slot.getSlotElementId();
// Returns 'div'.

TypeScript

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

slot.getSlotElementId();
// Returns 'div'.
المرتجعات
stringرقم تعريف الخانة div

getTargeting

getTargeting(key: string): string[]
تعرض هذه الدالة معلَمة استهداف مخصّصة معيّنة تم ضبطها على هذه الخانة الإعلانية. لا يتم تضمين مَعلمات الاستهداف على مستوى الخدمة.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).
المعلمات
key: stringمفتاح الاستهداف المطلوب البحث عنه
المرتجعات
string[]القيم المرتبطة بهذا المفتاح، أو مصفوفة فارغة في حال عدم توفّر هذا المفتاح

getTargetingKeys

getTargetingKeys(): string[]
تعرض هذه الدالة قائمة بجميع مفاتيح الاستهداف المخصّصة التي تم ضبطها في هذه الخانة. لا يتم تضمين مفاتيح الاستهداف على مستوى الخدمة.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].
المرتجعات
string[]مصفوفة من مفاتيح الاستهداف الترتيب غير محدّد.

set

set(key: string, value: string): Slot
تحدّد هذه الدالة قيمة لسمة AdSense في هذه الخانة الإعلانية. سيؤدي ذلك إلى إلغاء أي قيم تم ضبطها على مستوى الخدمة لهذا المفتاح.

سيؤدي استدعاء هذه الطريقة أكثر من مرة للمفتاح نفسه إلى إلغاء القيم التي تم ضبطها سابقًا لهذا المفتاح. يجب ضبط جميع القيم قبل استدعاء display أو refresh.
مثال

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());
انظر أيضًا
المعلمات
key: stringاسم السمة
value: stringقيمة السمة
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot
يضبط تصنيف استبعاد فئة إعلانية على مستوى الخانة في هذه الخانة.
مثال

JavaScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());
انظر أيضًا
المعلمات
categoryExclusion: stringتصنيف استبعاد فئة الإعلان المطلوب إضافته
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

setClickUrl

setClickUrl(value: string): Slot
يتم ضبط عنوان URL للنقرة الذي ستتم إعادة توجيه المستخدمين إليه بعد النقر على الإعلان.

تواصل خوادم "إدارة إعلانات Google" تسجيل النقرات حتى في حال استبدال عنوان URL للنقرة. تتم إضافة أي عنوان URL للصفحة المقصودة مرتبط بتصميم الإعلان الذي يتم عرضه إلى القيمة المقدَّمة. وتؤدي الطلبات اللاحقة إلى استبدال القيمة. لا تعمل هذه الميزة إلا مع الطلبات التي لا تستخدم بنية الإعلان الأحادي الطلب (SRA).
مثال

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());
المعلمات
value: stringعنوان URL للنقرة المطلوب ضبطه
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
تحدّد هذه السمة ما إذا كان يجب إخفاء الخانة div في حال عدم توفّر إعلان فيها. يؤدي ذلك إلى إلغاء الإعدادات على مستوى الخدمة.
مثال

JavaScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.
انظر أيضًا
المعلمات
collapse: booleanما إذا كان سيتم تصغير الخانة في حال عدم عرض أي إعلان
Optional collapseBeforeAdFetch: booleanما إذا كان سيتم تصغير الخانة حتى قبل جلب الإعلان يتم تجاهل هذه السمة إذا لم تكن قيمة سمة التصغير true.
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot
يضبط خيارات الإعدادات العامة لهذه الخانة.
المعلمات
slotConfig: SlotSettingsConfigعنصر الإعدادات
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
تحدّد هذه الطريقة ما إذا كان يجب فرض عرض الإعلانات في هذه الخانة باستخدام حاوية SafeFrame.

يُرجى مراعاة ما يلي أثناء استخدام واجهة برمجة التطبيقات هذه:
  • لن يسري هذا الإعداد إلا على طلبات عرض الإعلانات اللاحقة التي يتم إجراؤها للخانات الإعلانية المعنيّة.
  • في حال تحديد الإعداد على مستوى الخانة الإعلانية، سيتم دائمًا إلغاء الإعداد على مستوى الصفحة.
  • في حال ضبطها على true (على مستوى الخانة الإعلانية أو الصفحة)، سيتم دائمًا عرض الإعلان باستخدام حاوية SafeFrame بغض النظر عن الخيار المحدّد في واجهة مستخدم "إدارة إعلانات Google".
  • ومع ذلك، إذا تم ضبطها على false أو تُركت بدون تحديد، سيتم عرض الإعلان باستخدام حاوية SafeFrame استنادًا إلى نوع تصميم الإعلان والاختيار الذي تم إجراؤه في واجهة مستخدم "مدير إعلانات Google".
  • يجب استخدام واجهة برمجة التطبيقات هذه بحذر لأنّها قد تؤثر في سلوك تصاميم الإعلانات التي تحاول الخروج من إطارات iFrame أو تعتمد على عرضها مباشرةً في صفحة الناشر.
مثال

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: booleantrue لفرض عرض جميع الإعلانات في هذه الخانة في SafeFrames و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");

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".
مثال

JavaScript

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

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

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});
انظر أيضًا
المعلمات
key: stringمفتاح مَعلمة الاستهداف
value: string | string[]قيمة مَعلمة الاستهداف أو مصفوفة القيم
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot
تضبط هذه الطريقة مَعلمات الاستهداف المخصّصة لهذه الخانة الإعلانية، من خريطة مفتاح:قيمة في عنصر JSON. وهذا يشبه استدعاء Slot.setTargeting لجميع قيم المفاتيح في الكائن. يتم تحديد هذه المفاتيح في حسابك على "إدارة إعلانات Google".

ملاحظات:
  • في حال الاستبدال، سيتم الاحتفاظ بالقيمة الأخيرة فقط.
  • إذا كانت القيمة مصفوفة، سيتم استبدال أي قيمة سابقة، وليس دمجها.
  • ستحلّ القيم المحدّدة هنا محلّ مَعلمات الاستهداف المحدّدة على مستوى الخدمة.
مثال

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});
المعلمات
map: {
  [adUnitPath: string]: string | string[];
}		خريطة المفتاح:القيمة لمَعلمة الاستهداف
المرتجعات
Slotعنصر الخانة الذي تم استدعاء الطريقة عليه

googletag.config

واجهة الضبط الرئيسية للإعدادات على مستوى الصفحة
واجهات
AdExpansionConfig
إعدادات للتحكّم في توسيع خانة الإعلان
AdSenseAttributesConfig
إعدادات للتحكّم في سلوك إعلانات AdSense
AutoRefreshConfig
إعدادات ضبط إعادة التحميل التلقائي
ContinueButtonConfig
إعدادات لضبط سلوك زر المتابعة
InterstitialConfig
عنصر يحدّد سلوك خانة إعلانية بينية واحدة
LazyLoadConfig
إعدادات للتحكّم في استخدام ميزة "التحميل الكسول" في علامة GPT
PageSettingsConfig
واجهة الضبط الرئيسية للإعدادات على مستوى الصفحة
PrivacyTreatmentsConfig
إعدادات للتحكّم في معالجات الخصوصية لدى الناشرين
PublisherProvidedSignalsConfig
عنصر ضبط الإشارات المقدَّمة من الناشر (PPS)
SafeFrameConfig
إعدادات للتحكّم في SafeFrame في GPT
SlotSettingsConfig
واجهة الضبط الرئيسية للإعدادات على مستوى الخانة
TaxonomyData
عنصر يحتوي على قيم تصنيف واحد.
VideoAdsConfig
إعدادات لضبط الإعدادات ذات الصلة بإعلانات الفيديو
الأسماء المستعارة للأنواع
CollapseDivBehavior
القيم المسموح بها للتحكّم في سلوك تصغير الخانات الإعلانية
InterstitialTrigger
عوامل التشغيل المتوافقة لـ "الإعلانات البينية"
PrivacyTreatment
إجراءات الخصوصية المتوافقة مع الناشرين
Taxonomy
التصنيفات المتوافقة مع الإشارات المقدَّمة من الناشر (PPS)

الأسماء المستعارة للأنواع

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"
القيم المسموح بها للتحكّم في سلوك تصغير الخانات الإعلانية
انظر أيضًا

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"
إجراءات تفعيل "الإعلانات البينية" المتاحة.

ملاحظة: اعتبارًا من 15 يونيو 2026، لن يكون إجراء التفعيل backward متاحًا ولن يؤدي تفعيله إلى أي نتيجة. لمزيد من المعلومات، يُرجى الاطّلاع على ملاحظات إصدار GPT.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
إجراءات الخصوصية المتوافقة مع الناشرين

التصنيف

googletag.config.AdExpansionConfig

إعدادات للتحكّم في توسيع خانة الإعلان
الخصائص
enabled?
ما إذا كانت ميزة توسيع خانة الإعلان مفعَّلة أو غير مفعَّلة
مثال

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".
انظر أيضًا

googletag.config.AdSenseAttributesConfig

إعدادات للتحكّم في سلوك إعلانات AdSense

يمكن استخدام هذه السمات لإلغاء الإعدادات من جهة الخادم لكل طلب.
الخصائص
adsense_ad_format?
شكل إعلان AdSense
adsense_channel_ids?
معرّفات قنوات AdSense
adsense_test_mode?
ما إذا كان وضع الاختبار مفعَّلاً أم لا
document_language?
لغة الصفحة التي يتم عرض الإعلانات عليها
page_url?
عنوان 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"
شكل إعلان AdSense

Optional adsense_channel_ids

adsense_channel_ids?: string
معرّفات قنوات AdSense

القيم المسموح بها هي معرّفات القنوات مفصولة بعلامة "+".

مثال: 271828183+314159265
انظر أيضًا

Optional adsense_test_mode

adsense_test_mode?: "on"
تشير إلى ما إذا كان وضع الاختبار مفعَّلاً أم لا.

عند ضبطها على on، يتم وضع علامة على الإعلانات بأنّها مخصّصة للاختبار فقط، ولن يتم تضمينها في الاحتساب أو الفوترة. يجب إلغاء ضبط هذا الإعداد لزيارات الإنتاج غير الاختبارية.

Optional document_language

document_language?: string
لغة الصفحة التي يتم عرض الإعلانات عليها

القيم المسموح بها هي رموز لغات صالحة وفقًا لمعيار ISO 639-1.

مثال: en
انظر أيضًا

Optional page_url

page_url?: string
عنوان URL للصفحة التي يتم عرض الإعلانات عليها

القيم المسموح بها هي عناوين URL صالحة.

مثال: http://www.example.com

googletag.config.AutoRefreshConfig

إعدادات ضبط إعادة التحميل التلقائي
الخصائص
backForwardCache?
ما إذا كانت علامة GPT ستُعيد تحميل خانة إعلانية يتم عرضها بشكل نشط تلقائيًا عند استعادة الصفحة من ميزة "التخزين المؤقت للصفحات".
heavyAds?
ما إذا كانت علامة GPT ستُعيد تحميل خانة إعلانية تلقائيًا في حال تفعيل ميزة "التدخّل في الإعلانات الثقيلة" في Chrome على إطار iframe الخاص بالإعلان في الخانة.

الخصائص

Optional backForwardCache

backForwardCache?: boolean
ما إذا كانت علامة GPT ستُعيد تحميل خانة إعلانية يتم عرضها بشكل نشط تلقائيًا عند استعادة الصفحة من ميزة "التخزين المؤقت للصفحات". القيمة التلقائية هي true.
مثال

JavaScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });
انظر أيضًا

Optional heavyAds

heavyAds?: boolean
ما إذا كانت علامة GPT ستُعيد تحميل خانة إعلانية تلقائيًا في حال تفعيل ميزة "التدخّل في الإعلانات الثقيلة" في Chrome على إطار iframe الخاص بالإعلان في الخانة. القيمة التلقائية هي true.
مثال

JavaScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });
انظر أيضًا

googletag.config.ContinueButtonConfig

إعدادات لضبط سلوك زر المتابعة
الخصائص
backgroundColor?
لون خلفية الزر
font?
مجموعة خطوط نص الزر
fontColor?
لون نص الزر
freqCapIntervalMinutes?
الفاصل الزمني لتحديد عدد مرات الظهور بالدقائق
targetId?
رقم تعريف عنصر HTML الذي سيتم عرض زر المتابعة عليه أو تفعيله.
انظر أيضًا

الخصائص

Optional backgroundColor

backgroundColor?: string
لون خلفية الزر

مثال: 'blue'، '#94B1FF'

Optional خط

font?: string
مجموعة خطوط نص الزر

مثال: 'Arial'

Optional fontColor

fontColor?: string
لون نص الزر

مثال: 'white'، '#B73B87'

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number
تمثّل هذه السمة الفاصل الزمني لتحديد عدد مرات الظهور بالدقائق.

يجب أن تكون عددًا صحيحًا أكبر من أو يساوي 1.

Optional targetId

targetId?: string
رقم تعريف عنصر HTML الذي سيتم عرض زر المتابعة عليه أو تفعيله.

googletag.config.InterstitialConfig

عنصر يحدّد سلوك خانة إعلانية بينية واحدة
الخصائص
requireStorageAccess?
ما إذا كانت الموافقة على التخزين المحلي مطلوبة لعرض هذا الإعلان البيني.
triggers?
إعدادات مشغّل "الإعلان البيني" لهذا الإعلان

الخصائص

Optional requireStorageAccess

requireStorageAccess?: boolean
تحدّد هذه السمة ما إذا كانت الموافقة على التخزين المحلي مطلوبة لعرض هذا الإعلان البيني.

تستخدم علامة GPT التخزين المحلي لفرض حدّ لعدد مرات الظهور للإعلانات البينية. ومع ذلك، يظل المستخدمون الذين لم يمنحوا موافقة على استخدام مساحة التخزين المحلية مؤهَّلين لعرض "الإعلانات البينية". يؤدي ضبط هذه السمة على 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
  },
});

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".
مثال

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

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
الخصائص
fetchMarginPercent?
الحدّ الأدنى للمسافة من إطار العرض الحالي الذي يجب أن تكون فيه الخانة قبل طلب إعلان، ويتم التعبير عنه كنسبة مئوية من حجم إطار العرض.
mobileScaling?
مُضاعِف يتم تطبيقه على الهوامش على الأجهزة الجوّالة
renderMarginPercent?
الحدّ الأدنى للمسافة من إطار العرض الحالي الذي يجب أن تكون فيه خانة إعلانية قبل عرض إعلان، ويتم التعبير عنه كنسبة مئوية من حجم إطار العرض.
انظر أيضًا

الخصائص

Optional fetchMarginPercent

fetchMarginPercent?: number
الحد الأدنى للمسافة من إطار العرض الحالي الذي يجب أن تكون فيه الخانة قبل طلب إعلان، ويتم التعبير عنه كنسبة مئوية من حجم إطار العرض.

عند استخدام هذا الإعداد مع renderMarginPercent، يسمح بالجلب المُسبق لإعلان، ولكن مع الانتظار لعرض الموارد الفرعية الأخرى وتنزيلها. وعلى هذا النحو، يجب أن تكون هذه القيمة دائمًا أكبر من أو تساوي renderMarginPercent.

تعني القيمة 0 "عندما تدخل الخانة إطار العرض"، وتعني القيمة 100 "عندما يكون الإعلان على بُعد إطار عرض واحد"، وهكذا.

Optional mobileScaling

mobileScaling?: number
مُضاعِف يتم تطبيقه على الهوامش على الأجهزة الجوّالة يتم تطبيق هذا المضاعِف على كلّ من fetchMarginPercent وrenderMarginPercent.

يتيح ذلك استخدام هوامش مختلفة على الأجهزة الجوّالة مقارنةً بأجهزة الكمبيوتر المكتبي، حيث قد تختلف أحجام إطارات العرض وسرعات الانتقال. على سبيل المثال، ستؤدي القيمة 2.0 إلى مضاعفة جميع الهوامش في 2 على الأجهزة الجوّالة، ما يزيد من الحد الأدنى للمسافة التي يمكن أن تفصل بين الخانة وإطار العرض قبل جلب الإعلان وعرضه.

Optional renderMarginPercent

renderMarginPercent?: number
الحد الأدنى للمسافة من إطار العرض الحالي الذي يجب أن تكون فيه خانة إعلانية قبل عرض الإعلان، ويتم التعبير عنه كنسبة مئوية من حجم إطار العرض.

عند استخدام هذا الإعداد مع fetchMarginPercent، يسمح بالجلب المُسبق للإعلان، ولكن مع الانتظار لعرض الموارد الفرعية الأخرى وتنزيلها. على هذا النحو، يجب أن تكون هذه القيمة دائمًا أقل من أو تساوي fetchMarginPercent.

تعني القيمة 0 "عندما تدخل الخانة إلى إطار العرض"، وتعني القيمة 100 "عندما يكون الإعلان على بُعد إطار عرض واحد"، وهكذا.

googletag.config.PageSettingsConfig

واجهة الإعدادات الرئيسية للإعدادات على مستوى الصفحة

تسمح بضبط ميزات متعددة من خلال طلب بيانات من واجهة برمجة التطبيقات.

جميع السمات المدرَجة أدناه هي أمثلة ولا تعكس الميزات الفعلية التي تستخدم 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,
  });
الخصائص
adExpansion?
إعدادات للتحكّم في توسيع خانة الإعلان
adsenseAttributes?
إعداد لضبط سمات AdSense
adYield?
متوقّف نهائيًا. 
autoRefresh?
إعداد لضبط سلوك إعادة تحميل الإعلانات تلقائيًا
categoryExclusion?
إعداد لضبط استبعادات فئات الإعلانات
centering?
إعداد للتحكّم في توسيط الإعلانات أفقيًا
collapseDiv?
إعداد للتحكّم في سلوك تصغير الخانات الإعلانية
disableInitialLoad?
إعداد للتحكّم في وقت طلب الإعلانات
lazyLoad?
إعدادات للتحكّم في استخدام ميزة "التحميل الكسول" في علامة GPT
location?
إعداد لاستهداف المواقع الجغرافية في تفاصيل الإعلان.
pps?
إعدادات للتحكّم في الإشارات المقدَّمة من الناشر (PPS)
privacyTreatments?
إعدادات للتحكّم في معالجات الخصوصية لدى الناشرين
requestHookTimeoutMs?
إعداد للتحكّم في الحد الأقصى للوقت الذي ستنتظره علامة GPT حتى تكتمل جميع عمليات الربط المسجَّلة للطلبات قبل المتابعة في طلب عرض الإعلان.
safeFrame?
إعدادات للتحكّم في استخدام SafeFrame في GPT
singleRequest?
إعداد لتفعيل أو إيقاف بنية الإعلان الأحادي الطلب (SRA)
targeting?
إعداد للتحكّم في استهداف المفتاح/القيمة
threadYield?
إعداد للتحكّم في ما إذا كان يجب أن تتخلى علامة GPT عن سلسلة تعليمات JS عند طلب تصاميم الإعلانات وعرضها.
videoAds?
إعدادات للتحكّم في إعلانات الفيديو

الخصائص

Optional adExpansion

adExpansion?: AdExpansionConfig
إعدادات للتحكّم في توسيع خانة الإعلان

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
إعداد لضبط سمات AdSense.

ستنطبق سمات 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 });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Optional autoRefresh

autoRefresh?: AutoRefreshConfig
إعداد لضبط سلوك إعادة تحميل الإعلانات تلقائيًا
مثال

JavaScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

Optional categoryExclusion

categoryExclusion?: string[]
إعداد لضبط استبعادات فئات الإعلانات
مثال

JavaScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });
انظر أيضًا

Optional التوسيط

centering?: boolean
إعداد للتحكّم في توسيط الإعلانات أفقيًا يتم إيقاف التوسيط تلقائيًا.

لا تنطبق تغييرات التوسيط الأفقي إلا على طلبات عرض الإعلانات المطلوبة بعد استدعاء هذه الطريقة. لهذا السبب، ننصح بطلب هذه الطريقة قبل أي طلبات إلى googletag.display أو PubAdsService.refresh.
مثال

JavaScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
إعداد للتحكّم في سلوك تصغير الخانات الإعلانية.

لا تشغل الخانة الإعلانية المصغّرة أي مساحة على الصفحة.

القيم المسموح بها:
  • ‫null (تلقائي): لن يتم تصغير الخانة الإعلانية.
  • ‫DISABLED: لن يتم تصغير الخانة، سواء تم عرض إعلان أم لا.
  • ‫BEFORE_FETCH: ستبدأ الخانة في وضع التصغير، ثم تتوسّع عند عرض إعلان.
  • ‫ON_NO_FILL: ستبدأ الخانة الإعلانية موسَّعة، وسيتم تصغيرها في حال عدم عرض أي إعلان.
مثال

JavaScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

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

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });
انظر أيضًا

Optional lazyLoad

lazyLoad?: LazyLoadConfig
إعدادات للتحكّم في استخدام ميزة "التحميل الكسول" في GPT.

"التحميل الكسول" هو أسلوب لتأخير طلب الإعلانات وعرضها إلى أن تقترب من إطار عرض المستخدِم. للحصول على مثال أكثر تفصيلاً، يمكنك الاطّلاع على نموذج التحميل الكسول.

ملاحظة: في حال تفعيل 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 });

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

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?: PrivacyTreatmentsConfig
إعدادات للتحكّم في معالجات الخصوصية لدى الناشرين

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"
إعداد للتحكّم في الحدّ الأقصى للوقت الذي ستنتظره علامة GPT حتى تكتمل جميع دوال الربط المسجَّلة لطلبات الإعلانات قبل المتابعة في طلب عرض الإعلان.

يتم تنفيذ جميع دوال الربط المسجَّلة لطلبات الإعلانات بالتوازي. تحدّد هذه المهلة الحدّ الأقصى لمدة إيقاف عملية طلب عرض الإعلان مؤقتًا أثناء انتظار اكتمال عمليات التنفيذ الموازية.

القيم المسموح بها:
  • رقم موجب بالمللي ثانية: فترة الانتظار المخصّصة
  • ‫'auto': تستخدم علامة GPT مهلة محسّنة من Google.
  • ‫null: لإيقاف المهلات (تنتظر علامة GPT إلى أجل غير مسمى حتى تكتمل عمليات الربط)
مثال

JavaScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

TypeScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

Optional safeFrame

safeFrame?: SafeFrameConfig
الإعدادات التي تتحكّم في استخدام SafeFrame في علامة GPT.

ستنطبق القيم التي تم ضبطها من خلال هذا الإعداد على جميع الخانات الإعلانية في الصفحة. قد تلغي الخانات الإعلانية الفردية هذه القيم من خلال 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 });

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 في طلب عرض إعلان واحد. يوفّر ذلك مزايا في الأداء، ولكنه ضروري أيضًا لضمان الالتزام بحظر الإعلانات المتزامنة والاستبعادات التنافسية.

عند إيقاف بنية الإعلان الأحادي الطلب، يتم طلب كل خانة إعلانية بشكل فردي. هذا هو الإعداد التلقائي لـ GPT.

يجب استدعاء هذه الطريقة قبل استدعاء googletag.enableServices.
مثال

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".
مثال

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 عن سلسلة مهام JavaScript عند طلب تصاميم الإعلانات وعرضها.

لن تتخلى علامة GPT عن سلسلة المهام إلا للمتصفحات التي تتيح استخدام واجهة برمجة التطبيقات Scheduler.postTask أو Scheduler.yield.

القيم المسموح بها:
  • ‫null (تلقائي): ستتخلى علامة GPT عن سلسلة مهام JavaScript للخانات خارج إطار العرض.
  • ‫ENABLED_ALL_SLOTS: ستتخلى GPT عن سلسلة مهام JS لجميع الخانات بغض النظر عمّا إذا كانت الخانة ضمن إطار العرض.
  • DISABLED: لن تتيح علامة GPT استخدام سلسلة تعليمات JavaScript.
مثال

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

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

treatments: "disablePersonalization"[]
مصفوفة من معالجات الخصوصية التي يمكن للناشر تفعيلها
مثال

JavaScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

TypeScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

googletag.config.PublisherProvidedSignalsConfig

عنصر ضبط الإشارات المقدَّمة من الناشر (PPS)
الخصائص
taxonomies
عنصر يحتوي على عمليات ربط التصنيف أو قيمة فارغة لمحو الإعدادات
مثال

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 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

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
عنصر يحتوي على عمليات ربط التصنيف أو قيمة فارغة لمحو الإعدادات

googletag.config.SafeFrameConfig

إعدادات للتحكّم في SafeFrame في GPT
الخصائص
allowOverlayExpansion?
ما إذا كان يجب أن يسمح SafeFrame بتوسيع محتوى الإعلان من خلال تراكب محتوى الصفحة
allowPushExpansion?
ما إذا كان يجب أن يسمح SafeFrame بتوسيع محتوى الإعلان من خلال دفع محتوى الصفحة
forceSafeFrame?
ما إذا كان يجب فرض عرض الإعلانات باستخدام حاوية SafeFrame
sandbox?
ما إذا كان يجب أن يستخدم SafeFrame سمة وضع الحماية في HTML5 لمنع التنقّل في المستوى الأعلى بدون تفاعل المستخدم.
useUniqueDomain?
تمّت إزالة هذا العمود. ما إذا كان يجب أن يستخدم SafeFrame نطاقات فرعية عشوائية لتصاميم الإعلانات القائمة على الحجز.
انظر أيضًا

الخصائص

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean
ما إذا كان يجب أن يسمح SafeFrame بتوسيع محتوى الإعلان من خلال تراكب محتوى الصفحة

Optional allowPushExpansion

allowPushExpansion?: boolean
ما إذا كان يجب أن يسمح SafeFrame بتوسيع محتوى الإعلان من خلال دفع محتوى الصفحة

Optional forceSafeFrame

forceSafeFrame?: boolean
ما إذا كان يجب فرض عرض الإعلانات باستخدام حاوية SafeFrame

Optional sandbox

sandbox?: boolean
ما إذا كان يجب أن يستخدم SafeFrame سمة وضع الحماية في HTML5 لمنع التنقّل في المستوى الأعلى بدون تفاعل المستخدم. القيمة الصالحة الوحيدة هي true (لا يمكن فرضها على false). يُرجى العِلم أنّ سمة وضع الحماية توقف المكوّنات الإضافية (مثل Flash).

Optional useUniqueDomain

useUniqueDomain?: boolean
ما إذا كان يجب أن يستخدم SafeFrame نطاقات فرعية عشوائية لتصاميم الإعلانات القائمة على الحجز. يمكنك إدخال null لمحو القيمة المخزَّنة.

ملاحظة: تكون هذه الميزة مفعَّلة تلقائيًا.
انظر أيضًا

googletag.config.SlotSettingsConfig

واجهة الإعداد الرئيسية للإعدادات على مستوى الخانة

تسمح بضبط ميزات متعددة من خلال طلب بيانات من واجهة برمجة التطبيقات لخانة واحدة

جميع السمات المدرَجة أدناه هي أمثلة ولا تعكس الميزات الفعلية التي تستخدم 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,
  });
الخصائص
adExpansion?
إعدادات ضبط ميزة "توسيع خانة الإعلان"
adsenseAttributes?
إعداد لضبط سمات AdSense
categoryExclusion?
إعداد لضبط استبعادات فئات الإعلانات
clickUrl?
إعداد لضبط عنوان URL الذي ستتم إعادة توجيه المستخدمين إليه بعد النقر على الإعلان.
collapseDiv?
إعداد لضبط سلوك تصغير الخانة الإعلانية
continueButton?
إعدادات لضبط سلوك زر المتابعة في "الإعلانات أثناء إيقاف الفيديو مؤقتًا".
interstitial?
الإعدادات التي تضبط سلوك الخانة الإعلانية البينية
safeFrame?
إعدادات لضبط استخدام SafeFrame في GPT
targeting?
إعداد لضبط استهداف أزواج المفتاح/القيمة

الخصائص

Optional adExpansion

adExpansion?: AdExpansionConfig
إعدادات ضبط ميزة "توسيع خانة الإعلان"
انظر أيضًا

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
إعداد لضبط سمات AdSense.

لن تنطبق سمات 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 });

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

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
إعداد لضبط عنوان URL الذي ستتم إعادة توجيه المستخدمين إليه بعد النقر على الإعلان.

تستمر خوادم "إدارة إعلانات Google" في تسجيل النقرات حتى في حال استبدال عنوان 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,
});

TypeScript

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

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
إعداد لضبط سلوك تصغير الخانة الإعلانية.

لا تشغل الخانة الإعلانية المصغّرة أي مساحة على الصفحة.

القيم المسموح بها:
  • ‫null (تلقائي): لن يتم تصغير الخانة الإعلانية.
  • ‫DISABLED: لن يتم تصغير الخانة، سواء تم عرض إعلان أم لا.
  • ‫BEFORE_FETCH: ستبدأ الخانة في وضع التصغير، ثم تتوسّع عند عرض إعلان.
  • ‫ON_NO_FILL: ستبدأ الخانة الإعلانية موسَّعة، وسيتم تصغيرها في حال عدم عرض أي إعلان.
مثال

JavaScript

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

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

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

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});
انظر أيضًا

Optional continueButton

continueButton?: ContinueButtonConfig
إعدادات لضبط سلوك زر المتابعة في "الإعلانات أثناء إيقاف الفيديو مؤقتًا".

تسمح هذه الإعدادات بتخصيص مظهر وسلوك تفاعلات الخروج ومواصلة القراءة المرتبطة بأشكال "الإعلانات أثناء إيقاف الفيديو مؤقتًا".

أي إعدادات لزر المتابعة لم يتم تحديدها عند استدعاء setConfig() ستستخدم قيمة تلقائية تحددها Google.

لإيقاف أو محو جميع إعدادات زر المتابعة، يمكنك تمرير null.
مثال

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

Optional إعلان بيني

interstitial?: InterstitialConfig
الإعدادات التي تضبط سلوك الخانة الإعلانية البينية
انظر أيضًا

Optional safeFrame

safeFrame?: SafeFrameConfig
إعدادات لضبط استخدام SafeFrame في GPT.

لن تنطبق القيم التي تم ضبطها من خلال هذا الإعداد إلا على الخانة الإعلانية، وستلغي القيم التي تم ضبطها من خلال 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 });

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".
مثال

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

TypeScript

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

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });
انظر أيضًا

googletag.config.TaxonomyData

عنصر يحتوي على قيم تصنيف واحد.
الخصائص
values
قائمة بقيم التصنيف

الخصائص

values

values: readonly string[]
قائمة بقيم التصنيف

googletag.config.VideoAdsConfig

إعدادات لضبط الإعدادات ذات الصلة بإعلانات الفيديو
الخصائص
enableVideoAds
ما إذا كانت إعلانات الفيديو ستظهر على الصفحة
videoCmsId?
رقم تعريف مصدر محتوى الفيديو
videoContentId?
معرّف محتوى الفيديو
انظر أيضًا

الخصائص

enableVideoAds

enableVideoAds: boolean
تحدّد ما إذا كانت إعلانات الفيديو ستظهر على الصفحة.

عند ضبطها على true، يتم تفعيل قيود استبعاد المحتوى على "الإعلانات الصورية" و"إعلانات الفيديو".

إذا كان محتوى الفيديو معروفًا، اضبط videoContentId وvideoCmsId على القيم المقدَّمة لخدمة تحليل المحتوى في "إدارة إعلانات Google" لاستخدام ميزة استبعاد المحتوى في "الإعلانات الصورية".

Optional videoCmsId

videoCmsId?: string
رقم تعريف مصدر محتوى الفيديو

هذه قيمة فريدة تحدّدها خدمة تحليل المحتوى في "إدارة إعلانات Google" لتحديد مصدر محتوى الفيديو الذي يحدّده videoContentId.
انظر أيضًا

Optional videoContentId

videoContentId?: string
معرّف محتوى الفيديو

هذه قيمة فريدة تحدّد فيديو معيّنًا من مصدر المحتوى الذي يحدّده videoCmsId. يتم تعيين هذه القيمة من خلال نظام إدارة المحتوى الذي يستضيف محتوى الفيديو.
انظر أيضًا

googletag.enums

هذه هي مساحة الاسم التي تستخدمها علامة GPT لأنواع التعداد.
التعدادات
OutOfPageFormat
أشكال الإعلانات خارج الصفحة التي تتيحها علامة GPT
TagForAgeTreatment
إعدادات معالجة الطلبات حسب العمر التي تتيحها علامة GPT
TrafficSource
مصادر الزيارات المتوافقة مع علامة GPT

التعدادات

OutOfPageFormat

OutOfPageFormat
أشكال الإعلانات خارج الصفحة التي تتيحها علامات GPT
انظر أيضًا
أعضاء التعداد
AD_INTENTS
شكل الإعلان "روابط وعناصر إعلانية مرتكزة على نية المستخدم"
BOTTOM_ANCHOR
شكل الإعلان الثابت الذي تظهر فيه الخانة في أسفل إطار العرض
GAME_MANUAL_INTERSTITIAL
شكل "الإعلانات البينية اليدوية في الألعاب"

ملاحظة: "الإعلانات البينية اليدوية في الألعاب" هو شكل متاح بشكل محدود.
INTERSTITIAL
تنسيق تصميم الإعلان البيني على الموقع الإلكتروني
LEFT_SIDE_RAIL
شكل الإعلان على جانب الصفحة الأيسر
REWARDED
شكل "الإعلانات مقابل مكافأة"
RIGHT_SIDE_RAIL
تنسيق الإعلان على جانب الصفحة
TOP_ANCHOR
شكل ثابت يلتصق فيه موضع الإعلان بالجزء العلوي من إطار العرض

TagForAgeTreatment

TagForAgeTreatment
إعدادات المعالجة الموجّهة للفئة العمرية التي تتيحها علامة GPT
انظر أيضًا
أعضاء التعداد
CHILD
تشير هذه الحالة إلى أنّه يجب التعامل مع طلبات عرض الإعلانات على أنّها موجّهة إلى الأطفال.
TEEN
تشير هذه الحالة إلى أنّه يجب التعامل مع طلبات عرض الإعلانات على أنّها موجّهة إلى المراهقين.
UNSPECIFIED
القيمة التلقائية تشير هذه الحالة إلى أنّه لا تنطبق أي إشارة محدّدة للمعالجة المقيّدة للقاصرين على طلب عرض الإعلان.

TrafficSource

TrafficSource
مصادر الزيارات المتوافقة مع GPT
انظر أيضًا
أعضاء التعداد
ORGANIC
إدخال عنوان URL مباشرةً أو البحث في الموقع الإلكتروني أو تنزيل التطبيق
PURCHASED
الزيارات التي تتم إعادة توجيهها من مواقع أخرى غير المواقع التي يملكها الناشر (النشاط المكتسب أو النشاط الذي تم تحفيز المستخدم لإجرائه بطريقة أخرى)

googletag.events

هذه هي مساحة الاسم التي تستخدمها GPT للأحداث. يمكن أن يتفاعل الرمز البرمجي مع هذه الأحداث باستخدام Service.addEventListener.
واجهات
Event
الواجهة الأساسية لجميع أحداث GPT
EventTypeMap
هذا نوع زائف يربط اسم حدث بنوع عنصر الحدث المقابل له في Service.addEventListener وService.removeEventListener.
GameManualInterstitialSlotClosedEvent
يتم تنشيط هذا الحدث عندما يغلق المستخدم خانة إعلانية بينية يدوية في اللعبة.
GameManualInterstitialSlotReadyEvent
يتم تنشيط هذا الحدث عندما تكون خانة الإعلان البيني اليدوي في اللعبة جاهزة للعرض على المستخدم.
ImpressionViewableEvent
يتم بدء هذا الحدث عندما يصبح ظهور الإعلان قابلاً للعرض، وفقًا لمعايير "العرض النشط".
RewardedSlotClosedEvent
يتم تنشيط هذا الحدث عندما يغلق المستخدم خانة "إعلان مقابل مكافأة".
RewardedSlotGrantedEvent
يتم بدء هذا الحدث عند منح مكافأة مقابل مشاهدة إعلان مقابل مكافأة.
RewardedSlotReadyEvent
يتم بدء هذا الحدث عندما يكون الإعلان مقابل مكافأة جاهزًا للعرض.
RewardedSlotVideoCompletedEvent
يتم تنشيط هذا الحدث عند انتهاء تشغيل "إعلان فيديو مقابل مكافأة".
SlotOnloadEvent
يتم تنشيط هذا الحدث عندما ينشّط إطار iframe الخاص بتصميم الإعلان حدث التحميل.
SlotRenderEndedEvent
يتم تنشيط هذا الحدث عند إدخال رمز تصميم الإعلان في خانة إعلانية.
SlotRequestedEvent
يتم تنشيط هذا الحدث عند طلب إعلان لموضع إعلان معيّن.
SlotResponseReceived
يتم تنشيط هذا الحدث عند تلقّي استجابة إعلان لخانة معيّنة.
SlotVisibilityChangedEvent
يتم تنشيط هذا الحدث عندما تتغيّر النسبة المئوية لمساحة الخانة الإعلانية التي تظهر على الشاشة.

googletag.events.Event

الواجهة الأساسية لجميع أحداث GPT ستتضمّن جميع أحداث GPT أدناه الحقول التالية.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
انظر أيضًا

الخصائص

serviceName

serviceName: string
اسم الخدمة التي أدّت إلى بدء الحدث

slot

slot: Slot
الخانة التي أدّت إلى بدء الحدث

googletag.events.EventTypeMap

هذا نوع زائف يربط اسم حدث بنوع عنصر الحدث المقابل له في Service.addEventListener وService.removeEventListener. ويتم توثيقها لأغراض المرجعية ومنع أخطاء الكتابة فقط.
الخصائص
gameManualInterstitialSlotClosed
gameManualInterstitialSlotReady
impressionViewable
اسم مستعار لـ events.ImpressionViewableEvent.
rewardedSlotClosed
اسم بديل لـ events.RewardedSlotClosedEvent.
rewardedSlotGranted
اسم مستعار لـ events.RewardedSlotGrantedEvent.
rewardedSlotReady
اسم مستعار لـ events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted
اسم مستعار لـ events.RewardedSlotVideoCompletedEvent.
slotOnload
اسم مستعار لـ events.SlotOnloadEvent.
slotRenderEnded
اسم مستعار لـ events.SlotRenderEndedEvent.
slotRequested
اسم مستعار لـ events.SlotRequestedEvent.
slotResponseReceived
slotVisibilityChanged
اسم مستعار لـ events.SlotVisibilityChangedEvent.

الخصائص

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
اسم مستعار لـ events.GameManualInterstitialSlotClosedEvent.

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
اسم مستعار لـ events.GameManualInterstitialSlotReadyEvent.

impressionViewable

impressionViewable: ImpressionViewableEvent
اسم مستعار لـ events.ImpressionViewableEvent.

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent
اسم بديل لـ events.RewardedSlotClosedEvent.

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent
اسم مستعار لـ events.RewardedSlotGrantedEvent.

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent
اسم مستعار لـ events.RewardedSlotReadyEvent.

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent
اسم مستعار لـ events.RewardedSlotVideoCompletedEvent.

slotOnload

slotOnload: SlotOnloadEvent
اسم مستعار لـ events.SlotOnloadEvent.

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent
اسم مستعار لـ events.SlotRenderEndedEvent.

slotRequested

slotRequested: SlotRequestedEvent
اسم مستعار لـ events.SlotRequestedEvent.

slotResponseReceived

slotResponseReceived: SlotResponseReceived
Alias for events.SlotResponseReceived.

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent
اسم مستعار لـ events.SlotVisibilityChangedEvent.

googletag.events.GameManualInterstitialSlotClosedEvent

يضيف Event
يتم تنشيط هذا الحدث عندما يغلق المستخدم خانة "إعلان بيني يدوي في الألعاب".

ملاحظة: "الإعلان البيني اليدوي في الألعاب" هو شكل إعلان متاح بشكل محدود.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
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.
    }
  });
}

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
يتم تنشيط هذا الحدث عندما تكون خانة "الإعلان البيني اليدوي" في اللعبة جاهزة للعرض على المستخدم.

ملاحظة: "الإعلان البيني اليدوي" في اللعبة هو شكل إعلان محدود الوصول.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
الطُرق
makeGameManualInterstitialVisible
يعرض الإعلان البيني اليدوي للعبة للمستخدم.
مثال

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

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.
    }
  });
}
انظر أيضًا

الطُرق

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean
يعرض الإعلان البيني اليدوي للعبة للمستخدم. تعرض هذه الدالة ما إذا تم عرض الإعلان بنجاح.
المرتجعات
boolean

googletag.events.ImpressionViewableEvent

يضيف Event
يتم بدء هذا الحدث عندما يصبح ظهور الإعلان قابلاً للعرض، وفقًا لمعايير "العرض النشط".
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
مثال

JavaScript

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
انظر أيضًا

googletag.events.RewardedSlotClosedEvent

يضيف Event
يتم تنشيط هذا الحدث عندما يغلق المستخدم خانة "إعلان مقابل مكافأة". وقد يتم تنشيطه قبل منح المكافأة أو بعده. لتحديد ما إذا تم منح مكافأة، استخدِم events.RewardedSlotGrantedEvent بدلاً من ذلك.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
مثال

JavaScript

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

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
عنصر يحتوي على معلومات عن المكافأة التي تم منحها.
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
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.
    }
  });
}

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

عنصر يحتوي على معلومات عن المكافأة التي تم منحها.

googletag.events.RewardedSlotReadyEvent

يضيف Event
يتم بدء هذا الحدث عندما يكون الإعلان مقابل مكافأة جاهزًا للعرض. يتحمّل الناشر مسؤولية تقديم خيار للمستخدم لمشاهدة الإعلان قبل عرضه.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
الطُرق
makeRewardedVisible
يعرض الإعلان مقابل مكافأة.
مثال

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.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.
    }
  });
}

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.
    }
  });
}
انظر أيضًا

الطُرق

makeRewardedVisible

makeRewardedVisible(): boolean
يعرض الإعلان مقابل مكافأة. يجب عدم استدعاء هذه الطريقة إلا بعد موافقة المستخدم على مشاهدة الإعلان.
المرتجعات
booleanما إذا تم عرض "الإعلان مقابل مكافأة" بنجاح

googletag.events.RewardedSlotVideoCompletedEvent

يضيف Event
يتم تنشيط هذا الحدث عند انتهاء تشغيل "إعلان فيديو مقابل مكافأة".
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
مثال

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
انظر أيضًا

googletag.events.SlotOnloadEvent

يضيف Event
يتم تنشيط هذا الحدث عندما ينشّط إطار iframe الخاص بتصميم الإعلان حدث التحميل. عند عرض إعلانات الوسائط التفاعلية المتقدّمة في وضع العرض المتزامن، لا يتم استخدام أي إطار iframe، وبالتالي لن يتم تنشيط أي SlotOnloadEvent.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
مثال

JavaScript

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
انظر أيضًا

googletag.events.SlotRenderEndedEvent

يضيف Event
يتم تنشيط هذا الحدث عند إدخال رمز تصميم الإعلان في خانة إعلانية. سيحدث هذا الحدث قبل جلب موارد تصميم الإعلان، لذا قد لا يكون تصميم الإعلان مرئيًا بعد. إذا كنت بحاجة إلى معرفة وقت انتهاء تحميل جميع الموارد الإبداعية لمساحة إعلانية معيّنة، يمكنك استخدام events.SlotOnloadEvent بدلاً من ذلك.
الخصائص
advertiserId
الرقم التعريفي للمعلن الذي يعرض الإعلان
campaignId
رقم تعريف الحملة للإعلان المعروض
companyIds
معرّفات الشركات التي قدّمت عروض أسعار لإعلان إعادة التعبئة المعروض
creativeId
رقم تعريف تصميم الإعلان المحجوز الذي تم عرضه
creativeTemplateId
رقم تعريف نموذج تصميم الإعلان المحجوز المعروض
isBackfill
ما إذا كان الإعلان من نوع "الاحتياطي الإعلاني"
isEmpty
ما إذا تم عرض إعلان في الخانة
labelIds
متوقّف نهائيًا. 
lineItemId
معرّف السلعة للإعلان المحجوز الذي تم عرضه
responseIdentifier
معرّف الاستجابة هو معرّف فريد لاستجابة الإعلان.
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
size
تشير إلى حجم البكسل لتصميم الإعلان المعروض.
slot
الخانة التي أدّت إلى بدء الحدث
slotContentChanged
ما إذا تم تغيير محتوى الخانة باستخدام الإعلان المعروض
sourceAgnosticCreativeId
المعرّف الإبداعي للإعلان المحجوز أو الإعلان الاحتياطي المعروض.
sourceAgnosticLineItemId
معرّف السلعة للإعلان المحجوز أو إعلان إعادة التعبئة المعروضَين
yieldGroupIds
أرقام تعريف مجموعات الأرباح للإعلان الاحتياطي المعروض
مثال

JavaScript

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

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("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: number
الرقم التعريفي للمعلن الذي يعرض الإعلان تكون القيمة null للخانة الإعلانية الفارغة وإعلانات الملء الاحتياطي وتصاميم الإعلانات التي تعرضها خدمات أخرى غير PubAdsService.

campaignId

campaignId: number
رقم تعريف الحملة للإعلان المعروض تكون القيمة null للخانة الإعلانية الفارغة وإعلانات الملء الاحتياطي وتصاميم الإعلانات التي تعرضها خدمات أخرى غير PubAdsService.

companyIds

companyIds: number[]
معرّفات الشركات التي قدّمت عروض أسعار لإعلان إعادة التعبئة المعروض تكون القيمة null للخانَات الفارغة والإعلانات المحجوزة وتصاميم الإعلانات التي تعرضها خدمات أخرى غير PubAdsService.

creativeId

creativeId: number
رقم تعريف تصميم الإعلان المحجوز الذي تم عرضه تكون القيمة null للخانة الإعلانية الفارغة وإعلانات الملء الاحتياطي وتصاميم الإعلانات التي تعرضها خدمات أخرى غير PubAdsService.

creativeTemplateId

creativeTemplateId: number
رقم تعريف نموذج تصميم الإعلان المحجوز المعروض تكون القيمة null للخانة الإعلانية الفارغة وإعلانات الملء الاحتياطي وتصاميم الإعلانات التي تعرضها خدمات أخرى غير PubAdsService.

isBackfill

isBackfill: boolean
ما إذا كان الإعلان من نوع "الاحتياطي الإعلاني" تكون القيمة true إذا كان الإعلان من نوع "إعلان احتياطي"، وfalse في الحالات الأخرى.

isEmpty

isEmpty: boolean
ما إذا تم عرض إعلان في الخانة تكون القيمة true في حال عدم عرض أي إعلان، وfalse في الحالات الأخرى.

labelIds

labelIds: number[]

lineItemId

lineItemId: number
معرّف السلعة للإعلان المحجوز الذي تم عرضه تكون القيمة null للخانة الإعلانية الفارغة وإعلانات الملء الاحتياطي وتصاميم الإعلانات التي تعرضها خدمات أخرى غير PubAdsService.

responseIdentifier

responseIdentifier: string
معرّف الاستجابة هو معرّف فريد لاستجابة الإعلان. يمكن استخدام هذه القيمة لتحديد الإعلان وحظره في مركز مراجعة الإعلانات.

size

size: string | number[]
تشير إلى حجم البكسل لتصميم الإعلان المعروض. مثال: [728, 90] القيمة هي null للخانة الإعلانية الفارغة.

slotContentChanged

slotContentChanged: boolean
ما إذا تم تغيير محتوى الخانة باستخدام الإعلان المعروض تكون القيمة true إذا تم تغيير المحتوى، وfalse في الحالات الأخرى.

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number
المعرّف الإبداعي للإعلان المحجوز أو الإعلان الاحتياطي المعروض. تكون القيمة null إذا لم يكن الإعلان محجوزًا أو لم يكن مخصّصًا لملء المساحات الإعلانية المتاحة في البنود الإعلانية، أو إذا تم عرض تصميم الإعلان من خلال خدمات أخرى غير PubAdsService.

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number
معرّف السلعة للإعلان المحجوز أو إعلان إعادة التعبئة المعروضَين تكون القيمة null إذا لم يكن الإعلان محجوزًا أو لم يكن مخصّصًا لملء المساحات الإعلانية المتاحة في البنود الإعلانية، أو إذا تم عرض تصميم الإعلان من خلال خدمات أخرى غير PubAdsService.

yieldGroupIds

yieldGroupIds: number[]
أرقام تعريف مجموعات الأرباح للإعلان الاحتياطي المعروض تكون القيمة null للخانَات الفارغة والإعلانات المحجوزة وتصاميم الإعلانات التي تعرضها خدمات أخرى غير PubAdsService.

googletag.events.SlotRequestedEvent

يضيف Event
يتم تنشيط هذا الحدث عند طلب إعلان لموضع إعلان معيّن.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
مثال

JavaScript

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
انظر أيضًا

googletag.events.SlotResponseReceived

يضيف Event
يتم تنشيط هذا الحدث عند تلقّي استجابة إعلان لخانة معيّنة.
الخصائص
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
مثال

JavaScript

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
انظر أيضًا

googletag.events.SlotVisibilityChangedEvent

يضيف Event
يتم تنشيط هذا الحدث عندما تتغيّر النسبة المئوية لمساحة الخانة الإعلانية التي تظهر على الشاشة. يتم تقييد الحدث ولن يتم تنشيطه أكثر من مرة واحدة كل 200 ملي ثانية.
الخصائص
inViewPercentage
النسبة المئوية لمساحة الإعلان المرئية
serviceName
اسم الخدمة التي أدّت إلى بدء الحدث
slot
الخانة التي أدّت إلى بدء الحدث
مثال

JavaScript

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

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

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
انظر أيضًا

الخصائص

inViewPercentage

inViewPercentage: number
النسبة المئوية لمساحة الإعلان المرئية القيمة هي رقم بين 0 و100.

googletag.secureSignals

هذه هي مساحة الاسم التي تستخدمها علامة GPT لإدارة الإشارات الآمنة.
واجهات
BidderSignalProvider
تعرض هذه الدالة إشارة آمنة لمقدّم عرض سعر معيّن.
PublisherSignalProvider
تعرض هذه الدالة إشارة آمنة لناشر محدّد.
SecureSignalProvidersArray
واجهة لإدارة الإشارات الآمنة
الأسماء المستعارة للأنواع
SecureSignalProvider
واجهة لعرض إشارة آمنة لمقدّم عرض سعر أو مقدّم خدمة معيّن.

الأسماء المستعارة للأنواع

SecureSignalProvider

واجهة لعرض إشارة آمنة لمقدّم عرض سعر أو مقدّم خدمة معيّن. يجب تقديم إحدى السمتَين id أو networkCode، ولكن ليس كلتيهما.

googletag.secureSignals.BidderSignalProvider

تعرض هذه الدالة إشارة آمنة لمقدّم عرض سعر معيّن.

يتكوّن مزوّد الإشارات الآمنة لمقدّم عرض السعر من جزأين:

  1. دالة تجميعية تعرض Promise يتم تحليله إلى إشارة آمنة
  2. ‫id يحدّد مقدّم عرض السعر المرتبط بالإشارة.
لإرجاع إشارة آمنة لناشر، استخدِم secureSignals.PublisherSignalProvider بدلاً من ذلك.
الخصائص
collectorFunction
دالة تعرض Promise يتم تحليله إلى إشارة آمنة.
id
معرّف فريد لجامع البيانات المرتبط بهذه الإشارة الآمنة، كما هو مسجَّل في "إدارة إعلانات Google".
مثال

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
انظر أيضًا

الخصائص

collectorFunction

collectorFunction: (() => Promise<string>)
دالة تعرض Promise يتم تحليله إلى إشارة آمنة.

id

id: string
معرّف فريد لجامع البيانات المرتبط بهذه الإشارة الآمنة، كما هو مسجَّل في "إدارة إعلانات Google".

googletag.secureSignals.PublisherSignalProvider

تعرض هذه الدالة إشارة آمنة لناشر معيّن.

يتكوّن مزوّد إشارات الناشر من جزأين:

  1. دالة تجميعية تعرض Promise يتم تحليله إلى إشارة آمنة
  2. ‫networkCode يحدّد الناشر المرتبط بالإشارة
لإرجاع إشارة آمنة لمقدّم عرض سعر، استخدِم secureSignals.BidderSignalProvider بدلاً من ذلك.
الخصائص
collectorFunction
دالة تعرض Promise يتم تحليله إلى إشارة آمنة.
networkCode
رمز الشبكة (كما يظهر في مسار الوحدة الإعلانية) للناشر المرتبط بهذه الإشارة الآمنة.
مثال

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
انظر أيضًا

الخصائص

collectorFunction

collectorFunction: (() => Promise<string>)
دالة تعرض Promise يتم تحليله إلى إشارة آمنة.

networkCode

networkCode: string
رمز الشبكة (كما يظهر في مسار الوحدة الإعلانية) للناشر المرتبط بهذه الإشارة الآمنة.

googletag.secureSignals.SecureSignalProvidersArray

واجهة لإدارة الإشارات الآمنة
الطُرق
clearAllCache
يمحو جميع الإشارات لجميع أدوات التجميع من ذاكرة التخزين المؤقت.
push
تضيف هذه الطريقة secureSignals.SecureSignalProvider جديدًا إلى مصفوفة مزوّدي الإشارات وتبدأ عملية إنشاء الإشارات.

الطُرق

clearAllCache

clearAllCache(): void
يؤدي هذا الإجراء إلى محو جميع الإشارات لجميع أدوات جمع البيانات من ذاكرة التخزين المؤقت.

قد يؤدي استدعاء هذه الطريقة إلى تقليل احتمالية تضمين الإشارات في طلبات عرض الإعلانات لمشاهدات الصفحة الحالية وربما اللاحقة. لهذا السبب، يجب استدعاؤها فقط عند حدوث تغييرات مهمة في الحالة، مثل الأحداث التي تشير إلى مستخدم جديد (تسجيل الدخول، وتسجيل الخروج، والاشتراك، وما إلى ذلك).

push

push(provider: SecureSignalProvider): void
تضيف هذه الطريقة secureSignals.SecureSignalProvider جديدًا إلى مصفوفة مزوّدي الإشارات وتبدأ عملية إنشاء الإشارات.
المعلمات
provider: SecureSignalProviderعنصر secureSignals.SecureSignalProvider المطلوب إضافته إلى الصفيفة.