Documentation
API
Emission
Sponsored Products — deprecated

Sponsored Products — deprecated

Integration via API /v1/dsa/raw — deprecated

⚠️
Described here is an old API that does not support querying multiple ad units at once and causes issues when passing a list of category paths containing commas. We recommend using the API /v1/dsa/raw/batch.

In the integration model via AdsHero API, AdsHero is solely responsible for selecting ads. Their rendering is performed by the service querying AdsHero for ads.

A basic request for ads (emission request) looks like this:

GET https://dispatcher.ahevds.com/v1/dsa/raw/{slotHash}/{adCount} HTTP/2
cid: {cid}
uid: {uid}
curl --location --request GET 'https://dispatcher.ahevds.com/v1/dsa/raw/{slotHash}/{adCount}' \
     --header 'cid: {cid}' \
     --header 'uid: {uid}'
  • slotHash is the identifier of the ad unit available in the publisher’s (shop’s) panel on the ad units list (menu “Slots”).
  • adCount is the maximum number of ads to be returned.

All additional parameters are passed as “query parameters”, i.e. URL parameters in the form key=value provided after the ? sign and separated by the & sign.

Available parameters:

NameDescriptionExample value
searchDataSearch phrase.karma dla kota
excludeShopProductsIdsList of product IDs to exclude.BAM-SWA-BLA-MIN
priceMinFilter on the minimum price.1.23
priceMaxFilter on the maximum price.12.3
currencyPage currency.PLN
brandProduct brand.Fun with Mum
productTitleProduct title.Kocyk Bambusowy - Mint
categoriesList of category IDs.113
categoryPathsList of category paths.Kocyki > Kocyki Dziane > Kocyk Bambusowy
shopProductIdProduct ID in the context of which the ad is rendered.BAM-SWA-BLA-MIN
attributesAdditional attributes. Description below.[{"name":"color","value":"red"}]
adTypeAllows limiting ad selection to only autopromo or only sponsored offers.ALL

If we pass more than one value for a given parameter, the parameter should be passed multiple times, e.g., categories=113&categories=114.

attributes parameter

attributes serve to further filter/limit products. The values of these parameters do not affect the quality of offer matching: they only guarantee that only offers that have the given attribute values will be returned.

Each attribute is accepted in the form:

{
  "name": "name",
  "value": "value"
}

All attributes should be passed as a text array in JSON, i.e., [{"name": "color", "value": "red"}].

name is the attribute’s name, and value is its value.

We accept attributes (from the feed):

  • adult
  • age_group
  • color
  • energy_efficiency_class
  • gender
  • google_product_category
  • gtin
  • material
  • mpn
  • pattern
  • size
  • unit_pricing_measure

And all attributes provided in product_detail.

Algorithms