Advertising Campaign Request Parameters
This table describes the parameters used when creating a draft request for an advertising campaign via POST /agency/<dsp_agency_id>/dsp/request/.
| Parameter | Type | Default | Description |
|---|---|---|---|
| name | String (max 128) | Required | Name of the advertising campaign |
| description | String | Description of the campaign | |
| platform | Integer | Advertising network ID | |
| industry | Object | The category of the campaign. Supports IAB Content Category Taxonomy 1.0 (version 1) and 2.0 (version 2) | |
| advertizer | Integer | Advertiser Company | |
| interests | Array | [] | Interests and activities |
| life_stages | Array | 0 | Standard of living |
| intents | Array | [] | Engagement |
| environments | Array | [] | Environment |
| start_date | Date | Start date in YYYY-MM-DD format | |
| end_date | Date | End date (inclusive) in YYYY-MM-DD format | |
| time_range | Integer Range | [0, 86399] | Daily display period in seconds (e.g., [43200, 50400] for 12:00 to 14:00) |
| schedule | JSON | All days | Days of the week (mon-sun) to show the campaign |
| ad_duration | Integer | 15 | Duration of an advertisement in seconds |
| ad_rate_per_hour | Integer | 60 | Frequency of displaying ads per hour (not more often than) |
| payment_model | String | ad_plays | Payment model variants: |
| payment_model_limit | Integer | 0 | Maximum impressions/contacts/views based on the selected model1 |
| areas | [Area, ...] | List of zones to include or exclude for advertising | |
| age | [Int, Int] | [0, 100] | Age range (CPV model only) |
| gender | String | all | Gender: |
| resolutions | [String, ...] | 0 | Supported screen resolutions (e.g., ["1920x1080"]) |
| budget | Decimal | 0 | Total campaign budget |
| max_bid | Decimal | 0 | Maximum bid based on the payment model |
Comments
0 comments
Please sign in to leave a comment.