Brand Demand API

Zeropark is able to provide data about current demand, and pricing, and redirect URLs via Brand Demand API designed specifically for fetching details on active Commerce Media Browser Autocomplete campaigns. This API takes into consideration the user's device and geolocation.

Browser Autocomplete Demo

The Browser Autocomplete demo showcases how to implement autocomplete ads on your search page.

Code examples on how to integrate Zeropark’s Autocomplete API with the search page can be found on https://np-search-demo.com/ by clicking on the code example link.

To reproduce how Zeropark autocomplete ads work:

Go to https://np-search-demo.com/
In the search bar enter ‘boo’
View results available based on the user’s device and geolocation.
Click on the ad, the browser redirects users directly to a related website

How to integrate with Browser Autocomplete?

Search web page queries Zeropark at page loading time.
Zeropark provides a JSON response that contains a list of brands that there is demand for. The following data will be provided for every entry:
1. Brand name
2. Brand domain
3. Estimated CPC value
4. Redirect URL
5. Non-branded keywords if exist
The code on the web page side is responsible for matching user input to the brands returned by Zeropark and handles ad display with the best matching
When a user clicks on the ad, they should be redirected to the redirect URL provided in the response. The CPC value will be redirected to the publisher account in the Zeropark platform for that click.
Zeropark demand information is loaded once at the search web page loading phase. It takes into consideration the user's device and geolocation.
Returned CPC value is an estimation because Zeropark is unable to calculate precise demand information at page load time. For most cases, the estimated CPC value should match the calculated CPC when the actual redirect takes place.

Important

Zeropark API will provide you with a list of brands for a given IP address. It is on the publisher's side to filter out the brand queries to find the best match. The algorithm used for that is up to the publisher.

Note

The exemplary algorithm used in Zeropark is fusejs. You can find it in CodePen by searching for 'new Fuse'. The method used is:

getBrandsByQuery

Performance considerations:

Zeropark servers are located in an AWS data center in the North Virginia region.
Zeropark p95 of the query response time counted on the AWS Cloud level will be not greater than 15ms.
The signal propagation time should be added to the Zeropark query processing time. For example, if a user is located in Europe then the ~80 ms time should be added as the time required for a roundtrip call to the AWS data center in the North Virginia region.

Request & response examples:

The demo page is plugged into the production endpoint so the suggestions you see there are what you can expect in real life.

Request to Brand Demand API example:

https://aldeb-zeu.com/catalog/autocomplete-demo?feedid=55aadd60-9d14-11eb-9cc8-0abff1de8e13

Catalog API endpoint:

https://aldeb-zeu.com/catalog/

autocomplete-demo — this is a search page domain or identifier of the domain where the script is located. We strongly recommend passing the full domain here (e.g.: search-page.com)
feedid — this is the identifier of the publisher feed. Please contact your Zeropark Account Manager to receive one.

Brand Demand API Response example:

{   
  "clickUrl": 
"https://aldeb-zeu.com/autocomplete-demo?feedid=55aadd60-9d14-11eb-9cc8-0abff1de8e13&fallbackUrl=https%3A%2F%2F${brand.url}&keywords=${brand.name}",   
   "brands": [
      {         
         "brand": {
            "name": "Roneberg-smart",
            "url": "roneberg-smart.com"
         },
         "eCpc": 0.08,
         "keywords": ""
      },
      {
         "brand": {
            "name": "Myloview",
            "url": "myloview.pl"
         },
         "eCpc": 0.12,
         "keywords": "fototapeta dla dziewczynki,fototapeta ściana z jasnych desek"
      },
      {
         "brand": {
            "name": "Butymodne",
            "url": "butymodne.pl"
         },         
         "eCpc": 0.05,
         "keywords": ""
      }
   ]
}

clickUrl — this is the URL where visitors should be redirected to. The string contains ${brand.name} and ${brand.url} that should be replaced with corresponding brand fields
brand/name — the name of a brand
brand/url — the official brand website
eCpc — this is how much Zeropark pays for a single redirect (in USD)

In this section:

Zeropark Documentation