Skip to content

Campaigns Object



id
string
REQUIRED · The unique identifier for the campaign.
name
string
The name of the campaign.
status
string
The status of the campaign.
All possible enum values:
  • active
  • paused
  • deleted
  • archived
  • in_process
  • with_issues
labels
object[]
The labels for the campaign.
id
string
The unique identifier for the label.
name
string
The name of the label.
objective
string
The objective of the campaign.
All possible enum values:
  • app_installs
  • brand_awareness
  • conversions
  • event_responses
  • lead_generation
  • link_clicks
  • local_awareness
  • messages
  • offer_claims
  • outcome_app_promotion
  • outcome_awareness
  • outcome_engagement
  • outcome_leads
  • outcome_sales
  • outcome_traffic
  • page_likes
  • post_engagement
  • product_catalog_sales
  • reach
  • store_visits
  • video_views
bid_strategy
object
The bid strategy for the campaign.
id
string
The unique identifier for the bid strategy.
name
string
The name of the bid strategy.
All possible enum values:
  • lowest_cost_without_cap
  • lowest_cost_with_bid_cap
  • cost_cap
buying_type
string
The buying type for the campaign.
All possible enum values:
  • auction
  • reserved
budget
object
The budget for the campaign.
id
string
The unique identifier for the budget.
remaining
string
The remaining budget for the campaign.
lifetime_max
string
The max budget for the campaign.
daily_max
string
The daily max budget for the campaign.
is_scheduling_enabled
boolean
Whether budget scheduling is enabled for the campaign.
is_rebalance_enabled
boolean
Whether budget rebalancing is enabled for the campaign.
is_shared
boolean
Whether the budget is shared for the campaign with other campaigns.
spend
object
The spend for the campaign.
max_cap
string
The max cap spend for the campaign.
cap_enabled
boolean
Whether the cap is enabled for the campaign.
primary_attribution
string
The primary attribution for the campaign.
special_ad_categories
string[]
The special ad categories for the campaign.
All possible enum values:
  • credit
  • employment
  • housing
  • none
  • political
  • social_issues
special_ad_category
string
The special ad category for the campaign.
All possible enum values:
  • credit
  • employment
  • housing
  • none
  • political
  • social_issues
start_time
string · date-time
The start time for the campaign.
stop_time
string · date-time
The stop time for the campaign.
created_at
string · date-time
The date and time the campaign was created.
updated_at
string · date-time
The date and time the campaign was last updated.
remote_data
object
Raw data returned from the remote API call.