مرجع علامة "ناشر 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 هي مَعلمة باقية تقبل الدوال. تقبل معلَمات الاستراحة عددًا غير محدود من القيم من النوع المحدّد.


تعريفات الأنواع

الأنواع
SingleSize | MultiSize

ضبط حجم صالح للخانة، ويمكن أن يكون مقاسًا واحدًا أو أكثر

SingleSize[]

قائمة بالأحجام الصالحة الفردية.

"fluid" | ["fluid"]

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

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

SingleSizeArray | NamedSize

حجم واحد صالح للخانة

[number, number]

مصفوفة رقمين يمثلان [العرض، الارتفاع].

[SingleSizeArray, GeneralSize]

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

SizeMapping[]

قائمة بعمليات ربط الحجم

"unhideWindow" | "navBar"

عوامل تشغيل الإعلانات البينية المدعومة.

"disablePersonalization"

وسائل معالجة خصوصية الناشرين المتوافقة

"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

التصنيفات المتوافقة مع الإشارات المقدَّمة من الناشر (PPS)

BidderSignalProvider | PublisherSignalProvider

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

أنواع التعداد

عمليات التعداد
googletag.enums.OutOfPageFormat
تنسيقات الإعلانات خارج الصفحة المتوافقة مع جدول تقسيم المعرّف الفريد العمومي.
googletag.enums.TrafficSource
مصادر الزيارات المتوافقة مع GPT.


googletag.enums.OutOfPageFormat

  • تنسيقات الإعلانات خارج الصفحة المتوافقة مع جدول تقسيم المعرّف الفريد العمومي.

  • يمكن أيضًا مراجعة
  • القيم
    BOTTOM_ANCHOR
    تنسيق ثابت حيث تلتزِم الخانة بالجزء السفلي من إطار العرض.
    INTERSTITIAL
    تنسيق تصميم الإعلان البيني على الويب.
    LEFT_SIDE_RAIL
    تنسيق شريط جانبي أيسر.
    REWARDED
    شكل الإعلان بمكافأة.
    RIGHT_SIDE_RAIL
    تنسيق الشريط الجانبي الأيمن.
    TOP_ANCHOR
    تنسيق ثابت حيث تلتزم الخانة بالجزء العلوي من إطار العرض


googletag.enums.TrafficSource

  • مصادر الزيارات المتوافقة مع GPT.

  • يمكن أيضًا مراجعة
  • القيم
    ORGANIC
    إدخال عنوان URL مباشر أو بحث في الموقع أو تنزيل تطبيق
    PURCHASED
    الزيارات التي تمت إعادة توجيهها من مواقع أخرى غير المواقع المملوكة (الأنشطة المكتسبة أو المحفَّزة بطريقة أخرى)


googletag

مساحة الاسم العامة التي تستخدمها علامة "ناشر Google" لواجهة برمجة التطبيقات الخاصة بها

ملخّص المتغيّر
apiReady
علامة تشير إلى أنّه تم تحميل واجهة برمجة تطبيقات GPT وأنّها جاهزة للاتصال.
cmd
يمكنك الرجوع إلى قائمة انتظار الأوامر العامة لتنفيذ الطلبات ذات الصلة بعلامة GPT بشكل غير متزامن.
pubadsReady
علامة تشير إلى أنّ خدمة PubAdsService مفعّلة ومحمَّلة وقيد التشغيل بالكامل.
secureSignalProviders
إشارة إلى مصفوفة مزوّدي الإشارات الآمنة
ملخّص الدوال
companionAds
عرض مرجع إلى CompanionAdsService
defineOutOfPageSlot
تنشئ شريحة إعلانية خارج الصفحة باستخدام مسار الوحدة الإعلانية المحدد.
defineSlot
تُنشئ شريحة إعلانية بمسار وحجم وحدة إعلانية محدّدَين، وتربطها بمعرّف عنصر div على الصفحة التي ستحتوي على الإعلان.
destroySlots
يؤدي إلى إتلاف الخانات المحددة، وإزالة جميع الكائنات والمراجع ذات الصلة بهذه الخانات من GPT.
disablePublisherConsole
لإيقاف وحدة تحكم ناشري Google.
display
توجه خدمات الخانة لعرض الخانة.
enableServices
تُفعِّل جميع خدمات GPT التي تم تحديدها للخانات الإعلانية على الصفحة.
getVersion
تعرض الإصدار الحالي من GPT.
openConsole
تؤدي إلى فتح "وحدة تحكُّم ناشري Google".
pubads
عرض مرجع إلى PubAdsService
setAdIframeTitle
لضبط عنوان جميع إطارات iframe لحاوية الإعلانات التي أنشأها PubAdsService، من الآن فصاعدًا.
setConfig
لضبط خيارات الضبط العامة للصفحة.
sizeMapping
لإنشاء SizeMappingBuilder جديد


googletag.apiReady

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

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

  • مثال

    JavaScript

    if (window.googletag && googletag.apiReady) {
      // GPT API can be called safely.
    }
    

    JavaScript (قديم)

    if (window.googletag && googletag.apiReady) {
      // GPT API can be called safely.
    }
    

    TypeScript

    if (window.googletag && googletag.apiReady) {
      // GPT API can be called safely.
    }
    


googletag.cmd

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

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


googletag.pubadsReady

  • pubadsReady: boolean | undefined
  • علامة تشير إلى أنّ خدمة PubAdsService مفعّلة ومحمَّلة وقيد التشغيل بالكامل. ستظل هذه السمة undefined ببساطة إلى أن يتم استدعاء enableServices وتحميل PubAdsService وإعدادها.


googletag.secureSignalProviders

  • secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
  • الرجوع إلى مصفوفة مزوّدي الإشارات الآمنة.

    تقبل مصفوفة مزوّدي الإشارات الآمنة سلسلة من وظائف إنشاء الإشارات وتستدعيها بالترتيب. والغرض منه هو استبدال صفيف عادي يُستخدَم لإدراج دوال إنشاء الإشارات في قائمة انتظار والتي سيتم استدعاؤها بعد تحميل علامة "GPT".

  • مثال

    JavaScript

    window.googletag = window.googletag || { cmd: [] };
    googletag.secureSignalProviders = googletag.secureSignalProviders || [];
    googletag.secureSignalProviders.push({
      id: "collector123",
      collectorFunction: () => {
        return Promise.resolve("signal");
      },
    });
    

    JavaScript (قديم)

    window.googletag = window.googletag || { cmd: [] };
    googletag.secureSignalProviders = googletag.secureSignalProviders || [];
    googletag.secureSignalProviders.push({
      id: "collector123",
      collectorFunction: function () {
        return Promise.resolve("signal");
      },
    });
    

    TypeScript

    window.googletag = window.googletag || { cmd: [] };
    googletag.secureSignalProviders = googletag.secureSignalProviders || [];
    googletag.secureSignalProviders.push({
      id: "collector123",
      collectorFunction: () => {
        return Promise.resolve("signal");
      },
    });
    
    يمكن أيضًا مراجعة


googletag.companionAds


googletag.defineOutOfPageSlot

  • defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
  • تنشئ شريحة إعلانية خارج الصفحة مع مسار الوحدة الإعلانية المحدّد.

    بالنسبة إلى الإعلانات المخصّصة خارج الصفحة، يُعد div معرّف عنصر div الذي سيتضمن الإعلان. راجِع المقالة حول تصميمات الإعلانات خارج الصفحة للحصول على مزيد من التفاصيل.

    بالنسبة إلى الإعلانات خارج الصفحة المُدارة في GPT، إنّ div عبارة عن OutOfPageFormat متاحة.

  • مثال

    JavaScript

    // Define a custom out-of-page ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", "div-1");
    
    // Define a GPT managed web interstitial ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    

    JavaScript (قديم)

    // Define a custom out-of-page ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", "div-1");
    
    // Define a GPT managed web interstitial ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    

    TypeScript

    // Define a custom out-of-page ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", "div-1");
    
    // Define a GPT managed web interstitial ad slot.
    googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    
    يمكن أيضًا مراجعة
  • المعلمات
    adUnitPath: string
    مسار الوحدة الإعلانية الكامل مع رمز الشبكة ورمز الوحدة الإعلانية.
    div?: string | OutOfPageFormat
    رقم تعريف عنصر div الذي سيحتوي على هذه الوحدة الإعلانية أو OutOfPageFormat.
  • المرتجعات
    Slot | null
    الخانة التي تم إنشاؤها حديثًا أو null إذا تعذّر إنشاء خانة.


googletag.defineSlot

  • defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
  • تُنشئ شريحة إعلانية بمسار وحجم وحدة إعلانية محدّدَين، وتربطها بمعرّف عنصر div على الصفحة التي ستحتوي على الإعلان.

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


googletag.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();
    

    JavaScript (قديم)

    // The calls to construct an ad and display contents.
    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to destroy only slot1.
    googletag.destroySlots([slot1]);
    
    // This call to destroy both slot1 and slot2.
    googletag.destroySlots([slot1, slot2]);
    
    // This call to destroy all slots.
    googletag.destroySlots();
    

    TypeScript

    // The calls to construct an ad and display contents.
    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
    googletag.display("div-2");
    
    // This call to destroy only slot1.
    googletag.destroySlots([slot1]);
    
    // This call to destroy both slot1 and slot2.
    googletag.destroySlots([slot1, slot2]);
    
    // This call to destroy all slots.
    googletag.destroySlots();
    
  • المعلمات
    slots?: Slot[]
    مجموعة الخانات المطلوب تدميرها. المصفوفة اختيارية، وسيتم التخلص من جميع الفتحات إذا لم يتم تحديدها.
  • المرتجعات
    boolean
    true إذا تم إتلاف الخانات، وfalse في الحالات الأخرى.


googletag.disablePublisherConsole


googletag.display

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

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

  • مثال

    JavaScript

    googletag.cmd.push(() => {
      googletag.display("div-1");
    });
    

    JavaScript (قديم)

    googletag.cmd.push(function () {
      googletag.display("div-1");
    });
    

    TypeScript

    googletag.cmd.push(() => {
      googletag.display("div-1");
    });
    
    يمكن أيضًا مراجعة
  • المعلمات
    divOrSlot: string | Element | Slot
    رقم تعريف عنصر div الذي يحتوي على الشريحة الإعلانية أو عنصر div أو عنصر الشريحة الإعلانية إذا تم توفير عنصر div، يجب أن يحتوي على السمة 'id' التي تطابق المعرّف الذي تم تمريره إلى defineSlot.


googletag.enableServices

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


googletag.getVersion


googletag.openConsole

  • openConsole(div?: string): void
  • تؤدي إلى فتح "وحدة تحكُّم ناشري Google".

  • مثال

    JavaScript

    // Calling with div ID.
    googletag.openConsole("div-1");
    
    // Calling without div ID.
    googletag.openConsole();
    

    JavaScript (قديم)

    // Calling with div ID.
    googletag.openConsole("div-1");
    
    // Calling without div ID.
    googletag.openConsole();
    

    TypeScript

    // Calling with div ID.
    googletag.openConsole("div-1");
    
    // Calling without div ID.
    googletag.openConsole();
    
    يمكن أيضًا مراجعة
  • المعلمات
    div?: string
    رقم تعريف قسم الشريحة الإعلانية هذه القيمة اختيارية. عند توفير "وحدة تحكم الناشر"، ستحاول فتح "وحدة تحكُّم الناشر" بتفاصيل عن الشريحة الإعلانية المحدّدة في العرض.


googletag.pubads


googletag.setAdIframeTitle

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

  • مثال

    JavaScript

    googletag.setAdIframeTitle("title");
    

    JavaScript (قديم)

    googletag.setAdIframeTitle("title");
    

    TypeScript

    googletag.setAdIframeTitle("title");
    
  • المعلمات
    title: string
    العنوان الجديد لجميع إطارات iframe في حاوية الإعلان.


googletag.setConfig


googletag.sizeMapping


googletag.CommandArray

تقبل صفيفة الأوامر تسلسل دوال وتستدعيها بالترتيب. والغرض منه هو استبدال صفيف عادي يُستخدَم لإدراج الدوال التي سيتم استدعاؤها بعد تحميل GPT.

ملخّص الطريقة
push
لتنفيذ تسلسل الدوال المحددة في الوسيطات بالترتيب.


push

  • push(...f: Array<(this: typeof globalThis) => void>): number
  • لتنفيذ تسلسل الدوال المحددة في الوسيطات بالترتيب.

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


googletag.CompanionAdsService

توسيع Service

خدمة الإعلانات المصاحبة. يتم استخدام هذه الخدمة بواسطة إعلانات الفيديو لعرض الإعلانات المصاحبة.

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


setRefreshUnfilledSlots

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

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

  • مثال

    JavaScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
    

    JavaScript (قديم)

    googletag.companionAds().setRefreshUnfilledSlots(true);
    

    TypeScript

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


googletag.PrivacySettingsConfig

عنصر ضبط لإعدادات الخصوصية

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


childDirectedTreatment


limitedAds

  • limitedAds: boolean
  • لتفعيل عرض الإعلانات في وضع الإعلانات المحدودة للمساعدة في تلبية متطلبات الامتثال التنظيمية للناشرين.

    يمكنك توجيه علامة GPT لطلب إعلانات محدودة بطريقتَين:

    لا يمكن ضبط الإعلانات المحدودة يدويًا إلا عند تحميل علامة "GPT" من عنوان URL للإعلانات المحدودة. ستؤدي محاولة تعديل هذا الإعداد عند تحميل علامة "علامة ناشر Google" من عنوان 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,
    });
    

    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,
    });
    
    يمكن أيضًا مراجعة


nonPersonalizedAds

  • nonPersonalizedAds: boolean
  • تُفعِّل عرض الإعلانات في وضع الإعلانات غير المخصّصة للمساعدة في تلبية متطلبات الامتثال التنظيمية للناشرين.


restrictDataProcessing

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


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

    JavaScript (قديم)

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

    TypeScript

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


underAgeOfConsent

  • underAgeOfConsent: null | boolean
  • يشير إلى ما إذا كان سيتم وضع علامة على طلبات الإعلان على أنّها واردة من المستخدمين تحت سن الرشد. اضبط القيمة على null لمحو الإعدادات.


googletag.PubAdsService

توسيع Service

خدمة إعلانات الناشرين: تُستخدم هذه الخدمة لجلب الإعلانات وعرضها من حسابك على "مدير إعلانات Google".

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


clear

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

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

  • مثال

    JavaScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to clear only slot1.
    googletag.pubads().clear([slot1]);
    
    // This call to clear both slot1 and slot2.
    googletag.pubads().clear([slot1, slot2]);
    
    // This call to clear all slots.
    googletag.pubads().clear();
    

    JavaScript (قديم)

    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to clear only slot1.
    googletag.pubads().clear([slot1]);
    
    // This call to clear both slot1 and slot2.
    googletag.pubads().clear([slot1, slot2]);
    
    // This call to clear all slots.
    googletag.pubads().clear();
    

    TypeScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
    googletag.display("div-2");
    
    // This call to clear only slot1.
    googletag.pubads().clear([slot1]);
    
    // This call to clear both slot1 and slot2.
    googletag.pubads().clear([slot1, slot2]);
    
    // This call to clear all slots.
    googletag.pubads().clear();
    
  • المعلمات
    slots?: Slot[]
    مصفوفة الخانات المطلوب محوها المصفوفة اختيارية، وسيتم محو جميع الخانات إذا لم يتم تحديدها.
  • المرتجعات
    boolean
    تعرض true في حال تم محو الخانات، أو false في الحالات الأخرى.


clearCategoryExclusions

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

  • مثال

    JavaScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    // Make ad requests. No ad with 'AirlineAd' label will be returned.
    
    // Clear category exclusions so all ads can be returned.
    googletag.pubads().clearCategoryExclusions();
    
    // Make ad requests. Any ad can be returned.
    

    JavaScript (قديم)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    // Make ad requests. No ad with 'AirlineAd' label will be returned.
    
    // Clear category exclusions so all ads can be returned.
    googletag.pubads().clearCategoryExclusions();
    
    // Make ad requests. Any ad can be returned.
    

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    // Make ad requests. No ad with 'AirlineAd' label will be returned.
    
    // Clear category exclusions so all ads can be returned.
    googletag.pubads().clearCategoryExclusions();
    
    // Make ad requests. Any ad can be returned.
    
    يمكن أيضًا مراجعة
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الطريقة منه.


clearTargeting

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

  • مثال

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    googletag.pubads().setTargeting("fruits", "apple");
    
    googletag.pubads().clearTargeting("interests");
    // Targeting 'colors' and 'fruits' are still present, while 'interests'
    // was cleared.
    
    googletag.pubads().clearTargeting();
    // All targeting has been cleared.
    

    JavaScript (قديم)

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    googletag.pubads().setTargeting("fruits", "apple");
    
    googletag.pubads().clearTargeting("interests");
    // Targeting 'colors' and 'fruits' are still present, while 'interests'
    // was cleared.
    
    googletag.pubads().clearTargeting();
    // All targeting has been cleared.
    

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    googletag.pubads().setTargeting("fruits", "apple");
    
    googletag.pubads().clearTargeting("interests");
    // Targeting 'colors' and 'fruits' are still present, while 'interests'
    // was cleared.
    
    googletag.pubads().clearTargeting();
    // All targeting has been cleared.
    
    يمكن أيضًا مراجعة
  • المعلمات
    key?: string
    مفتاح معلمة الاستهداف. المفتاح اختياري، وسيتم محو جميع مَعلمات الاستهداف إذا لم يتم تحديده.
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الطريقة منه.


collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
  • لتفعيل تصغير عناصر divs بحيث لا تشغل أي مساحة على الصفحة عند عدم وجود محتوى إعلان لعرضه. يجب ضبط هذا الوضع قبل تفعيل الخدمة.

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


disableInitialLoad


display

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

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


enableLazyLoad

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

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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

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

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

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


enableSingleRequest


enableVideoAds

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


get

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

  • مثال

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    JavaScript (قديم)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().get("adsense_background_color");
    // Returns '#FFFFFF'.
    
    يمكن أيضًا مراجعة
  • المعلمات
    key: string
    اسم السمة التي يجب البحث عنها
  • المرتجعات
    null | string
    القيمة الحالية لمفتاح السمة، أو null إذا كان المفتاح غير موجود.


getAttributeKeys

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

  • مثال

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().set("adsense_border_color", "#AABBCC");
    googletag.pubads().getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    JavaScript (قديم)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().set("adsense_border_color", "#AABBCC");
    googletag.pubads().getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    googletag.pubads().set("adsense_border_color", "#AABBCC");
    googletag.pubads().getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    
  • المرتجعات
    string[]
    مجموعة مفاتيح السمات التي تم ضبطها في هذه الخدمة الترتيب غير محدد.


getTargeting

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

  • مثال

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
    
    googletag.pubads().getTargeting("interests");
    // Returns ['sports'].
    
    googletag.pubads().getTargeting("age");
    // Returns [] (empty array).
    

    JavaScript (قديم)

    googletag.pubads().setTargeting("interests", "sports");
    
    googletag.pubads().getTargeting("interests");
    // Returns ['sports'].
    
    googletag.pubads().getTargeting("age");
    // Returns [] (empty array).
    

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
    
    googletag.pubads().getTargeting("interests");
    // Returns ['sports'].
    
    googletag.pubads().getTargeting("age");
    // Returns [] (empty array).
    
  • المعلمات
    key: string
    مفتاح الاستهداف المطلوب البحث عنه.
  • المرتجعات
    string[]
    يشير ذلك المصطلح إلى القيم المرتبطة بهذا المفتاح أو مصفوفة فارغة في حال عدم توفُّر هذا المفتاح.


getTargetingKeys

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

  • مثال

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    
    googletag.pubads().getTargetingKeys();
    // Returns ['interests', 'colors'].
    

    JavaScript (قديم)

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    
    googletag.pubads().getTargetingKeys();
    // Returns ['interests', 'colors'].
    

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
    googletag.pubads().setTargeting("colors", "blue");
    
    googletag.pubads().getTargetingKeys();
    // Returns ['interests', 'colors'].
    
  • المرتجعات
    string[]
    مصفوفة مفاتيح الاستهداف الترتيب غير محدد.


isInitialLoadDisabled

  • isInitialLoadDisabled(): boolean
  • تعرض ما إذا كان قد تم إيقاف الطلبات الأولية للإعلانات بنجاح من خلال استدعاء PubAdsService.disableInitialLoad سابق أم لا.

  • المرتجعات
    boolean
    تعرض true إذا تم الاتصال السابق بـ PubAdsService.disableInitialLoad بنجاح، أو false في الحالات الأخرى.


refresh

  • refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void
  • يسترجع إعلانات جديدة ويعرضها في خانات محددة أو لجميع الشرائح على الصفحة. لا تعمل هذه الميزة إلا في وضع العرض غير المتزامن.

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

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

  • مثال

    JavaScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to refresh fetches a new ad for slot1 only.
    googletag.pubads().refresh([slot1]);
    
    // This call to refresh fetches a new ad for both slot1 and slot2.
    googletag.pubads().refresh([slot1, slot2]);
    
    // This call to refresh fetches a new ad for each slot.
    googletag.pubads().refresh();
    
    // This call to refresh fetches a new ad for slot1, without changing
    // the correlator.
    googletag.pubads().refresh([slot1], { changeCorrelator: false });
    
    // This call to refresh fetches a new ad for each slot, without
    // changing the correlator.
    googletag.pubads().refresh(null, { changeCorrelator: false });
    

    JavaScript (قديم)

    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    googletag.display("div-1");
    var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
    googletag.display("div-2");
    
    // This call to refresh fetches a new ad for slot1 only.
    googletag.pubads().refresh([slot1]);
    
    // This call to refresh fetches a new ad for both slot1 and slot2.
    googletag.pubads().refresh([slot1, slot2]);
    
    // This call to refresh fetches a new ad for each slot.
    googletag.pubads().refresh();
    
    // This call to refresh fetches a new ad for slot1, without changing
    // the correlator.
    googletag.pubads().refresh([slot1], { changeCorrelator: false });
    
    // This call to refresh fetches a new ad for each slot, without
    // changing the correlator.
    googletag.pubads().refresh(null, { changeCorrelator: false });
    

    TypeScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
    googletag.display("div-1");
    const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
    googletag.display("div-2");
    
    // This call to refresh fetches a new ad for slot1 only.
    googletag.pubads().refresh([slot1]);
    
    // This call to refresh fetches a new ad for both slot1 and slot2.
    googletag.pubads().refresh([slot1, slot2]);
    
    // This call to refresh fetches a new ad for each slot.
    googletag.pubads().refresh();
    
    // This call to refresh fetches a new ad for slot1, without changing
    // the correlator.
    googletag.pubads().refresh([slot1], { changeCorrelator: false });
    
    // This call to refresh fetches a new ad for each slot, without
    // changing the correlator.
    googletag.pubads().refresh(null, { changeCorrelator: false });
    
    يمكن أيضًا مراجعة
  • المعلمات
    slots?: null | Slot[]
    الخانات التي ستتم إعادة تحميلها المصفوفة اختيارية، وستتم إعادة تحميل جميع الخانات إذا لم يتم تحديدها.
    options?: { changeCorrelator: boolean }
    خيارات الإعداد المرتبطة بطلب إعادة التحميل هذا
    • changeCorrelator

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

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


set

  • set(key: string, value: string): PubAdsService
  • تضبط قيمًا لسمات AdSense التي تنطبق على جميع الخانات الإعلانية ضمن خدمة "إعلانات الناشر".

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

  • مثال

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    

    JavaScript (قديم)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    
    يمكن أيضًا مراجعة
  • المعلمات
    key: string
    اسم السمة.
    value: string
    قيمة السمة.
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الطريقة منه.


setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): PubAdsService
  • إعداد استبعاد فئة إعلان على مستوى الصفحة لاسم التصنيف المحدّد.

  • مثال

    JavaScript

    // Label = AirlineAd.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    

    JavaScript (قديم)

    // Label = AirlineAd.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    

    TypeScript

    // Label = AirlineAd.
    googletag.pubads().setCategoryExclusion("AirlineAd");
    
    يمكن أيضًا مراجعة
  • المعلمات
    categoryExclusion: string
    تصنيف استبعاد فئة الإعلان المطلوب إضافته.
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الطريقة منه.


setCentering

  • setCentering(centerAds: boolean): void
  • تفعيل ميزة التوسيط الأفقي للإعلانات وإيقافها. يتم إيقاف ميزة التوسيط تلقائيًا. في gpt_mobile.js القديم، يتم تفعيل التوسيط تلقائيًا.

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

  • مثال

    JavaScript

    // Make ads centered.
    googletag.pubads().setCentering(true);
    

    JavaScript (قديم)

    // Make ads centered.
    googletag.pubads().setCentering(true);
    

    TypeScript

    // Make ads centered.
    googletag.pubads().setCentering(true);
    
  • المعلمات
    centerAds: boolean
    true لتوسيط الإعلانات، false لمحاذاتها لليسار.


setForceSafeFrame

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

    يُرجى وضع الأمور التالية في الاعتبار أثناء استخدام واجهة برمجة التطبيقات هذه:

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

  • مثال

    JavaScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will be opted-out of the page-level force
    // SafeFrame instruction.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setForceSafeFrame(false)
      .addService(googletag.pubads());
    
    // The following slot will have SafeFrame forced.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    JavaScript (قديم)

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will be opted-out of the page-level force
    // SafeFrame instruction.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setForceSafeFrame(false)
      .addService(googletag.pubads());
    
    // The following slot will have SafeFrame forced.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    TypeScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will be opted-out of the page-level force
    // SafeFrame instruction.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setForceSafeFrame(false)
      .addService(googletag.pubads());
    
    // The following slot will have SafeFrame forced.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    
    يمكن أيضًا مراجعة
  • المعلمات
    forceSafeFrame: boolean
    true لفرض عرض جميع الإعلانات على الصفحة في "الإطارات الآمنة" وfalse لتغيير الإعداد السابق إلى "خطأ". وفي حال لم يتم تحديده في وقت سابق، لن يؤدي ضبط هذه السياسة على false إلى إجراء أي تغيير.
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الدالة عليه.


setLocation

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

  • مثال

    JavaScript

    // Postal code:
    googletag.pubads().setLocation("10001,US");
    

    JavaScript (قديم)

    // Postal code:
    googletag.pubads().setLocation("10001,US");
    

    TypeScript

    // Postal code:
    googletag.pubads().setLocation("10001,US");
    
  • المعلمات
    address: string
    عنوان حر الشكل.
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الطريقة منه.


setPrivacySettings

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

  • مثال

    JavaScript

    googletag.pubads().setPrivacySettings({
      restrictDataProcessing: true,
    });
    
    // Set multiple privacy settings at the same time.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: true,
      underAgeOfConsent: true,
    });
    
    // Clear the configuration for childDirectedTreatment.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: null,
    });
    

    JavaScript (قديم)

    googletag.pubads().setPrivacySettings({
      restrictDataProcessing: true,
    });
    
    // Set multiple privacy settings at the same time.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: true,
      underAgeOfConsent: true,
    });
    
    // Clear the configuration for childDirectedTreatment.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: null,
    });
    

    TypeScript

    googletag.pubads().setPrivacySettings({
      restrictDataProcessing: true,
    });
    
    // Set multiple privacy settings at the same time.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: true,
      underAgeOfConsent: true,
    });
    
    // Clear the configuration for childDirectedTreatment.
    googletag.pubads().setPrivacySettings({
      childDirectedTreatment: null,
    });
    
    يمكن أيضًا مراجعة
  • المعلمات
    privacySettings: PrivacySettingsConfig
    عنصر يحتوي على إعدادات الخصوصية
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الدالة عليه.


setPublisherProvidedId

  • setPublisherProvidedId(ppid: string): PubAdsService
  • تضبط قيمة المعرّف الذي يقدّمه الناشر.

  • مثال

    JavaScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    

    JavaScript (قديم)

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    

    TypeScript

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


setSafeFrameConfig

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

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

  • مثال

    JavaScript

    googletag.pubads().setForceSafeFrame(true);
    
    const pageConfig = {
      allowOverlayExpansion: true,
      allowPushExpansion: true,
      sandbox: true,
    };
    
    const slotConfig = { allowOverlayExpansion: false };
    
    googletag.pubads().setSafeFrameConfig(pageConfig);
    
    // The following slot will not allow for expansion by overlay.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig(slotConfig)
      .addService(googletag.pubads());
    
    // The following slot will inherit the page level settings, and hence
    // would allow for expansion by overlay.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    JavaScript (قديم)

    googletag.pubads().setForceSafeFrame(true);
    
    var pageConfig = {
      allowOverlayExpansion: true,
      allowPushExpansion: true,
      sandbox: true,
    };
    
    var slotConfig = { allowOverlayExpansion: false };
    
    googletag.pubads().setSafeFrameConfig(pageConfig);
    
    // The following slot will not allow for expansion by overlay.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig(slotConfig)
      .addService(googletag.pubads());
    
    // The following slot will inherit the page level settings, and hence
    // would allow for expansion by overlay.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    TypeScript

    googletag.pubads().setForceSafeFrame(true);
    
    const pageConfig = {
      allowOverlayExpansion: true,
      allowPushExpansion: true,
      sandbox: true,
    };
    
    const slotConfig = { allowOverlayExpansion: false };
    
    googletag.pubads().setSafeFrameConfig(pageConfig);
    
    // The following slot will not allow for expansion by overlay.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setSafeFrameConfig(slotConfig)
      .addService(googletag.pubads());
    
    // The following slot will inherit the page level settings, and hence
    // would allow for expansion by overlay.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    
    يمكن أيضًا مراجعة
  • المعلمات
    config: SafeFrameConfig
    كائن الضبط.
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الطريقة منه.


setTargeting

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

  • مثال

    JavaScript

    // Example with a single value for a key.
    googletag.pubads().setTargeting("interests", "sports");
    
    // Example with multiple values for a key inside in an array.
    googletag.pubads().setTargeting("interests", ["sports", "music"]);
    

    JavaScript (قديم)

    // Example with a single value for a key.
    googletag.pubads().setTargeting("interests", "sports");
    
    // Example with multiple values for a key inside in an array.
    googletag.pubads().setTargeting("interests", ["sports", "music"]);
    

    TypeScript

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


setVideoContent

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

  • يمكن أيضًا مراجعة
  • المعلمات
    videoContentId: string
    معرّف Content ID للفيديو
    videoCmsId: string
    رقم تعريف نظام إدارة المحتوى الخاص بالفيديو


updateCorrelator

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

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

  • مثال

    JavaScript

    // Assume that the correlator is currently 12345. All ad requests made
    // by this page will currently use that value.
    
    // Replace the current correlator with a new correlator.
    googletag.pubads().updateCorrelator();
    
    // The correlator will now be a new randomly selected value, different
    // from 12345. All subsequent ad requests made by this page will use
    // the new value.
    

    JavaScript (قديم)

    // Assume that the correlator is currently 12345. All ad requests made
    // by this page will currently use that value.
    
    // Replace the current correlator with a new correlator.
    googletag.pubads().updateCorrelator();
    
    // The correlator will now be a new randomly selected value, different
    // from 12345. All subsequent ad requests made by this page will use
    // the new value.
    

    TypeScript

    // Assume that the correlator is currently 12345. All ad requests made
    // by this page will currently use that value.
    
    // Replace the current correlator with a new correlator.
    googletag.pubads().updateCorrelator();
    
    // The correlator will now be a new randomly selected value, different
    // from 12345. All subsequent ad requests made by this page will use
    // the new value.
    
  • المرتجعات
    PubAdsService
    كائن الخدمة الذي تم استدعاء الدالة عليه.


googletag.ResponseInformation

عنصر يمثّل استجابة إعلان واحدة.

ملخّص الملكية
advertiserId
رقم تعريف المعلن.
campaignId
رقم تعريف الحملة.
creativeId
رقم تعريف تصميم الإعلان.
creativeTemplateId
رقم تعريف نموذج الإعلان.
lineItemId
رقم تعريف العنصر.
يمكن أيضًا مراجعة


advertiserId

  • advertiserId: null | number
  • رقم تعريف المعلن.


campaignId

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


creativeId

  • creativeId: null | number
  • رقم تعريف تصميم الإعلان.


creativeTemplateId

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


lineItemId

  • lineItemId: null | number
  • رقم تعريف العنصر.


googletag.RewardedPayload

عنصر يمثّل المكافأة المرتبطة بإعلان بمكافأة

ملخّص الملكية
amount
تمثّل هذه السمة عدد السلع التي تم تضمينها في المكافأة.
type
نوع السلعة المضمّنة في المكافأة (على سبيل المثال، "العملة المعدنية").
يمكن أيضًا مراجعة


amount

  • amount: number
  • تمثّل هذه السمة عدد السلع التي تم تضمينها في المكافأة.


type

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


googletag.SafeFrameConfig

كائن ضبط لحاويات SafeFrame

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


allowOverlayExpansion

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


allowPushExpansion

  • allowPushExpansion: boolean
  • ما إذا كان يجب أن يسمح SafeFrame بتوسيع محتوى الإعلان عن طريق الدفع بمحتوى الصفحة.


sandbox

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


useUniqueDomain

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

    ملاحظة: تكون هذه الميزة مفعَّلة بشكل تلقائي.

  • يمكن أيضًا مراجعة


googletag.Service

فئة الخدمة الأساسية التي تحتوي على طرق شائعة لجميع الخدمات.

ملخّص الطريقة
addEventListener
يتم تسجيل أداة استماع تسمح لك بإعداد وظيفة 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.
      }
    });
    

    JavaScript (قديم)

    // 1. Adding an event listener for the PubAdsService.
    googletag.pubads().addEventListener("slotOnload", function (event) {
      console.log("Slot has been loaded:");
      console.log(event);
    });
    
    // 2. Adding an event listener with slot specific logic.
    // Listeners operate at service level, which means that you cannot add
    // a listener for an event for a specific slot only. You can, however,
    // programmatically filter a listener to respond only to a certain ad
    // slot, using this pattern:
    var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    googletag.pubads().addEventListener("slotOnload", function (event) {
      if (event.slot === targetSlot) {
        // Slot specific logic.
      }
    });
    

    TypeScript

    // 1. Adding an event listener for the PubAdsService.
    googletag.pubads().addEventListener("slotOnload", (event) => {
      console.log("Slot has been loaded:");
      console.log(event);
    });
    
    // 2. Adding an event listener with slot specific logic.
    // Listeners operate at service level, which means that you cannot add
    // a listener for an event for a specific slot only. You can, however,
    // programmatically filter a listener to respond only to a certain ad
    // slot, using this pattern:
    const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    googletag.pubads().addEventListener("slotOnload", (event) => {
      if (event.slot === targetSlot) {
        // Slot specific logic.
      }
    });
    
    يمكن أيضًا مراجعة
  • المعلمات
    eventType: K
    سلسلة تمثّل نوع الحدث الذي تم إنشاؤه بواسطة GPT. إنّ أنواع الأحداث حسّاسة لحالة الأحرف.
    listener: (arg: EventTypeMap[K]) => void
    دالة تأخذ وسيطة كائن حدث واحدة.
  • المرتجعات
    Service
    كائن الخدمة الذي تم استدعاء الطريقة منه.


getSlots

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

    JavaScript (قديم)

    googletag.cmd.push(function () {
      // Define a new ad slot.
      googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());
    
      // Define a new function that removes itself via removeEventListener
      // after the impressionViewable event fires.
      var onViewableListener = function (event) {
        googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
        setTimeout(function () {
          googletag.pubads().refresh([event.slot]);
        }, 30000);
      };
    
      // Add onViewableListener as a listener for impressionViewable events.
      googletag.pubads().addEventListener("impressionViewable", onViewableListener);
      googletag.enableServices();
    });
    

    TypeScript

    googletag.cmd.push(() => {
      // Define a new ad slot.
      googletag
        .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
        .addService(googletag.pubads());
    
      // Define a new function that removes itself via removeEventListener
      // after the impressionViewable event fires.
      const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
        googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
        setTimeout(() => {
          googletag.pubads().refresh([event.slot]);
        }, 30000);
      };
    
      // Add onViewableListener as a listener for impressionViewable events.
      googletag.pubads().addEventListener("impressionViewable", onViewableListener);
      googletag.enableServices();
    });
    
  • المعلمات
    eventType: K
    سلسلة تمثّل نوع الحدث الذي تم إنشاؤه بواسطة GPT. إنّ أنواع الأحداث حسّاسة لحالة الأحرف.
    listener: (event: EventTypeMap[K]) => void
    دالة تأخذ وسيطة كائن حدث واحدة.


googletag.SizeMappingBuilder

أداة إنشاء عناصر مواصفات ربط المقاسات يتم توفير هذه المنصة للمساعدة في إنشاء مواصفات الحجم بسهولة.

ملخّص الطريقة
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 < 640x480
      .build();
    
    // Mapping 2
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [])
      .addSize([640, 480], [120, 60])
      .addSize([0, 0], [])
      .build();
    
    // Mapping 2 will not show any ads for the following viewport sizes:
    // [1024, 768] > size >= [980, 690] and
    // [640, 480] > size >= [0, 0]
    

    JavaScript (قديم)

    // Mapping 1
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [728, 90])
      .addSize([640, 480], "fluid")
      .addSize([0, 0], [88, 31]) // All viewports < 640x480
      .build();
    
    // Mapping 2
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [])
      .addSize([640, 480], [120, 60])
      .addSize([0, 0], [])
      .build();
    
    // Mapping 2 will not show any ads for the following viewport sizes:
    // [1024, 768] > size >= [980, 690] and
    // [640, 480] > size >= [0, 0]
    

    TypeScript

    // Mapping 1
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [728, 90])
      .addSize([640, 480], "fluid")
      .addSize([0, 0], [88, 31]) // All viewports < 640x480
      .build();
    
    // Mapping 2
    googletag
      .sizeMapping()
      .addSize([1024, 768], [970, 250])
      .addSize([980, 690], [])
      .addSize([640, 480], [120, 60])
      .addSize([0, 0], [])
      .build();
    
    // Mapping 2 will not show any ads for the following viewport sizes:
    // [1024, 768] > size >= [980, 690] and
    // [640, 480] > size >= [0, 0]
    
  • المعلمات
    viewportSize: SingleSizeArray
    حجم إطار العرض لإدخال عملية الربط هذا.
    slotSize: GeneralSize
    أحجام الفتحة لإدخال عملية الربط هذا
  • المرتجعات
    SizeMappingBuilder
    مرجع إلى أداة الإنشاء هذه.


build

  • build(): null | SizeMappingArray
  • ينشئ مواصفات خريطة الحجم من عمليات الربط التي تمت إضافتها إلى أداة الإنشاء هذه.

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

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

  • المرتجعات
    null | SizeMappingArray
    هي النتيجة التي أنشأتها أداة الإنشاء هذه. يمكن أن تكون القيمة فارغة في حال تقديم تعيينات حجم غير صالحة.


googletag.Slot

الشريحة الإعلانية هي كائن يمثّل شريحة إعلانية واحدة على إحدى الصفحات.

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


addService

  • addService(service: Service): Slot
  • إضافة Service إلى هذه الخانة

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


clearCategoryExclusions

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

  • مثال

    JavaScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    
    // Make an ad request. No ad with 'AirlineAd' label will be returned
    // for the slot.
    
    // Clear category exclusions so all ads can be returned.
    slot.clearCategoryExclusions();
    
    // Make an ad request. Any ad can be returned for the slot.
    

    JavaScript (قديم)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    
    // Make an ad request. No ad with 'AirlineAd' label will be returned
    // for the slot.
    
    // Clear category exclusions so all ads can be returned.
    slot.clearCategoryExclusions();
    
    // Make an ad request. Any ad can be returned for the slot.
    

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setCategoryExclusion("AirlineAd")
      .addService(googletag.pubads());
    
    // Make an ad request. No ad with 'AirlineAd' label will be returned
    // for the slot.
    
    // Clear category exclusions so all ads can be returned.
    slot.clearCategoryExclusions();
    
    // Make an ad request. Any ad can be returned for the slot.
    
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


clearTargeting

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

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .setTargeting("color", "red")
      .addService(googletag.pubads());
    
    slot.clearTargeting("color");
    // Targeting 'allow_expandable' and 'interests' are still present,
    // while 'color' was cleared.
    
    slot.clearTargeting();
    // All targeting has been cleared.
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .setTargeting("color", "red")
      .addService(googletag.pubads());
    
    slot.clearTargeting("color");
    // Targeting 'allow_expandable' and 'interests' are still present,
    // while 'color' was cleared.
    
    slot.clearTargeting();
    // All targeting has been cleared.
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .setTargeting("color", "red")
      .addService(googletag.pubads());
    
    slot.clearTargeting("color");
    // Targeting 'allow_expandable' and 'interests' are still present,
    // while 'color' was cleared.
    
    slot.clearTargeting();
    // All targeting has been cleared.
    
    يمكن أيضًا مراجعة
  • المعلمات
    key?: string
    مفتاح معلمة الاستهداف. المفتاح اختياري، وسيتم محو جميع مَعلمات الاستهداف إذا لم يتم تحديده.
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


defineSizeMapping

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

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    const mapping = googletag
      .sizeMapping()
      .addSize([100, 100], [88, 31])
      .addSize(
        [320, 400],
        [
          [320, 50],
          [300, 50],
        ]
      )
      .build();
    
    slot.defineSizeMapping(mapping);
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    var mapping = googletag
      .sizeMapping()
      .addSize([100, 100], [88, 31])
      .addSize(
        [320, 400],
        [
          [320, 50],
          [300, 50],
        ]
      )
      .build();
    
    slot.defineSizeMapping(mapping);
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    const mapping = googletag
      .sizeMapping()
      .addSize([100, 100], [88, 31])
      .addSize(
        [320, 400],
        [
          [320, 50],
          [300, 50],
        ]
      )
      .build();
    
    slot.defineSizeMapping(mapping!);
    
    يمكن أيضًا مراجعة
  • المعلمات
    sizeMapping: SizeMappingArray
    مصفوفة من تعيينات الحجم. يمكنك استخدام SizeMappingBuilder لإنشائه. تشمل كل عملية ربط للحجم مصفوفة من عنصرَين: SingleSizeArray وGeneralSize.
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


get

  • get(key: string): null | string
  • تعرض قيمة سمة AdSense المرتبطة بالمفتاح المحدد لهذه الخانة. للاطّلاع على سمات مستوى الخدمة المكتسَبة من هذه الخانة، استخدِم PubAdsService.get.

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    slot.get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    slot.get("adsense_background_color");
    // Returns '#FFFFFF'.
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    slot.get("adsense_background_color");
    // Returns '#FFFFFF'.
    
    يمكن أيضًا مراجعة
  • المعلمات
    key: string
    اسم السمة التي يجب البحث عنها
  • المرتجعات
    null | string
    القيمة الحالية لمفتاح السمة، أو null إذا كان المفتاح غير موجود.


getAdUnitPath

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    slot.getAdUnitPath();
    // Returns '/1234567/sports'.
    
  • المرتجعات
    string
    مسار الوحدة الإعلانية.


getAttributeKeys

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

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .set("adsense_border_color", "#AABBCC")
      .addService(googletag.pubads());
    
    slot.getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .set("adsense_border_color", "#AABBCC")
      .addService(googletag.pubads());
    
    slot.getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .set("adsense_background_color", "#FFFFFF")
      .set("adsense_border_color", "#AABBCC")
      .addService(googletag.pubads());
    
    slot.getAttributeKeys();
    // Returns ['adsense_background_color', 'adsense_border_color'].
    
  • المرتجعات
    string[]
    مصفوفة من مفاتيح السمات. الترتيب غير محدد.


getCategoryExclusions

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

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .setCategoryExclusion("TrainAd")
      .addService(googletag.pubads());
    
    slot.getCategoryExclusions();
    // Returns ['AirlineAd', 'TrainAd'].
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setCategoryExclusion("AirlineAd")
      .setCategoryExclusion("TrainAd")
      .addService(googletag.pubads());
    
    slot.getCategoryExclusions();
    // Returns ['AirlineAd', 'TrainAd'].
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setCategoryExclusion("AirlineAd")
      .setCategoryExclusion("TrainAd")
      .addService(googletag.pubads());
    
    slot.getCategoryExclusions();
    // Returns ['AirlineAd', 'TrainAd'].
    
  • المرتجعات
    string[]
    تصنيفات استبعاد فئة الإعلانات لهذه الشريحة الإعلانية أو مصفوفة فارغة إذا لم يتم ضبط أيٍّ منها.


getResponseInformation

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

  • المرتجعات
    null | ResponseInformation
    أحدث معلومات استجابة الإعلان، أو null إذا لم تحتوي الشريحة الإعلانية على أي إعلان.


getSlotElementId

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    slot.getSlotElementId();
    // Returns 'div'.
    
  • المرتجعات
    string
    معرّف الشريحة div


getTargeting

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

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .addService(googletag.pubads());
    
    slot.getTargeting("allow_expandable");
    // Returns ['true'].
    
    slot.getTargeting("age");
    // Returns [] (empty array).
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .addService(googletag.pubads());
    
    slot.getTargeting("allow_expandable");
    // Returns ['true'].
    
    slot.getTargeting("age");
    // Returns [] (empty array).
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setTargeting("allow_expandable", "true")
      .addService(googletag.pubads());
    
    slot.getTargeting("allow_expandable");
    // Returns ['true'].
    
    slot.getTargeting("age");
    // Returns [] (empty array).
    
  • المعلمات
    key: string
    مفتاح الاستهداف المطلوب البحث عنه.
  • المرتجعات
    string[]
    يشير ذلك المصطلح إلى القيم المرتبطة بهذا المفتاح أو مصفوفة فارغة في حال عدم توفُّر هذا المفتاح.


getTargetingKeys

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

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .addService(googletag.pubads());
    
    slot.getTargetingKeys();
    // Returns ['interests', 'allow_expandable'].
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .addService(googletag.pubads());
    
    slot.getTargetingKeys();
    // Returns ['interests', 'allow_expandable'].
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setTargeting("allow_expandable", "true")
      .setTargeting("interests", ["sports", "music"])
      .addService(googletag.pubads());
    
    slot.getTargetingKeys();
    // Returns ['interests', 'allow_expandable'].
    
  • المرتجعات
    string[]
    مصفوفة مفاتيح الاستهداف الترتيب غير محدد.


set

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

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

  • مثال

    JavaScript

    // Setting an attribute on a single ad slot.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    

    JavaScript (قديم)

    // Setting an attribute on a single ad slot.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    

    TypeScript

    // Setting an attribute on a single ad slot.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .set("adsense_background_color", "#FFFFFF")
      .addService(googletag.pubads());
    
    يمكن أيضًا مراجعة
  • المعلمات
    key: string
    اسم السمة.
    value: string
    قيمة السمة.
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


setCategoryExclusion

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


setClickUrl

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

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


setCollapseEmptyDiv

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

  • مثال

    JavaScript

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setCollapseEmptyDiv(true, true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // when the page is loaded, before ads are requested.
    
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-2")
      .setCollapseEmptyDiv(true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // only after GPT detects that no ads are available for the slot.
    

    JavaScript (قديم)

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setCollapseEmptyDiv(true, true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // when the page is loaded, before ads are requested.
    
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-2")
      .setCollapseEmptyDiv(true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // only after GPT detects that no ads are available for the slot.
    

    TypeScript

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setCollapseEmptyDiv(true, true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // when the page is loaded, before ads are requested.
    
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-2")!
      .setCollapseEmptyDiv(true)
      .addService(googletag.pubads());
    // The above will cause the div for this slot to be collapsed
    // only after GPT detects that no ads are available for the slot.
    
    يمكن أيضًا مراجعة
  • المعلمات
    collapse: boolean
    تحديد ما إذا كان سيتم تصغير الخانة في حال عدم عرض أي إعلان
    collapseBeforeAdFetch?: boolean
    لتحديد ما إذا كان سيتم تصغير الخانة حتى قبل أن يتم استرجاع الإعلان يتم تجاهل السياسة إذا لم يكن التصغير true.
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


setConfig

  • setConfig(slotConfig: SlotSettingsConfig): void
  • لضبط خيارات الضبط العامة لهذه الخانة.

  • المعلمات
    slotConfig: SlotSettingsConfig
    كائن الضبط.


setForceSafeFrame

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

    يُرجى وضع الأمور التالية في الاعتبار أثناء استخدام واجهة برمجة التطبيقات هذه:

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

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

    googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .setForceSafeFrame(true)
      .addService(googletag.pubads());
    
    يمكن أيضًا مراجعة
  • المعلمات
    forceSafeFrame: boolean
    true لفرض عرض جميع الإعلانات في هذه الخانة ضمن الإطارات الآمنة وfalse لإيقاف أحد الإعدادات على مستوى الصفحة (إن كان متوفّرًا). ولن يؤدي ضبط هذه السياسة على false في حال عدم تحديدها على مستوى الصفحة إلى إجراء أي تغيير.
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot
  • تحدِّد هذه السياسة الإعدادات المفضَّلة على مستوى الخانة لإعدادات SafeFrame. وسيتم تجاهل أي مفاتيح غير معروفة في كائن الإعداد. سيتم تجاهل الإعدادات بالكامل في حال تمرير قيمة غير صالحة لمفتاح معروف.

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

  • مثال

    JavaScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will have a sandboxed safeframe that only
    // disallows top-level navigation.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig({ sandbox: true })
      .addService(googletag.pubads());
    
    // The following slot will inherit page-level settings.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    JavaScript (قديم)

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will have a sandboxed safeframe that only
    // disallows top-level navigation.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")
      .setSafeFrameConfig({ sandbox: true })
      .addService(googletag.pubads());
    
    // The following slot will inherit page-level settings.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    

    TypeScript

    googletag.pubads().setForceSafeFrame(true);
    
    // The following slot will have a sandboxed safeframe that only
    // disallows top-level navigation.
    googletag
      .defineSlot("/1234567/sports", [160, 600], "div-1")!
      .setSafeFrameConfig({ sandbox: true })
      .addService(googletag.pubads());
    
    // The following slot will inherit page-level settings.
    googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());
    
    googletag.display("div-1");
    googletag.display("div-2");
    
    يمكن أيضًا مراجعة
  • المعلمات
    config: null | SafeFrameConfig
    كائن الضبط.
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


setTargeting

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

  • مثال

    JavaScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    // Example with a single value for a key.
    slot.setTargeting("allow_expandable", "true");
    
    // Example with multiple values for a key inside in an array.
    slot.setTargeting("interests", ["sports", "music"]);
    

    JavaScript (قديم)

    var slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")
      .addService(googletag.pubads());
    
    // Example with a single value for a key.
    slot.setTargeting("allow_expandable", "true");
    
    // Example with multiple values for a key inside in an array.
    slot.setTargeting("interests", ["sports", "music"]);
    

    TypeScript

    const slot = googletag
      .defineSlot("/1234567/sports", [160, 600], "div")!
      .addService(googletag.pubads());
    
    // Example with a single value for a key.
    slot.setTargeting("allow_expandable", "true");
    
    // Example with multiple values for a key inside in an array.
    slot.setTargeting("interests", ["sports", "music"]);
    
    يمكن أيضًا مراجعة
  • المعلمات
    key: string
    مفتاح معلمة الاستهداف.
    value: string | string[]
    قيمة مَعلمة الاستهداف أو مصفوفة القيم
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


updateTargetingFromMap

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

    ملاحظات:

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

  • مثال

    JavaScript

    const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
    
    slot.updateTargetingFromMap({
      color: "red",
      interests: ["sports", "music", "movies"],
    });
    

    JavaScript (قديم)

    var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
    
    slot.updateTargetingFromMap({
      color: "red",
      interests: ["sports", "music", "movies"],
    });
    

    TypeScript

    const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;
    
    slot.updateTargetingFromMap({
      color: "red",
      interests: ["sports", "music", "movies"],
    });
    
  • المعلمات
    map: {  [adUnitPath: string]: string | string[] }
    استهداف مفتاح المعلمة:خريطة القيمة.
  • المرتجعات
    Slot
    كائن الفتحة الذي تم استدعاء الطريقة عليه.


googletag.config.AdExpansionConfig

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

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

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

JavaScript (قديم)

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});


enabled


googletag.config.ComponentAuctionConfig

عنصر يمثّل مزادًا مكوّنًا واحدًا في مزاد إعلانات على الجهاز فقط

ملخّص الملكية
auctionConfig
كائن تكوين مزاد لمزاد المكوّنات هذا.
configKey
مفتاح الضبط المرتبط بمزاد المكوّنات هذا.
يمكن أيضًا مراجعة


auctionConfig

  • auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: {  [buyer: string]: number }, perBuyerGroupLimits: {  [buyer: string]: number }, perBuyerSignals: {  [buyer: string]: unknown }, perBuyerTimeouts: {  [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
  • كائن ضبط مزاد لمزاد المكوّنات هذا.

    في حال ضبط هذه القيمة على null، سيتم حذف أي إعدادات حالية لـ "configKey" المحدَّد.

  • مثال

    JavaScript

    const componentAuctionConfig = {
      // Seller URL should be https and the same as decisionLogicUrl's origin
      seller: "https://testSeller.com",
      decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
      interestGroupBuyers: ["https://example-buyer.com"],
      auctionSignals: { auction_signals: "auction_signals" },
      sellerSignals: { seller_signals: "seller_signals" },
      perBuyerSignals: {
        // listed on interestGroupBuyers
        "https://example-buyer.com": {
          per_buyer_signals: "per_buyer_signals",
        },
      },
    };
    
    const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    
    // To add configKey to the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: componentAuctionConfig,
        },
      ],
    });
    
    // To remove configKey from the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: null,
        },
      ],
    });
    

    JavaScript (قديم)

    var componentAuctionConfig = {
      // Seller URL should be https and the same as decisionLogicUrl's origin
      seller: "https://testSeller.com",
      decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
      interestGroupBuyers: ["https://example-buyer.com"],
      auctionSignals: { auction_signals: "auction_signals" },
      sellerSignals: { seller_signals: "seller_signals" },
      perBuyerSignals: {
        // listed on interestGroupBuyers
        "https://example-buyer.com": {
          per_buyer_signals: "per_buyer_signals",
        },
      },
    };
    
    var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);
    
    // To add configKey to the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: componentAuctionConfig,
        },
      ],
    });
    
    // To remove configKey from the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: null,
        },
      ],
    });
    

    TypeScript

    const componentAuctionConfig = {
      // Seller URL should be https and the same as decisionLogicUrl's origin
      seller: "https://testSeller.com",
      decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
      interestGroupBuyers: ["https://example-buyer.com"],
      auctionSignals: { auction_signals: "auction_signals" },
      sellerSignals: { seller_signals: "seller_signals" },
      perBuyerSignals: {
        // listed on interestGroupBuyers
        "https://example-buyer.com": {
          per_buyer_signals: "per_buyer_signals",
        },
      },
    };
    
    const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;
    
    // To add configKey to the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: componentAuctionConfig,
        },
      ],
    });
    
    // To remove configKey from the component auction:
    auctionSlot.setConfig({
      componentAuction: [
        {
          configKey: "https://testSeller.com",
          auctionConfig: null,
        },
      ],
    });
    
    يمكن أيضًا مراجعة


configKey

  • configKey: string
  • مفتاح الإعداد المرتبط بمزاد المكوّنات هذا.

    يجب أن تكون هذه القيمة غير فارغة ويجب أن تكون فريدة. في حال كان هناك كائنان من نوع ComponentAuctionConfig يتشاركان في قيمة configKey نفسها، سيتم استبدال آخر عنصر يتم ضبطه بالإعدادات السابقة.


googletag.config.InterstitialConfig

كائن يحدد سلوك شريحة إعلانية بينية واحدة.

ملخّص الملكية
triggers
إعداد المشغِّل البيني لهذا الإعلان البيني.


triggers

  • triggers: Partial<Record<InterstitialTrigger, boolean>>
  • إعداد المشغِّل البيني لهذا الإعلان البيني.

    سيؤدي ضبط قيمة المشغّل البيني على true إلى تفعيله وسيؤدي false إلى إيقافه. وسيؤدي هذا إلى إلغاء القيم التلقائية التي تم ضبطها في "مدير إعلانات Google".

  • مثال

    JavaScript

    // Define a GPT managed web interstitial ad slot.
    const interstitialSlot = googletag.defineOutOfPageSlot(
      "/1234567/sports",
      googletag.enums.OutOfPageFormat.INTERSTITIAL
    );
    
    // Enable optional interstitial triggers.
    // Change this value to false to disable.
    const enableTriggers = true;
    
    interstitialSlot.setConfig({
      interstitial: {
        triggers: {
          navBar: enableTriggers,
          unhideWindow: enableTriggers,
        },
      },
    });
    

    JavaScript (قديم)

    // Define a GPT managed web interstitial ad slot.
    var interstitialSlot = googletag.defineOutOfPageSlot(
      "/1234567/sports",
      googletag.enums.OutOfPageFormat.INTERSTITIAL
    );
    
    // Enable optional interstitial triggers.
    // Change this value to false to disable.
    var enableTriggers = true;
    
    interstitialSlot.setConfig({
      interstitial: {
        triggers: {
          navBar: enableTriggers,
          unhideWindow: enableTriggers,
        },
      },
    });
    

    TypeScript

    // Define a GPT managed web interstitial ad slot.
    const interstitialSlot = googletag.defineOutOfPageSlot(
      "/1234567/sports",
      googletag.enums.OutOfPageFormat.INTERSTITIAL
    )!;
    
    // Enable optional interstitial triggers.
    // Change this value to false to disable.
    const enableTriggers = true;
    
    interstitialSlot.setConfig({
      interstitial: {
        triggers: {
          navBar: enableTriggers,
          unhideWindow: enableTriggers,
        },
      },
    });
    
    يمكن أيضًا مراجعة


googletag.config.PageSettingsConfig

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

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

جميع المواقع الواردة أدناه هي أمثلة ولا تعكس الميزات الفعلية التي تستخدم setConfig. للحصول على مجموعة من الميزات، يمكنك الاطّلاع على الحقول ضمن نوع PageSettingsConfig أدناه.

أمثلة:

  • يتم فقط تعديل الميزات المحددة في استدعاء setConfig.
      // Configure feature alpha.
      googletag.setConfig({
          alpha: {...}
      });
    
      // Configure feature bravo. Feature alpha is unchanged.
      googletag.setConfig({
         bravo: {...}
      });
    
  • يتم تحديث جميع الإعدادات لميزة معينة مع كل طلب إلى setConfig.
      // Configure feature charlie to echo = 1, foxtrot = true.
      googletag.setConfig({
          charlie: {
              echo: 1,
              foxtrot: true,
          }
      });
    
      // Update feature charlie to echo = 2. Since foxtrot was not specified,
      // the value is cleared.
      googletag.setConfig({
          charlie: {
              echo: 2
          }
      });
    
  • يمكن محو جميع إعدادات الميزة من خلال ضبط null.
      // Configure features delta, golf, and hotel.
      googletag.setConfig({
          delta: {...},
          golf: {...},
          hotel: {...},
      });
    
      // Feature delta and hotel are cleared, but feature golf remains set.
      googletag.setConfig({
          delta: null,
          hotel: null,
      });
    

ملخّص الملكية
adExpansion
إعدادات للتحكّم في توسيع الإعلان.
pps
إعدادات للتحكُّم في "الإشارات المقدَّمة من الناشر" (PPS).
privacyTreatments
إعدادات للتحكّم في عمليات معالجة خصوصية الناشرين


adExpansion

  • adExpansion: null | AdExpansionConfig
  • إعدادات للتحكّم في توسيع الإعلان.


pps


privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig
  • إعدادات للتحكّم في عمليات معالجة خصوصية الناشرين


googletag.config.PrivacyTreatmentsConfig

إعدادات للتحكّم في عمليات معالجة خصوصية الناشرين

ملخّص الملكية
treatments
مصفوفة من خيارات معالجة خصوصية الناشرين المطلوب تفعيلها.


treatments

  • treatments: "disablePersonalization"[]
  • مصفوفة من خيارات معالجة خصوصية الناشرين المطلوب تفعيلها.

  • مثال

    JavaScript

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

    JavaScript (قديم)

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

    TypeScript

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


googletag.config.PublisherProvidedSignalsConfig

عنصر إعداد الإشارات المقدَّمة من الناشر (PPS)

ملخّص الملكية
taxonomies
كائن يحتوي على تعيينات التصنيف.
مثال

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript (قديم)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
يمكن أيضًا مراجعة


taxonomies


googletag.config.SlotSettingsConfig

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

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

جميع المواقع الواردة أدناه هي أمثلة ولا تعكس الميزات الفعلية التي تستخدم setConfig. للحصول على مجموعة من الميزات، يمكنك الاطّلاع على الحقول ضمن نوع ScheduleSettingsConfig أدناه.

أمثلة:

  • يتم فقط تعديل الميزات المحددة في استدعاء Slot.setConfig.
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);
    
      // Configure feature alpha.
      slot.setConfig({
          alpha: {...}
      });
    
      // Configure feature bravo. Feature alpha is unchanged.
      slot.setConfig({
         bravo: {...}
      });
    
  • يتم تحديث جميع الإعدادات لميزة معينة مع كل طلب إلى Slot.setConfig.
      // Configure feature charlie to echo = 1, foxtrot = true.
      slot.setConfig({
          charlie: {
              echo: 1,
              foxtrot: true,
          }
      });
    
      // Update feature charlie to echo = 2. Since foxtrot was not specified,
      // the value is cleared.
      slot.setConfig({
          charlie: {
              echo: 2
          }
      });
    
  • يمكن محو جميع إعدادات الميزة من خلال ضبط null.
      // Configure features delta, golf, and hotel.
      slot.setConfig({
          delta: {...},
          golf: {...},
          hotel: {...},
      });
    
      // Feature delta and hotel are cleared, but feature golf remains set.
      slot.setConfig({
          delta: null,
          hotel: null,
      });
    

ملخّص الملكية
adExpansion
إعدادات للتحكّم في توسيع الإعلان.
componentAuction
مصفوفة من مزادات المكوّنات سيتم تضمينها في مزاد إعلانات على الجهاز فقط
interstitial
الإعدادات التي تتحكم في سلوك خانة الإعلانات البينية.


adExpansion

  • adExpansion: AdExpansionConfig
  • إعدادات للتحكّم في توسيع الإعلان.


componentAuction

  • componentAuction: ComponentAuctionConfig[]
  • مصفوفة من مزادات المكوّنات سيتم تضمينها في مزاد إعلانات على الجهاز فقط


interstitial

  • interstitial: InterstitialConfig
  • الإعدادات التي تتحكم في سلوك خانة الإعلانات البينية.


googletag.config.TaxonomyData

كائن يحتوي على قيم تصنيف واحد.

ملخّص الملكية
values
قائمة بقيم التصنيف.


values


googletag.events.Event

الواجهة الأساسية لجميع أحداث GPT. ستحتوي جميع أحداث GPT أدناه على الحقول التالية.

ملخّص الملكية
serviceName
اسم الخدمة التي أدت إلى تشغيل الحدث.
slot
الخانة التي أدت إلى تشغيل الحدث.
يمكن أيضًا مراجعة


serviceName

  • serviceName: string
  • اسم الخدمة التي أدت إلى تشغيل الحدث.


slot

  • slot: Slot
  • الخانة التي أدت إلى تشغيل الحدث.


googletag.events.EventTypeMap

وهذا نوع زائفة يربط اسم حدث بنوع كائن الحدث المقابل له في Service.addEventListener وService.removeEventListener. وقد تم توثيقها لأغراض تتعلّق بأمان النوع والإشارة فقط.

ملخّص الملكية
impressionViewable
العنوان البديل للبريد الإلكتروني events.ImpressionViewableEvent
rewardedSlotClosed
العنوان البديل للبريد الإلكتروني events.RewardedSlotClosedEvent
rewardedSlotGranted
العنوان البديل للبريد الإلكتروني events.RewardedSlotGrantedEvent
rewardedSlotReady
العنوان البديل للبريد الإلكتروني events.RewardedSlotReadyEvent
slotOnload
العنوان البديل للبريد الإلكتروني events.SlotOnloadEvent
slotRenderEnded
العنوان البديل للبريد الإلكتروني events.SlotRenderEndedEvent
slotRequested
العنوان البديل للبريد الإلكتروني events.SlotRequestedEvent
slotResponseReceived
العنوان البديل للبريد الإلكتروني events.SlotResponseReceived
slotVisibilityChanged
العنوان البديل للبريد الإلكتروني events.SlotVisibilityChangedEvent


impressionViewable


rewardedSlotClosed


rewardedSlotGranted


rewardedSlotReady


slotOnload


slotRenderEnded


slotRequested


slotResponseReceived


slotVisibilityChanged


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

JavaScript (قديم)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


googletag.events.RewardedSlotClosedEvent

توسيع Event

يتم تنشيط هذا الحدث عندما يغلق المستخدم خانة إعلانات تضم مكافأة. قد يتم تنشيطها إما قبل أو بعد منح المكافأة. لتحديد ما إذا تم منح مكافأة، استخدِم events.RewardedSlotGrantedEvent بدلاً من ذلك.

ملخّص الملكية
serviceName
اسم الخدمة التي أدت إلى تشغيل الحدث.
slot
الخانة التي أدت إلى تشغيل الحدث.
مثال

JavaScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

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

JavaScript (قديم)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

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

TypeScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


googletag.events.RewardedSlotGrantedEvent

توسيع Event

يتم تنشيط هذا الحدث عندما يتم منح مكافأة مقابل مشاهدة إعلان بمكافأة. إذا تم إغلاق الإعلان قبل استيفاء معايير منح المكافأة، لن يتم تنشيط هذا الحدث.

ملخّص الملكية
payload
عنصر يحتوي على معلومات عن المكافأة التي تم منحها
serviceName
اسم الخدمة التي أدت إلى تشغيل الحدث.
slot
الخانة التي أدت إلى تشغيل الحدث.
مثال

JavaScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

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

JavaScript (قديم)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
  var _a, _b;
  var slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
  console.log(
    "Reward amount:",
    (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount
  );
  console.groupEnd();

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

TypeScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


payload

  • payload: null | RewardedPayload
  • عنصر يحتوي على معلومات عن المكافأة التي تم منحها


googletag.events.RewardedSlotReadyEvent

توسيع Event

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

ملخّص الملكية
serviceName
اسم الخدمة التي أدت إلى تشغيل الحدث.
slot
الخانة التي أدت إلى تشغيل الحدث.
ملخّص الطريقة
makeRewardedVisible
عرض الإعلان الذي يضم مكافأة
مثال

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  const userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

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

JavaScript (قديم)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  var userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  const userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


makeRewardedVisible

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


googletag.events.SlotOnloadEvent

توسيع 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.
  }
});

JavaScript (قديم)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


googletag.events.SlotRenderEndedEvent

توسيع Event

يتم تنشيط هذا الحدث عند إدخال رمز تصميم الإعلان في خانة. سيحدث هذا الحدث قبل استرجاع موارد تصميم الإعلان، لذا قد لا يكون تصميم الإعلان مرئيًا بعد. إذا كنت تريد معرفة وقت انتهاء تحميل جميع موارد تصميمات الإعلانات لشريحة محدّدة، ننصحك باستخدام events.SlotOnloadEvent بدلاً من ذلك.

ملخّص الملكية
advertiserId
الرقم التعريفي للمعلِن للإعلان المعروض
campaignId
رقم تعريف الحملة للإعلان المعروض.
companyIds
أرقام تعريف الشركات التي تقدّم عروض أسعار على إعلان إعادة التعبئة المعروض
creativeId
رقم تعريف تصميم الإعلان الخاص بالإعلان المحجوز المعروض.
creativeTemplateId
رقم تعريف نموذج تصميم الإعلان الخاص بـ "الإعلان المستند إلى الحجز" المعروض
isBackfill
ما إذا كان الإعلان إعلانًا لإعادة التعبئة.
isEmpty
ما إذا كان قد تم عرض إعلان للخانة الإعلانية.
labelIds
أرقام تعريف التصنيفات للإعلان المعروض.
lineItemId
رقم تعريف العنصر في "الإعلان المحجوز المعروض"
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("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

JavaScript (قديم)

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

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

TypeScript

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

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


advertiserId

  • advertiserId: null | number
  • الرقم التعريفي للمعلِن للإعلان المعروض القيمة هي null للخانات الفارغة، وإعلانات إعادة التعبئة، وتصاميم الإعلانات المعروضة من خلال خدمات أخرى غير PubAdsService.


campaignId

  • campaignId: null | number
  • رقم تعريف الحملة للإعلان المعروض. القيمة هي null للخانات الفارغة، وإعلانات إعادة التعبئة، وتصاميم الإعلانات المعروضة من خلال خدمات أخرى غير PubAdsService.


companyIds

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


creativeId

  • creativeId: null | number
  • رقم تعريف تصميم الإعلان الخاص بالإعلان المحجوز المعروض. القيمة هي null للخانات الفارغة، وإعلانات إعادة التعبئة، وتصاميم الإعلانات المعروضة من خلال خدمات أخرى غير PubAdsService.


creativeTemplateId

  • creativeTemplateId: null | number
  • رقم تعريف نموذج تصميم الإعلان الخاص بـ "الإعلان المستند إلى الحجز" المعروض القيمة هي null للخانات الفارغة، وإعلانات إعادة التعبئة، وتصاميم الإعلانات المعروضة من خلال خدمات أخرى غير PubAdsService.


isBackfill

  • isBackfill: boolean
  • ما إذا كان الإعلان إعلانًا لإعادة التعبئة. القيمة هي true إذا كان الإعلان عبارة عن طلب إضافة بيانات، أو false بخلاف ذلك.


isEmpty

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


labelIds

  • labelIds: null | number[]
  • أرقام تعريف التصنيفات للإعلان المعروض. القيمة هي null للخانات الفارغة، وإعلانات إعادة التعبئة، وتصاميم الإعلانات المعروضة من خلال خدمات أخرى غير PubAdsService.


lineItemId

  • lineItemId: null | number
  • رقم تعريف العنصر في "الإعلان المحجوز المعروض" القيمة هي null للخانات الفارغة، وإعلانات إعادة التعبئة، وتصاميم الإعلانات المعروضة من خلال خدمات أخرى غير PubAdsService.


size

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


slotContentChanged

  • slotContentChanged: boolean
  • ما إذا كان قد تم تغيير محتوى الشريحة مع الإعلان المعروض. تكون القيمة true إذا تم تغيير المحتوى، وfalse غير ذلك.


sourceAgnosticCreativeId

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


sourceAgnosticLineItemId

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


yieldGroupIds

  • yieldGroupIds: null | 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.
  }
});

JavaScript (قديم)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


googletag.events.SlotResponseReceived

توسيع Event

يتم تنشيط هذا الحدث عند تلقي استجابة إعلان لخانة إعلانية معينة.

ملخّص الملكية
serviceName
اسم الخدمة التي أدت إلى تشغيل الحدث.
slot
الخانة التي أدت إلى تشغيل الحدث.
مثال

JavaScript

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

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

JavaScript (قديم)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


googletag.events.SlotVisibilityChangedEvent

توسيع 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.
  }
});

JavaScript (قديم)

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

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

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
يمكن أيضًا مراجعة


inViewPercentage

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


googletag.secureSignals.BidderSignalProvider

تعرِض إشارة آمنة لمقدِّم عرض سعر محدَّد.

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

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

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

JavaScript

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

JavaScript (قديم)

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

TypeScript

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


collectorFunction

  • collectorFunction: () => Promise<string>


id

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


googletag.secureSignals.PublisherSignalProvider

تعرض إشارة آمنة لناشر محدّد.

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

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

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

JavaScript

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

JavaScript (قديم)

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

TypeScript

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


collectorFunction

  • collectorFunction: () => Promise<string>


networkCode

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


googletag.secureSignals.SecureSignalProvidersArray

واجهة لإدارة الإشارات الآمنة

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


clearAllCache

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


push