AdPlan

A resource for creating/modifying an ad campaign.

Used in resources: AdPlans, AdPlan

Field nameTypeConditionsDescription
iduint32readable default_fieldCampaign identifier
createddatetimereadableCreation time
updateddatetimereadableLast modified time
namestringreadable required writable default_fieldCampaign name
statusstringreadable writable
choices =
  • active - Active
  • deleted - Deleted
  • blocked - Blocked
Campaign status. The deleted status can also be returned for deleted campaigns. In a campaign with status deleted, only the status itself can be changed.
vkads_statusobjectreadableActivity and delivery status
ad_groupslist of AdGroupreadable writable requiredGroups
autobidding_modestringreadable writable
choices =
  • max_goals - Goal maximization (features: no bid; a total budget and campaign period or a daily budget must be set)
Auction strategy
budget_limitdecimalreadable writable min_value=-1Total campaign budget
budget_limit_daydecimalreadable writable min_value=-1Daily campaign budget
date_startdatereadable writableCampaign start date
date_enddatereadable writableCampaign end date
max_pricedecimalreadable writableUpper limit for automatic price adjustment
objectivestringreadable writableCampaign objective
priced_goalPricedGoalreadable writablePayment by TOP goals
pricelist_idint32readable writableRemarketing price list identifier
enable_offline_goalsbooleanreadable writableCount offline conversions for the campaign