Popis odezev SSP serveru

Požadavek na SSP server se posílá metodou POST. Tělo požadavku je tvořeno JSON strukturou. Odpověď SSP serveru je rovněž JSON struktura sestávající z následujících položek:

Název	Hodnota	Popis
ads	Array	Pole bannerů pro jednotlivé pozice v pořadí, jak o ně bylo požádáno
ads : data	String	Data banneru
ads : type	String : ["iframe_url", "iframe", "code", "code_url", "vast", "vast_url", "json", "json_url", "native", "native_url", "empty", "error"]	Typ dat banneru
ads : width	Number	Šířka vydaného banneru
ads : height	Number	Výška vydaného banneru
ads : responsive	Boolean	Určuje, zda se baner umí přizpůsobovat obalujícímu HTML elementu a jeho rozměrům
ads : dbgInfo	Object	Debug informace z DSP
ads : zoneId	Number	ID vydaného banneru
ads : dsp	String	Název DSP (SKLIK, PUBMATIC, APPNEXUS…)
ads : ttl	Number	Počet sekund, kdy je daná URL s reklamou platná. Při vykreslování reklamy vlastním callbackem je potřeba tuto hodnotu zohledňovat.
ads : tracking	Object	Obsahuje URL všech měřicích kódů
ads : tracking : served	Array	Pole impresních a miss URL
ads : tracking : visible	Array	Pole visibilních URL

ads

Pole všech reklam z SSP serveru

data

Obsahuje řetězec dat reklamy. V řetězci může být obsaženo:

• iframe_url – odkaz na kompletní HTML stránku, lze umístit přímo do iframe atributu src
• iframe – zdrojový HTML kód reklamy, lze vypsat do iframe se src atributem https://ssp.im.cz/static/html/[hostname]/reklama.html?url=[href]
• code – zdrojový HTML kód reklamy, lze vypsat přímo do stránky
• code_url – odkaz, na kterém je dostupný zdrojový HTML kód reklamy
• vast – textový řetězec, který reprezentuje reklamu ve VAST XML, lze parsovat jako XML dokument
• vast_url – odkaz, na kterém je dostupná reklama ve formě VAST dokumentu
• json – textový řetězec, který reprezentuje reklamu v JSON struktuře, lze parsovat jako JSON objekt pomocí JSON.parse
• json_url – odkaz, na kterém se nachází reklama v JSON struktuře
• native - IAB Native Ads API formát
• native_url - odkaz, na IAB Native Ads API formát
• empty – reklama nedorazila
• error – došlo k chybě při výdeji reklamy

width

Šířka banneru, jak ji zná SSP server.

height

Výška banneru, jak ji zná SSP server.

responsive

Flag označující, zda se reklama umí plně přizpůsobit HTML elementu, do kterého je vložena. Pokud je flag false, výdejový SSP skript automaticky zmenšuje kreativu tak, aby se do elementu vešla (pomocí CSS vlastnosti transform: scale).

dbgInfo

Debug informace ze SSP serveru pro interní použití.

dbgInfo : error

Chybové hlášení SSP.

Text chybové hlášky v dbg.error	Popis chyby / možnosti opravy
At least one dimension is required.	V požadavku je třeba uvést hodnotu alespoň jednoho z parametrů width / height.
At least one dimension is invalid.	Hodnota parametrů width a height v požadavku musí být kladné celé číslo.
No format is available for requested dimensions.	Neexistuje formát, jehož rozměry by byly menší nebo rovné hodnotám parametrů width a height v požadavku.
'zoneId' value is required.	V požadavku je třeba uvést hodnotu parametru 'zoneId'.
'zoneId' value is invalid.	Hodnota parametru 'zoneId' v požadavku musí být kladné celé číslo.
Unsupported zone type.	V případě dotazu na VAST rozhraní musí být zóna typu instream.
Unsupported zone delivery type.	V případě dotazu na VAST rozhraní musí mít zóna typ výdeje nastavený na VAST.
Zones belong to different webs.	Zóny v jednom požadavku musí být vytvořené pod shodným webem (pod jedním 'webId').
No zones specified in the request.	V požadavku je třeba uvést parametry a jejich hodnoty alespoň pro jednu zónu.
Zone with given 'zoneId' value does not exist.	Zóna se 'zoneId' uvedeným v požadavku neexistuje.
Zone belongs to a banned partner account.	Účet, pod který zóna spadá, byl zamítnut – kontaktujte sklik@firma.seznam.cz.
Zone belongs to an automatically stopped partner account.	Účet, pod který zóna spadá, byl automaticky pozastaven – přihlaste se do Klientské zóny a proveďte autorizaci svého účtu.
Zone belongs to a web not yet approved.	Účet, pod který zóna spadá, čeká na schválení – pokud není nově založený, kontaktujte sklik@firma.seznam.cz.
Zone belongs to an inactive web.	Web, pod který zóna spadá, je neaktivní – změnu stavu na aktivní můžete provést v SSP rozhraní.
Zone is inactive.	Zóna je neaktivní – změnu stavu na aktivní můžete provést v SSP rozhraní.
Given URL does not match URL of a web the zone belongs to.	Zóna je umístěna na webu, pro který nebyla vytvořena – upravte URL webu v SSP rozhraní, nebo vytvořte nový web a zónu.
Requested source is not allowed on zone.	Pro tuto zónu není povolen požadovaný zdroj návštěvy.

zoneId

ID zóny, do které se reklama vydává.

dsp

Jméno DSP, používá se pro šablony.

tracking : served

Pole impressních a miss URL, pomocí kterých se měří počet vykreslení či nevydání reklamy do stránky. Je potřeba na všechny tyto URL provést hit (například vytvořením elementu img, kde URL použijeme jako hodnotu atributu src).

tracking : visible

Pole visibilních URL, pomocí kterých se měří počet zobrazení reklamy uživatelům (tedy situace, kdy se reklama nachází ve viewportu). Je potřeba na všechny tyto URL provést hit (například vytvořením elementu img, kde URL použijeme jako hodnotu atributu src). Visibilitu měří SSP automaticky, pokud je zadáno v konfiguraci pozice id elementu. Visibilita je měřena podle IAB standardu.

Příklad odpovědi SSP serveru

// příklad odezvy SSP serveru
{ "ads" : [
// pole dat k reklamním pozicím
     {
        "data" : "//sssp.cz/dataurl", // pokud reklama není, bude hodnotou prázdný řetězec
        "type" : "url", // pokud reklama není, bude empty
        "width" : 300,
        "height" : 300,
        "responsive" : false,
        "tracking" : {
            "served" : ["//sssp.cz/impress?1234"],
            "visible" : ["//sssp.cz/visibility?1234"]
        },
        "dbgInfo" : {}, // informace z DSP (id a další údaje dodané DSP)
        "zoneId" : 123
      }
   ]
}