Documentation>Campaign API Reference
Intermediate Level

Campaign API Reference

Detailed documentation for campaign objects, methods, and properties for advanced campaign automation.

30 minutes
Campaign Object Methods
// Essential campaign methods
campaign.getName()           // Returns campaign name
campaign.getStats()          // Gets performance statistics  
campaign.setBudget(amount)   // Sets daily budget
campaign.getBudget()         // Gets current budget
campaign.pause()             // Pauses campaign
campaign.enable()            // Enables campaign
campaign.getStatus()         // Returns current status
campaign.isEnabled()         // Boolean status check
Working with Campaign Statistics
// Get campaign stats for different periods
const stats = campaign.getStatsFor('LAST_7_DAYS');

// Available metrics
const cost = stats.getCost();
const clicks = stats.getClicks();
const conversions = stats.getConversions();
const conversionValue = stats.getConversionValue();
const impressions = stats.getImpressions();
const ctr = stats.getCtr();

// Calculate custom metrics
const roas = conversionValue / cost;
const cpa = cost / conversions;
const conversionRate = conversions / clicks;