kadam_adv_create_campaign
Create a new advertiser campaign by specifying ad format, name, landing page URL, folder, pricing model, bid, daily budget, and targeting options like countries, devices, and more.
Instructions
Create a new advertiser campaign. Required: type, name, url, folderId, pricingModel, bid, dailyBudget.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Ad format | |
| name | Yes | Campaign name shown in dashboard | |
| url | Yes | Landing page URL | |
| folderId | Yes | Campaign folder ID | |
| pricingModel | Yes | Pricing model: cpc, cpm, or cpa_target | |
| bid | Yes | Bid amount in USD (e.g. 0.05). For cpa_target this is the target CPA cost | |
| dailyBudget | Yes | Daily spending limit in USD | |
| countries | Yes | Comma-separated ISO country codes for bid targeting (e.g. 'US,DE,BR'). Required. | |
| devices | No | Comma-separated device names or IDs (e.g. 'Desktop,Smartphone' or '1,4') | |
| os | No | Comma-separated OS names or IDs (e.g. 'Android,iOS' or '10,20') | |
| browsers | No | Comma-separated browser names or IDs (e.g. 'Chrome,Firefox' or '8,16') | |
| languages | No | Comma-separated language names or IDs | |
| connectionType | No | Network connection type filter (all = no filter) | |
| audienceIncludeIds | No | Comma-separated audience IDs to include | |
| audienceExcludeIds | No | Comma-separated audience IDs to exclude | |
| siteWhitelist | No | Comma-separated site IDs for whitelist | |
| siteBlacklist | No | Comma-separated site IDs for blacklist | |
| sspMode | No | SSP source list mode: 'whitelist' = only allow listed SSPs, 'blacklist' = block listed SSPs | |
| sspIds | No | Comma-separated SSP IDs for the source whitelist/blacklist (see ssps in campaign options) | |
| totalBudget | No | Total campaign budget in USD | |
| evenDistribution | No | Spread budget evenly across the day | |
| startDate | No | Start date (YYYY-MM-DD) | |
| endDate | No | End date (YYYY-MM-DD) | |
| timezone | No | Timezone offset in hours (e.g. 3 for UTC+3) | |
| schedule | No | Comma-separated hours (0-23) to show ads, applied to all days (e.g. '9,10,11,12,13,14,15,16,17' for 9am-5pm) | |
| frequencyCapViews | No | Creative-level: max times ONE creative is shown to a user within frequencyCapDays (e.g. 3 = user sees this creative at most 3 times) | |
| frequencyCapDays | No | Creative-level: time window in days for the cap (e.g. 1 = per day, 7 = per week). Used with frequencyCapViews | |
| campaignCapViews | No | Campaign-level: max times ANY creative from this campaign is shown to a user within campaignCapDays (e.g. 1 = one pop per user) | |
| campaignCapDays | No | Campaign-level: time window in days (e.g. 1 = per day). Used with campaignCapViews. Example: campaignCapViews=1, campaignCapDays=1 means 'show campaign to each user max once per day' | |
| impTracker | No | Third-party impression tracking pixel URL | |
| categories | No | Comma-separated category IDs for content classification (e.g. '1,2,3' or 'mainstream,adult'). Multiple values allowed. Use campaign options to see available IDs. | |
| secondPush | No | Enable second push notification (push/inpage_push only) | |
| pauseAfterModeration | No | Pause campaign after creatives pass moderation | |
| conversionTemplateId | No | Conversion acceptance template ID from campaign options (conversionTemplates list). Use 0 for custom mapping with conversionApproved/Hold/Reject. | |
| conversionApproved | No | Postback status name for 'Approved' conversions (e.g. 'dep', 'sale'). Used with conversionTemplateId=0 for custom mapping. | |
| conversionHold | No | Postback status name for 'Hold' conversions (e.g. 'reg', 'lead'). Used with conversionTemplateId=0 for custom mapping. | |
| conversionReject | No | Postback status name for 'Rejected' conversions. Used with conversionTemplateId=0 for custom mapping. | |
| postViewWindow | No | Post-view attribution window in hours (1-168). Time after ad impression to count a conversion | |
| postClickWindow | No | Post-click attribution window in hours (1-168). Time after ad click to count a conversion | |
| countFirstConversionOnly | No | Only count the first conversion per user (default: true). Set false to allow multiple conversions per view/click | |
| countLastCampaignOnly | No | Attribute conversion only to the last campaign impression (default: true) | |
| postClickAttrPriority | No | Post-click attribution takes priority over post-view (default: true) | |
| postConversionAudienceIds | No | Comma-separated audience IDs for post-conversion retargeting |