Migração da API Config

Este guia fornece exemplos de migração de métodos de configuração legados para a nova biblioteca de Tag de publisher do Google (GPT) setConfig e APIs getConfig.

As APIs setConfig e getConfig oferecem uma maneira centralizada de gerenciar a configuração no nível da página e do slot.

Definir a configuração no nível da página

A tabela a seguir mapeia os métodos de configuração legados do PubAdsService para as substituições do setConfig.

Recurso	Método legado	Substituição de `setConfig`
Atributos do AdSense	`set(key, value)`	`googletag.setConfig({ adsenseAttributes: { [key]: value } })`
Exclusão de categorias	`clearCategoryExclusions()`	`googletag.setConfig({ categoryExclusion: null })`
Exclusão de categorias	`setCategoryExclusion(label)`	`googletag.setConfig({ categoryExclusion: [label] })`
Centralização	`setCentering(centerAds)`	`googletag.setConfig({ centering: centerAds })`
Recolher divs vazias	`collapseEmptyDivs(collapseBeforeFetch)`	`googletag.setConfig({ collapseDiv: collapseBeforeFetch ? 'BEFORE_FETCH' : 'ON_NO_FILL' })`
Carregamento inicial e arquitetura de solicitação única (SRA)	`disableInitialLoad()`	`googletag.setConfig({ disableInitialLoad: true })`
	`enableSingleRequest()`	`googletag.setConfig({ singleRequest: true })`
Carregamento lento	`enableLazyLoad(config)`	`googletag.setConfig({ lazyLoad: config })`
Local	`setLocation(address)`	`googletag.setConfig({ location: address })`
SafeFrame	`setForceSafeFrame(force)`	`slot.setConfig({ safeFrame: { forceSafeFrame: force } })`
SafeFrame	`setSafeFrameConfig(config)`	`slot.setConfig({ safeFrame: config })`
Segmentação	`clearTargeting(key)`	`googletag.setConfig({ targeting: { [key]: null } })`
Segmentação	`setTargeting(key, value)`	`googletag.setConfig({ targeting: { [key]: value } })`
Anúncios em vídeo	`enableVideoAds()`	`googletag.setConfig({ videoAds: { enableVideoAds: true } })`
Anúncios em vídeo	`setVideoContent(contentId, cmsId)`	`googletag.setConfig({ videoAds: { videoContentId: contentId, videoCmsId: cmsId } })`

Legado:

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

Novo:

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

Exclusão de categorias

Legado:

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

Novo:

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

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

Centralização

Legado:

googletag.pubads().setCentering(true);

Novo:

googletag.setConfig({
  centering: true
});

Recolher divs vazias

Legado:

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

Novo:

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

Carga inicial e arquitetura de solicitação única (SRA)

Legado:

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

Novo:

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

Carregamento lento

Legado:

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

Novo:

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

Local

Legado:

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

Novo:

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

SafeFrame

Legado:

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

Novo:

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

Segmentação

Legado:

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

Novo:

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

Anúncios em vídeo

Legado:

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

Novo:

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

Definir a configuração no nível do espaço

A tabela a seguir mapeia os métodos de configuração legados do Slot para as substituições do setConfig.

Recurso	Método legado	Substituição de `setConfig`
Atributos do AdSense	`set(key, value)`	`Slot.setConfig({ adsenseAttributes: { [key]: value } })`
Exclusão de categorias	`clearCategoryExclusions()`	`Slot.setConfig({ categoryExclusion: null })`
Exclusão de categorias	`setCategoryExclusion(label)`	`Slot.setConfig({ categoryExclusion: [label] })`
URL de clique	`setClickUrl(url)`	`Slot.setConfig({ clickUrl: url })`
Recolher divs vazias	`setCollapseEmptyDiv(collapse, collapseBeforeFetch)`	`Slot.setConfig({ collapseDiv: collapse ? (collapseBeforeFetch ? 'BEFORE_FETCH' : 'ON_NO_FILL') : 'DISABLED' })`
SafeFrame	`setForceSafeFrame(force)`	`Slot.setConfig({ safeFrame: { forceSafeFrame: force } })`
SafeFrame	`setSafeFrameConfig(config)`	`Slot.setConfig({ safeFrame: config })`
Segmentação	`clearTargeting(key)`	`Slot.setConfig({ targeting: { [key]: null } })`
	`setTargeting(key, value)`	`Slot.setConfig({ targeting: { [key]: value } })`
	`updateTargetingFromMap(config)`	`Slot.setConfig({ targeting: config })`

Legado:

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

Novo:

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

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

Exclusão de categorias

Legado:

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

Novo:

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

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

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

Clique em URL

Legado:

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

Novo:

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

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

Recolher div vazia

Legado:

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

Novo:

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

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

SafeFrame

Legado:

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

Novo:

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

Segmentação

Legado:

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

Novo:

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']
  }
})

Receber configuração no nível da página

A tabela a seguir mapeia métodos getter legados do PubAdsService para as substituições do getConfig.

Recurso	Método legado	Substituição de `setConfig`
Atributos do AdSense	`get(key)`	`googletag.getConfig('adsenseAttributes')`
Atributos do AdSense	`getAttributeKeys()`	`googletag.getConfig('adsenseAttributes')`
Carregamento inicial	`isInitialLoadDisabled()`	`googletag.getConfig('disableInitialLoad')`
Segmentação	`getTargeting(key)`	`googletag.getConfig('targeting')`
Segmentação	`getTargetingKeys()`	`googletag.getConfig('targeting')`

Legado:

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

Novo:

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

Carregamento inicial

Legado:

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

Novo:

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

Segmentação

Legado:

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

Novo:

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

Receber configuração no nível do espaço

A tabela a seguir mapeia métodos getter legados de Slot para as substituições de getConfig.

Recurso	Método legado	Substituição de `setConfig`
Atributos do AdSense	`get(key)`	`Slot.getConfig('adsenseAttributes')`
Atributos do AdSense	`getAttributeKeys()`	`Slot.getConfig('adsenseAttributes')`
Exclusão de categorias	`getCategoryExclusions()`	`Slot.getConfig('categoryExclusion')`
Segmentação	`getTargeting(key)`	`Slot.getConfig('targeting')`
Segmentação	`getTargetingKeys()`	`Slot.getConfig('targeting')`

Legado:

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

Novo:

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.
const adsenseAttributes = Object.keys(adsenseConfig);

Exclusão de categorias

Legado:

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

Novo:

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

Segmentação

Legado:

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

Novo:

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

Migração da API Config Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Definir a configuração no nível da página

Atributos do AdSense

Exclusão de categorias

Centralização

Recolher divs vazias

Carga inicial e arquitetura de solicitação única (SRA)

Carregamento lento

Local

SafeFrame

Segmentação

Anúncios em vídeo

Definir a configuração no nível do espaço

Atributos do AdSense

Exclusão de categorias

Clique em URL

Recolher div vazia

SafeFrame

Segmentação

Receber configuração no nível da página

Atributos do AdSense

Carregamento inicial

Segmentação

Receber configuração no nível do espaço

Atributos do AdSense

Exclusão de categorias

Segmentação

Migração da API Config