Creating a Campaign Request - Example API Code for DISPL Ads
Here is an example JSON payload for creating an advertising campaign request. This request is sent via a POST method to the endpoint: https://api.dooh.one/api/v2/agency/<dsp_agency_id>/dsp/request/.
{
"name": "Test Campaign 1",
"description": "Optional description of the campaign",
"platform": 6,
"industry": {
"version": 2,
"id": "248"
},
"start_date": "2021-03-01",
"end_date": "2021-03-09",
"time_range": [43200, 86399],
"schedule": {
"mon": true,
"tue": false,
"wed": true,
"thu": false,
"fri": true,
"sat": false,
"sun": true
},
"ad_duration": 10,
"ad_rate_per_hour": 12,
"payment_model": "cpv",
"payment_model_limit": 1000,
"areas": [
{
"title": "Moscow, Russia",
"action": "include",
"latitude": 55.75583,
"longitude": 37.61778,
"radius": 100
}
],
"age": [18, 65],
"gender": "female",
"resolutions": ["1920x1080"],
"budget": 1000000,
"max_bid": 7.5
}
Key Parameter Details:
name: The name of the campaign, maximum 128 characters.
platform: The unique ID of the advertising network.
industry: Categorizes the campaign using IAB Content Category Taxonomy (Version 1.0 or 2.0).
start_date / end_date: The active dates for the campaign in YYYY-MM-DD format.
time_range: The daily window for ad display, defined in seconds from the start of the day (e.g.,
[43200, 50400]for 12:00 PM to 2:00 PM).schedule: A JSON object specifying which days of the week the ads should be shown.
payment_model: Supports
ad_plays(impressions),cpm(reach), orcpv(guaranteed views).areas: A list of geographic zones to either
includeorexcludebased on latitude, longitude, and a radius in kilometers.max_bid: The maximum price the DSP is willing to pay. For
ad_plays, this is the cost per 1,000 displays; forcpv, it is the cost per single guaranteed view.
Comments
0 comments
Please sign in to leave a comment.