انتقال Config API

این راهنما نمونه‌هایی برای انتقال از روش‌های پیکربندی قدیمی به کتابخانه جدید «برچسب ناشر Google» ‏ (GPT) setConfig و میاناهای برنامه‌سازی کاربردی getConfig ارائه می‌دهد.

میاناهای برنامه‌سازی کاربردی setConfig و getConfig روشی متمرکز برای مدیریت پیکربندی سطح صفحه و سطح جایگاه ارائه می‌دهند.

تنظیم پیکربندی سطح صفحه

جدول زیر روش‌های پیکربندی قدیمی PubAdsService را به جایگزین‌های setConfig آن‌ها نگاشت می‌کند.

ویژگی روش قدیمی جایگزین setConfig
مشخصه‌های AdSense set(key, value) googletag.setConfig({ adsenseAttributes: { [key]: value } })
استثنا کردن دسته clearCategoryExclusions() googletag.setConfig({ categoryExclusion: null })
setCategoryExclusion(label) googletag.setConfig({ categoryExclusion: [label] })
مرکزیابی setCentering(centerAds) googletag.setConfig({ centering: centerAds })
جمع کردن divهای خالی collapseEmptyDivs(collapseBeforeFetch) googletag.setConfig({ collapseDiv: collapseBeforeFetch ? 'BEFORE_FETCH' : 'ON_NO_FILL' })
بار کردن اولیه و معماری درخواست تکی (SRA) disableInitialLoad() googletag.setConfig({ disableInitialLoad: true })
enableSingleRequest() googletag.setConfig({ singleRequest: true })
بارکردن کُند enableLazyLoad(config) googletag.setConfig({ lazyLoad: config })
مکان setLocation(address) googletag.setConfig({ location: address })
SafeFrame setForceSafeFrame(force) googletag.setConfig({ safeFrame: { forceSafeFrame: force } })
setSafeFrameConfig(config) googletag.setConfig({ safeFrame: config })
هدف‌یابی clearTargeting(key) googletag.setConfig({ targeting: { [key]: null } })
setTargeting(key, value) googletag.setConfig({ targeting: { [key]: value } })
آگهی‌های ویدیویی enableVideoAds() googletag.setConfig({ videoAds: { enableVideoAds: true } })
setVideoContent(contentId, cmsId) googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: contentId, videoCmsId: cmsId } })

مشخصه‌های AdSense

نسخه قدیمی:

googletag.pubads().set('document_language', 'en');

جدید:

googletag.setConfig({
  adsenseAttributes: {
    document_language: 'en'
  }
});

مستثنی کردن دسته

نسخه قدیمی:

googletag.pubads().setCategoryExclusion('AirlineAd');
googletag.pubads().clearCategoryExclusions();

جدید:

// Set category exclusion
googletag.setConfig({
  categoryExclusion: ['AirlineAd']
});

// Clear category exclusions
googletag.setConfig({
  categoryExclusion: null
});

در مرکز قرار دادن

نسخه قدیمی:

googletag.pubads().setCentering(true);

جدید:

googletag.setConfig({
  centering: true
});

جمع کردن divهای خالی

نسخه قدیمی:

googletag.pubads().collapseEmptyDivs(true); // Collapse before fetch
googletag.pubads().collapseEmptyDivs(false); // Collapse on no fill

جدید:

// Collapse before fetch
googletag.setConfig({
  collapseDiv: 'BEFORE_FETCH'
});

// Collapse on no fill
googletag.setConfig({
  collapseDiv: 'ON_NO_FILL'
});

// Don't collapse
googletag.setConfig({
  collapseDiv: 'DISABLED'
});

بارگیری اولیه و معماری درخواست تکی (SRA)

نسخه قدیمی:

googletag.pubads().disableInitialLoad();
googletag.pubads().enableSingleRequest();

جدید:

googletag.setConfig({
  disableInitialLoad: true,
  singleRequest: true
});

بارکردن کُند

نسخه قدیمی:

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

جدید:

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

مکان

نسخه قدیمی:

googletag.pubads().setLocation('10001,US');

جدید:

googletag.setConfig({
  location: '10001,US'
});

SafeFrame

نسخه قدیمی:

googletag.pubads().setForceSafeFrame(true);
googletag.pubads().setSafeFrameConfig({sandbox: true});

جدید:

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

هدف‌گیری

نسخه قدیمی:

googletag.pubads().setTargeting('interests', 'sports');
googletag.pubads().setTargeting('interests', ['sports', 'music']);
googletag.pubads().clearTargeting('interests');
googletag.pubads().clearTargeting();

جدید:

// Set targeting
googletag.setConfig({
  targeting: {
    interests: 'sports'
  }
});

// Set multiple values
googletag.setConfig({
  targeting: {
    interests: ['sports', 'music']
  }
});

// Clear a specific key
googletag.setConfig({
  targeting: {
    interests: null
  }
});

// Clear all targeting
googletag.setConfig({
  targeting: null
});

آگهی‌های ویدیویی

نسخه قدیمی:

googletag.pubads().enableVideoAds();
googletag.pubads().setVideoContent('video123', 'cms456');

جدید:

googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: 'video123',
    videoCmsId: 'cms456'
  }
});

تنظیم پیکربندی سطح جایگاه

جدول زیر روش‌های پیکربندی قدیمی Slot را به جایگزین‌های setConfig آن‌ها نگاشت می‌کند.

ویژگی روش قدیمی جایگزین setConfig
مشخصه‌های AdSense set(key, value) Slot.setConfig({ adsenseAttributes: { [key]: value } })
استثنا کردن دسته clearCategoryExclusions() Slot.setConfig({ categoryExclusion: null })
setCategoryExclusion(label) Slot.setConfig({ categoryExclusion: [label] })
کلیک روی نشانی وب setClickUrl(url) Slot.setConfig({ clickUrl: url })
جمع کردن divهای خالی setCollapseEmptyDiv(collapse, collapseBeforeFetch) Slot.setConfig({ collapseDiv: collapse ? (collapseBeforeFetch ? 'BEFORE_FETCH' : 'ON_NO_FILL') : 'DISABLED' })
SafeFrame setForceSafeFrame(force) Slot.setConfig({ safeFrame: { forceSafeFrame: force } })
setSafeFrameConfig(config) Slot.setConfig({ safeFrame: config })
هدف‌یابی clearTargeting(key) Slot.setConfig({ targeting: { [key]: null } })
setTargeting(key, value) Slot.setConfig({ targeting: { [key]: value } })
updateTargetingFromMap(config) Slot.setConfig({ targeting: config })

مشخصه‌های AdSense

نسخه قدیمی:

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

جدید:

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

slot.setConfig({
  adsenseAttributes: {
    adsense_background_color: '#FFFFFF'
  }
});

مستثنی کردن دسته

نسخه قدیمی:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
slot.setCategoryExclusion('AirlineAd');
slot.clearCategoryExclusions();

جدید:

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

// Set category exclusion
slot.setConfig({
  categoryExclusion: ['AirlineAd']
});

// Clear category exclusions
slot.setConfig({
  categoryExclusion: null
});

کلیک روی نشانی وب

نسخه قدیمی:

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

جدید:

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

slot.setConfig({
  clickUrl: 'http://www.example.com?original_click_url='
});

جمع کردن divهای خالی

نسخه قدیمی:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
slot.setCollapseEmptyDiv(true, true); // Collapse before fetch

جدید:

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

slot.setConfig({
  collapseDiv: 'BEFORE_FETCH'
});

SafeFrame

نسخه قدیمی:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
slot.setForceSafeFrame(true);
slot.setSafeFrameConfig({sandbox: true});

جدید:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
slot.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    sandbox: true
  }
});

هدف‌گیری

نسخه قدیمی:

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

جدید:

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

// Set targeting
slot.setConfig({
  targeting: {
    allow_expandable: 'true'
  }
});

// Clear targeting
slot.setConfig({
  targeting: {
    allow_expandable: null
  }
});

// Update targeting (only specified KVs are set/modified).
slot.setConfig({
  targeting: {
    color: 'red',
    interests: ['sports', 'music', 'movies']
  }
});

دریافت پیکربندی سطح صفحه

جدول زیر روش‌های دریافت‌کننده قدیمی PubAdsService را به جایگزین‌های getConfig آن‌ها نگاشت می‌کند.

ویژگی روش قدیمی جایگزین getConfig
مشخصه‌های AdSense get(key) googletag.getConfig('adsenseAttributes')
getAttributeKeys() googletag.getConfig('adsenseAttributes')
بار اولیه isInitialLoadDisabled() googletag.getConfig('disableInitialLoad')
هدف‌یابی getTargeting(key) googletag.getConfig('targeting')
getTargetingKeys() googletag.getConfig('targeting')

مشخصه‌های AdSense

نسخه قدیمی:

const documentLanguage = googletag.pubads().get('document_language');
const adsenseAttributes = googletag.pubads().getAttributeKeys();

جدید:

const adsenseConfig = googletag.getConfig('adsenseAttributes').adsenseAttributes;

// Get the value of a single AdSense attribute.
const documentLanguage = adsenseConfig.document_language || null;

// Get all configured AdSense attribute keys.
const adsenseAttributes = Object.keys(adsenseConfig);

بار اولیه

نسخه قدیمی:

const isDisabled = googletag.pubads().isInitialLoadDisabled();

جدید:

const isDisabled = googletag.getConfig('disableInitialLoad').disableInitialLoad;

هدف‌گیری

نسخه قدیمی:

const targeting = googletag.pubads().getTargeting('interests');
const keys = googletag.pubads().getTargetingKeys();

جدید:

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

// Get targeting for a specific key.
const targeting = targetingConfig.interests || [];

// Get all targeting keys.
const keys = Object.keys(targetingConfig);

دریافت پیکربندی سطح جایگاه

جدول زیر روش‌های دریافت‌کننده قدیمی Slot را به جایگزین‌های getConfig آن‌ها نگاشت می‌کند.

ویژگی روش قدیمی جایگزین getConfig
مشخصه‌های AdSense get(key) Slot.getConfig('adsenseAttributes')
getAttributeKeys() Slot.getConfig('adsenseAttributes')
استثنا کردن دسته getCategoryExclusions() Slot.getConfig('categoryExclusion')
هدف‌یابی getTargeting(key) Slot.getConfig('targeting')
getTargetingKeys() Slot.getConfig('targeting')

مشخصه‌های AdSense

نسخه قدیمی:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
const bgColor = slot.get('adsense_background_color');
const adsenseAttributes = slot.getAttributeKeys();

جدید:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
const adsenseConfig = slot.getConfig('adsenseAttributes').adsenseAttributes;

// Get the value of a single AdSense attribute.
const bgColor = adsenseConfig.adsense_background_color || null;

// Get all configured AdSense attribute keys.
const adsenseAttributes = Object.keys(adsenseConfig);

مستثنی کردن دسته

نسخه قدیمی:

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

جدید:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
const exclusions = slot.getConfig('categoryExclusion').categoryExclusion || [];

هدف‌گیری

نسخه قدیمی:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
const targeting = slot.getTargeting('allow_expandable');
const keys = slot.getTargetingKeys();

جدید:

const slot = googletag.defineSlot('/1234567/sports', [160, 600], 'div');
const targetingConfig = slot.getConfig('targeting').targeting;

// Get targeting for a specific key.
const targeting = targetingConfig.allow_expandable || [];

// Get all targeting keys.
const keys = Object.keys(targetingConfig);