DFP Small Business

Rozhranie API na konfiguráciu služby obsahu DFP. Služba obsahu vám umožňuje ovládať reklamný priestor a pred odoslaním žiadosti o sprievodnú reklamu v ňom zobraziť iné reklamy.

setContent(priestor, obsah)

Vyplniť priestor daným obsahom. Ak priestor ešte nebol vykreslený (alebo k nemu nie je priradený žiadny prvok div), obsah sa uloží a priestor sa vyplní až pri vytvorení prvku div.

Rozhranie API na konfiguráciu konkrétneho reklamného priestoru na stránke.

addService(služba)

Pridá reklamný priestor do uvedenej služby značky Google.

set(kľúč, hodnota)

Nastaví hodnoty parametrov AdSense pri konkrétnom reklamnom priestore.

setClickUrl(url)

Nastaví adresu URL presmerovania pre kliknutie na reklamu v konkrétnom priestore. Servery služby DoubleClick zaznamenajú kliknutie aj v prípade, že adresu URL kliknutia nahradíte, ale dôjde k nahradeniu akejkoľvek adresy URL vstupnej stránky priradenej k zobrazovanej kreatíve.

setTargeting(kľúč, hodnota)

Nastaví hodnoty kľúčov zacielenia pre konkrétny reklamný priestor.

Rozhranie API pre zaradenie volaní funkcie v značke GPT na spustenie, až budú volania pripravené.

push(JsFunction)

Funkcia JsFunction bude zaradená do poradia na spustenie po načítaní skriptu gpt.js.

Vracia odkaz na službu sprievodných reklám.

Vracia:

companionAdsService – odkaz na službu sprievodných reklám.

content

Vracia odkaz na službu obsahu.

Vracia:

contentService – odkaz na službu obsahu.

defineOutOfPageSlot

googletag.defineOutOfPageSlot(názovJednotky, divId)

Vytvorí reklamný priestor mimo stránky (intersticiálny) s daným názvom reklamnej jednotky. Parameter divId predstavuje ID prvku div, ktorý bude obsahovať reklamu.

Parametre:

string názovJednotky– úplná cesta reklamnej jednotky s kódom siete a názvom jednotky.

string divId– ID prvku div s reklamou určené vlastníkom.

Vracia:

adSlot– novo vytvorený reklamný priestor.

Príklad:

// Reklamná jednotka = "/kódSiete/názovJednotky"
googletag.defineOutOfPageSlot("1234567/outofpage", "div-gpt-ad-1");

definePassback

googletag.pubads().definePassback(názovJednotky, veľkosť)

Ak pri volaní tohto príkazu zo značky reklamy služby DFP poskytnutej reklamnému serveru tretej strany nie je na tomto serveri k dispozícii žiadna vyhovujúca reklama, pošle späť značku reklamy.

Parametre:

string názovJednotky– úplná cesta reklamnej jednotky s kódom siete a názvom jednotky.

number veľkosť– šírka a výška reklamnej jednotky v zátvorkách oddelená čiarkou.

Vracia:

passbackSlot– novo vytvorený reklamný priestor.

Príklad:

// Reklamná jednotka = "/kódSiete/názovJednotky"; veľkosť= [šírka, výška]
googletag.pubads().definePassback("/1234567/leaderboard", [728, 90]);

defineSlot

Vytvorí reklamný priestor so zadaným názvom a veľkosťou reklamnej jednotky a priradí ho k ID prvku div na stránke, ktorý bude reklamu obsahovať.

Parametre:

string názovJednotky – úplná cesta reklamnej jednotky s kódom siete a názvom jednotky.

number veľkosť – šírka a výška reklamnej jednotky v zátvorkách oddelená čiarkou. Pomocou nasledujúcej syntaxe môžete zadať viacero veľkostí: [[šírka1, výška1], [šírka2, výška2]]

string divId – ID prvku div obsahujúceho reklamu určené vlastníkom.

Vracia:

adSlot – novo vytvorený reklamný priestor.

Príklad:

// Reklamná jednotka = "/kódSiete/názovJednotky"; veľkosti= [[šírka1, výška1], [šírka2, výška2]]
googletag.defineSlot("/1234567/leaderboard", [[468, 60], [728, 90]], "div-1");

disablePublisherConsole

Zakáže službu Google Publisher Console.

display

Označuje, kde na stránke sa má zobraziť obsah reklamného priestoru. Každý reklamný priestor by sa mal na stránke zobraziť len raz. Pred zobrazením musia byť všetky priestory určené a musí k nim byť priradená služba. Volanie funkcie display musí byť v bloku skriptu uvedené v prvku div, ktorý je uvedený pri volaní tejto funkcie. (toto obmedzenie sa vyžaduje kvôli plynulej podpore režimu synchrónneho vykresľovania reklám).

Parametre:

string divId – ID prvku div, ktorý obsahuje reklamný priestor.

Príklad:

<div id="div-gpt-ad-1" style="width: 728px; height: 90px">
<script type="text/javascript">
  googletag.cmd.push(function() {googletag.display("div-gpt-ad-1")});
</script>
</div>

enableServices

Povolí všetky služby značky vlastníka Google (GPT), ktoré boli pre reklamné priestory na stránke určené. Táto funkcia je na každej stránke potrebná len raz. Ak je však uvedená niekoľkokrát, nespôsobí to žiadne problémy.

pubads

Vracia odkaz na reklamnú službu vlastníka.

Vracia:

pubService – odkaz na reklamnú službu vlastníka.

collapseEmptyDivs

Zbalí prázdne prvky div na stránke, pokiaľ nie je k dispozícii žiadny reklamný obsah, ktorý by bolo možné zobraziť. Aby táto metóda fungovala, je nutné ju zavolať pred metódou enableServices().

disableInitialLoad

Zakáže úvodné načítanie reklám zo služby Google pri prvom načítaní stránky. Reklamy je možné aj naďalej načítať volaním metódy refresh().

display

Vytvorí reklamný priestor so zadanými parametrami a priradí ho k službe vlastníka stránok. Táto metóda je ekvivalentná volaniu metódy defineSlot() s následným volaním metódy addService(pubads). Upozornenie: Pomocou tejto metódy nie je možné použiť režim jednej žiadosti.

Parametre:

string názovJednotky – úplná cesta reklamného priestoru s kódom siete a názvom jednotky.

string veľkosť – šírka a výška jednotky v hranatých zátvorkách oddelené čiarkou.

string divId – ID prvku div obsahujúceho reklamu určené vlastníkom.

Príklad:

// Reklamná jednotka = "/kódSiete/názovJednotky"; veľkosť= [šírka, výška]

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

enableAsyncRendering

Prikazuje reklamnej službe vlastníka použiť asynchrónny režim vykresľovania. Pri asynchrónnom vykresľovaní sa žiadosti o reklamy odosielajú pomocou prvkov iframe v doméne vlastníka (priateľské prvky iframe) a reakcia sa zapisuje do ďalšieho priateľského prvku iframe. Keďže sa asynchrónne vykresľovanie používa v predvolenom nastavení, vlastníci potrebujú túto metódu spustiť iba s cieľom prepísania predchádzajúceho nastavenia. Túto metódu je nutné (tak ako v prípade väčšiny nastavení na úrovni služby) zavolať pred povolením služby.

enableSingleRequest

Prikazuje reklamnej službe vlastníka odoslať pri načítaní obsahu pre niekoľko reklamných priestorov iba jednu žiadosť. Túto metódu je nutné zavolať ešte pred povolením služby.

enableSyncRendering

Prikazuje reklamnej službe vlastníka použiť synchrónny režim vykresľovania. Pri synchrónnom vykresľovaní sa žiadosti o reklamy aj vykreslenia odpovedí uskutočnia priamo na stránke vlastníka a navzájom sa blokujú. Tento režim môže zvýšiť latenciu stránky, ale umožňuje použiť určité typy kreatív, ktoré nie je možné použiť v prvkoch iframe. Túto metódu treba zavolať ešte pred povolením služby. Synchrónne vykresľovanie tiež vyžaduje synchrónne načítanie kódu JavaScript značky GPT.

noFetch

Spracuje JavaScript, ale neuskutoční žiadne volania protokolu HTTP s cieľom načítania obsahu reklamných priestorov.

refresh

Obnoví uvedené pole priestorov na stránke a zobrazí v nich nové reklamy.

Parametre:

array priestory – voliteľné pole priestorov, ktoré sa majú obnoviť. Ak tento parameter nezadáte, obnovia sa všetky priestory.

Príklad:

var priestor1 = googletag.defineUnit("/1234567/leaderboard", [728, 90], "div-1").addService(googletag.pubads());
var priestor2 = googletag.defineUnit("/1234567/skyscraper", [160, 600], "div-2").addService(googletag.pubads());

// Volanie s cieľom obnovenia načíta novú reklamu pre každý priestor
googletag.pubads().refresh([priestor1, priestor2]);

set

Nastaví hodnoty parametrov AdSense, ktoré sa použijú na všetky reklamné priestory v reklamnej službe vlastníka. Ak túto metódu zavoláte pre ten istý kľúč viackrát, dôjde k prepísaniu predtým nastavených hodnôt pre daný kľúč. Všetky hodnoty musia byť nastavené pred prvým volaním metódy display.

Parametre:

string kľúč – názov kľúča parametra, pre ktorý chcete nastaviť hodnotu.

string hodnota – hodnota kľúča.

Príklad:

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

Dostupné kľúče:

Nový parameter	Pôvodný parameter	Príklad	Povolené hodnoty
adsense_channel_ids	google_ad_channel	271828183+314159265	platné ID kanálov AdSense oddelené znakom „+“
adsense_ad_types	google_ad_type	text_image	text, image, text_image
adsense_ad_format	google_ad_format	250x250_as	468x60_as, 234x60_as, 125x125_as, 120x600_as, 160x600_as, 180x150_as, 120x240_as, 200x200_as, 250x250_as, 300x250_as, 336x280_as, 728x90_as
adsense_background_color	google_color_bg	#000000	šestnástkové hodnoty farieb
adsense_border_color	google_color_border	#000000	šestnástkové hodnoty farieb
adsense_link_color	google_color_link	#000000	šestnástkové hodnoty farieb
adsense_text_color	google_color_text	#000000	šestnástkové hodnoty farieb
adsense_url_color	google_color_url	#000000	šestnástkové hodnoty farieb
adsense_ui_features	google_ui_features	rc:10	rc:10 pre veľmi zaoblené rohy, rc:6 pre mierne zaoblené rohy, rc:0 pre hranaté rohy (predvolené)

setTargeting

Nastaví hodnoty kľúčov zacielenia, ktoré sa použijú pre všetky reklamné priestory pubService. Tieto kľúče definuje administrátor v aplikácii DFP. Ak túto funkciu zavoláte pre ten istý kľúč viackrát, dôjde k nahradeniu predtým nastavených hodnôt pre daný kľúč. Všetky hodnoty musia byť nastavené pred akýmkoľvek volaním metódy display.

Parametre:

string kľúč – názov kľúča parametra, pre ktorý chcete nastaviť hodnotu.

string hodnota – hodnota kľúča.

Príklad:

// príklad s jednou hodnotou kľúča
googletag.pubads().setTargeting("záujmy", "šport");

// príklad s viacerými hodnotami pre jeden kľúč v hranatých zátvorkách
googletag.pubads().setTargeting("záujmy", ["šport","hudba","filmy"]);

enableSyncLoading

Povolí synchrónne načítanie implementácie služby. Túto metódu je nutné (tak ako v prípade väčšiny nastavení na úrovni služby) zavolať pred povolením služby.

setRefreshUnfilledSlots

Povolí alebo zakáže automatické obnovovanie sprievodných priestorov, ktoré neboli vyplnené.

Parametre:

boolean hodnota – hodnota True povolí automatickú aktualizáciu nevyplnených priestorov.

Príklad:

googletag.companionAds.setRefreshUnfilledSlots(true);

setContent

contentService.setContent(priestor, obsah)

Vyplniť priestor daným obsahom. Ak priestor ešte nebol vykreslený (alebo k nemu nie je priradený žiadny prvok div), obsah sa uloží a priestor sa vyplní až pri vytvorení prvku div.

Parametre:

priestor – priestor, ktorý sa má vyplniť.

string obsah – obsah v jazyku HTML pre daný priestor.

Príklad:

var slot = googletag.defineSlot('/1234567/leaderboard', [728, 90], 'div-1');
var content = '<a href="www.mydestinationsite.com"><img src="www.mysite.com/img.png"></img></a>';
googletag.content().setContent(priestor, obsah);

addService

Pridá reklamný priestor do uvedenej služby značky Google.

Parametre:

pubService služba – odkaz na službu značky vlastníka.

Vracia:

adSlot – reklamný priestor, na ktorý bola funkcia zavolaná.

Príklad:

adSlot.addService(googletag.pubads());

set

Nastaví hodnoty parametrov AdSense pri konkrétnom reklamnom priestore. Táto funkcia nahradí všetky hodnoty nastavené pre tento kľúč na úrovni služby. Zoznam dostupných kľúčov a hodnôt nájdete v tabuľke pre funkciu set uvedenej vyššie. Ak túto funkciu zavoláte pre ten istý kľúč viackrát, dôjde k nahradeniu predtým nastavených hodnôt pre daný kľúč. Všetky hodnoty musia byť nastavené pred akýmkoľvek volaním metódy display.

Parametre:

string kľúč – názov kľúča parametra, pre ktorý chcete nastaviť hodnotu.

string hodnota – hodnota kľúča.

Príklad:

// nastavenie zacielenia pre jeden reklamný priestor
var slot = googletag.defineSlot("/1234567/skyscraper", [160, 600]).addService(googletag.pubads());
slot.set("adsense_background_color", "#FFFFFF");

setClickUrl

Nastaví adresu URL presmerovania pre kliknutie na reklamu v konkrétnom priestore. Servery služby DoubleClick zaznamenajú kliknutie aj v prípade, že adresu URL kliknutia nahradíte, ale dôjde k nahradeniu akejkoľvek adresy URL vstupnej stránky priradenej k zobrazovanej kreatíve.

Parametre:

string url – adresa URL prekliknutia.

Príklad:

googletag.defineSlot("/1234567/skyscraper", [160, 600])
  .setClickUrl("http://www.example.com")
  .addService(googletag.pubads());

setTargeting

Nastaví hodnoty kľúčov zacielenia a parametre priestorov pre konkrétny reklamný priestor. Táto funkcia prepíše všetky hodnoty nastavené pre tento kľúč na úrovni služby. Tieto kľúče definuje administrátor v aplikácii DFP. Ak túto funkciu zavoláte pre ten istý kľúč viackrát, dôjde k nahradeniu predtým nastavených hodnôt pre daný kľúč. Všetky hodnoty musia byť nastavené pred akýmkoľvek volaním metódy display.

Parametre:

string kľúč – názov kľúča parametra, pre ktorý chcete nastaviť hodnotu.

string hodnota – hodnota kľúča.

Príklad:

var slot=googletag.defineSlot("/1234567/skyscraper", [160, 600]).addService(googletag.pubads());

// príklad s jednou hodnotou kľúča
slot.setTargeting("allow_expandable", "true");

// príklad s viacerými hodnotami pre jeden kľúč v hranatých zátvorkách
slot.setTargeting("záujmy", ["šport","hudba","filmy"]);

push

Vlastník v rámci značiek inicializuje premennú googletag.cmd ako prázdne pole (Array) jazyka JavaScript. Funkcia cmd.push je štandardnou funkciou poľa Array.push, ktorá pridá prvok na koniec poľa. Hlavný kód JavaScript značky GPT po načítaní skontroluje pole a spustí všetky funkcie v príslušnom poradí. Skript potom nahradí objekt cmd interným objektom, ktorého funkcia push okamžite spustí funkciu, ktorá sa mu odovzdá ako argument. Tento mechanizmus umožňuje značke GPT znížiť vnímanú latenciu tým, že sa úvodný kód JavaScript načíta asynchrónne, pričom prehliadač môže pokračovať vo vykresľovaní stránky. Ak sa súbor úvodného kódu JavaScript načíta asynchrónne, volanie funkcie cmd.push s definíciou funkcie je ekvivalentné priamemu volaniu danej funkcie.

Príklad:

googletag.cmd.push(function() {
  googletag.defineSlot("/1234567/ca-pub-12345678912/skyscraper", [160, 600]).
       addService(googletag.pubads());
});