Brand Catalog API
API (Application Programming Interface) is an agreed way of communication between the client (who wants to access certain data) and the server (that provides such data).
Brand Catalog API has been created specifically for fetching details on active Commerce Media campaigns. It is recommended to poll the API periodically (at least once every hour) in order to keep the most recent information about brand demand available on the Zeropark platform.
Required parameters:
Warning
Please contact Zeropark’s Publisher Team to get the authentication parameters. They are required to execute calls to Brand Catalog API.
api_tokendomainer_idfeed_id(specifies the unique publisher feed, from which the listed campaigns are willing to buy traffic)
Endpoint/Feed request:
Brand Catalog API can be accessed under the address specified below:
https://catalog.zeropark.com/api/catalog/<feed_id>?token=<api_token>&did=<domainer_id>
It accepts GET calls/requests and requires providing the required parameters.
Brand Catalog API response fields
Once the request is authenticated, a response in JSON format with a list of entries with the following fields will be returned.
{
“campaignId”: UUID,
“brandName”: String,
“brandCategory”: String,
“iconUrl”: String,
“brandUrl”: String,
“campaignBid”: BigDecimal,
“campaignDailyBudget”: BigDecimal,
“campaignTotalBudget”: BigDecimal,
“country”: String,
“mobileOsTargeting”: List<String>,
“desktopOsTargeting”: List<String>,
“mobileBrowserTargeting”: List<String>,
“desktopBrowserTargeting”: List<String>,
“frequencyFilter”: int,
“dayParting”: Map<String, Set<Integer>>
“state”: String,
“resumeDate”: Date
“category”: String,
}In case of providing invalid api_token or domainer_id an error response with 403 status code is returned.
In case of providing invalid feed_id (in particular the id of non-existent feed), an error response with 400 status code is returned.
Response Field description:
campaignId — a unique ID assigned to each campaign.
brandName — the name of the brand for which the campaign has been created.
brandCategory — the category classification assigned by SimilarWeb, ex: “Finance/Investing”
iconUrl — URL address under which the icon for a particular campaign can be previewed. This URL will always be compliant with the following pattern and does not require any authentication:
https://catalog.zeropark.com/api/search-tile/<icon_uuid>brandUrl — address of the brand homepage.
campaignBid — CPC with precision to five decimal places expressed in USD.
campaignDailyBudget — daily budget of the campaign with precision to two decimal places. 0.00 means UNLIMITED budget.
campaignTotalBudget — total budget of the campaign with precision to two decimal places. 0.00 means UNLIMITED budget.
country — 2 letter country code based on configured geo-targeting.
mobileOsTargeting — list of targeted mobile operating systems. Empty for campaigns targeting only desktop devices. A list of all available operating systems is available in the Targeting section below.
desktopOsTargeting — list of targeted desktop operating systems. Empty for campaigns targeting only mobile devices. A list of all available operating systems is available in the Targeting section below.
mobileBrowserTargeting — list of targeted mobile browsers. Empty for campaigns targeting only desktop devices. A list of all available browsers is available in the Targeting section below.
desktopBrowserTargeting — list of targeted desktop browsers. Empty for campaigns targeting only mobile devices. A list of all available browsers is available in the Targeting section.
frequencyFilter — int value describing how often an ad can be displayed to the same visitor. Possible values are 0, 5, 15, 30, 60, 180, 360, 720 and 1440 minutes.
dayParting — map of days and hours in which campaign is active (in UTC). Possible keys are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY and values are represented as ints between 0 and 23.
state - current campaign status, can be one of the following:
ACTIVE,
INACTIVE_OUT_OF_BUDGET,
INACTIVE_OUT_OF_DAILY_BUDGET,
INACTIVE_DAY_PARTING
resumeDate — value which is present only for campaigns that are inactive due to dayparting or reaching the daily budget limit. It indicates when the campaign is about to be active again (in UTC).
category — campaign’s classification assigned by the Zeropark team.
Targeting:
Field | Possible values |
|---|---|
mobileOSTargeting | IOS_PHONE, IOS_TABLET, ANDROID_PHONE, ANDROID_TABLET, OTHER |
desktopOsTargeting | WINDOWS, MACOS, LINUX, OTHER |
mobileBrowserTargeting | FACEBOOK, FIREFOX, CHROME, SAFARI, OPERA, UC_BROWSER, ANDROID, SAMSUNG, OTHER |
desktopBrowserTargeting | IE, FIREFOX, CHROME, SAFARI, EDGE, OTHER |
Brand Catalog API Response Example:
[
{
"campaignId":"10d62fa2-7c12-11eb-a624-0a4121f90dcd",
"brandName":"Qatarairways",
"brandCategory":"Travel_and_Tourism/Air_Travel",
"iconUrl":"https://catalog.zeropark.com/api/search-tile/1eb034d1-7da6-4094-b108-9a668a684fe1",
"brandUrl":"qatarairways.com",
"campaignBid":0.08000,
"campaignDailyBudget":5.00,
"campaignTotalBudget":0.00,
"country":"RU",
"category":"E-commerce",
"mobileOsTargeting":[
"OTHER",
"ANDROID_PHONE",
"ANDROID_TABLET",
"IOS_PHONE",
"IOS_TABLET" ],
"desktopOsTargeting":[
"WINDOWS",
"MACOS",
"LINUX",
"OTHER" ],
"mobileBrowserTargeting":[
"FACEBOOK",
"FIREFOX",
"CHROME",
"SAFARI",
"OPERA",
"UC_BROWSER",
"ANDROID",
"OTHER",
"SAMSUNG" ],
"desktopBrowserTargeting":[
"IE",
"FIREFOX",
"CHROME",
"SAFARI",
"OTHER",
"EDGE" ],
"frequencyFilter":30,
"dayParting":{
"SUNDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"MONDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"THURSDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"FRIDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"SATURDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"TUESDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"WEDNESDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ]
},
"state":"ACTIVE"
},
{
"campaignId":"34eda750-139f-11eb-9f99-0a52992aaad9",
"brandName":"etoro",
"brandCategory":"Finance/Investing",
"iconUrl":"https://catalog.zeropark.com/api/search-tile/20aebe88-d185-4a48-8651-c38657525129",
"brandUrl":"etoro.com",
"campaignBid":0.40000,
"campaignDailyBudget":20.00,
"campaignTotalBudget":0.00,
"country":"RU",
"category":"Binary and trading",
"mobileOsTargeting":[
"OTHER",
"ANDROID_PHONE",
"ANDROID_TABLET",
"IOS_PHONE",
"IOS_TABLET" ],
"desktopOsTargeting":[
"WINDOWS",
"MACOS",
"LINUX",
"OTHER" ],
"mobileBrowserTargeting":[
"FACEBOOK",
"FIREFOX",
"CHROME",
"SAFARI",
"OPERA",
"UC_BROWSER",
"ANDROID",
"OTHER",
"SAMSUNG" ],
"desktopBrowserTargeting":[
"IE",
"FIREFOX",
"CHROME",
"SAFARI",
"OTHER",
"EDGE" ],
"frequencyFilter":1440,
"dayParting":{
"SUNDAY":[[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"MONDAY":[[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"THURSDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"FRIDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"SATURDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"TUESDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ],
"WEDNESDAY":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 ] },
"state":"ACTIVE"
}
]