Description: You can create an advertising campaign via API for your HilltopAds advertising account.
Please note that this method is available only for the formats Popundermobile and Popunderdesktop.
Parameters:
name
description
example
comment
key
A unique API key that you can generate in the API section of your HilltopAds account
nXzgO3Bc
This is a required parameter in the request.
format
Advertising format for which the campaign needs to be created.
Popunder mobile
You can specify only one advertising format.
This is a required parameter in the request.
rate
Price for 1000 impressions (CPM).
1.53
All prices (rate) are specified in the request without currency, but will be set in USD in the result.
This is a required parameter in the request.
capTotal
Impression frequency cap. This parameter indicates the number of times an ad is shown.
2
You can specify only one number.
capResetAfter
Impression frequency cap. This parameter indicates how long to show the ad.
12
You can specify only one number.
capForCampaign
Impression frequency cap. This parameter indicates whether the rule applies to the campaign or the banner.
campaign
For the Popunder format, you can only specify campaign.
channels
Segment and traffic category for which the ad needs to be launched.
Mainstream/non-mainstream High activity
Mainstream/non-mainstream Medium activity
Mainstream/non-mainstream Low activity
To specify multiple activity segments, list them with commas. Note, you can only specify one traffic category - mainstream or non-mainstream.
This is a required parameter in the request.
type
Type of an ad campaign
CPM, CPC
Please note, currently you can only specify CPM campaign type.
This is a required parameter in the request.
name
Name of an advertising campaign.
Popunder_API
The campaign name must be unique and not repeated with names of already created campaigns.
This is a required parameter in the request.
url
Offer URL link where the traffic needs to be sent.
https://mywebsite.com
You can specify only one link.
This is a required parameter in the request.
active
Specify the status of the created campaign: true - ON, false - OFF.
True, false
When specifying the campaign status as True (ON), the campaign will become active only after moderation.
targeting
Required targeting settings for the advertising campaign.
geo
browser
os
device
mobilecarrier
iprange
osversions
App
These parameters are passed as an object. Each new targeting parameter is specified with a comma.
Request Example:
To create an advertising campaign with the following parameters:
Ad format - Popunder mobile
Rate - $1.53
Frequency cappings - 2 display per 12 hours for campaign
Channels - mainstream high activity и medium activity
Type - CPM (for a Popunder ad format you can specify only CPM)
Name - Popunder_API
URL - https://mywebsite.com.
Please note that if your link contains the '&' symbol, you need to encode it to URL-encoded format. Otherwise, you may receive an error in the response to the link change request.
For example, the link https://mywebsite.com/?token={{ctoken}}&zone={{zone_id}} should be specified as https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%7B%7Bctoken%7D%7D%26zone%3D%7B%7Bzone_id%7D%7D
To encode your link to URL-encoded format, you can use the tool
You need to write a request in the following format:
curl -X POST --data '{"format":"Popunder mobile","channels":["Mainstream High Activity", "Mainstream Medium Activity"],"type":"CPM","rate":1.53,"name":"Popunder_API","url":"https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%7B%7Bctoken%7D%7D%26zone%3D%7B%7Bzone_id%7D%7D","active":true,"capTotal":2,"capResetAfter":12,"capForCampaign":"campaign","targeting":{"geo":{"operator":"in","operand":["US","UK","DE"]},"browser":{"operator":"in","operand":["Chrome","Safary"]},"device":{"operator":"in","operand":["Mobile/smartphone"]}}}' https://hilltopads.com/api/v1/advertiser/campaign?key=nXzgO3Bc
