Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.97 KB

File metadata and controls

27 lines (19 loc) · 1.97 KB

AdTreeAdSet

Ad set (or ad group/line item depending on platform) with rolled-up metrics and child ads

Properties

Name Type Description Notes
platformAdSetId String [optional]
adSetName String [optional]
status AdStatus Derived from child ad statuses [optional]
adCount Integer [optional]
budget AdTreeAdSetBudget [optional]
adSetBudget AdTreeAdSetAdSetBudget [optional]
metrics AdMetrics [optional]
optimizationGoal String Meta ad set optimization goal (e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION) [optional]
bidStrategy BidStrategy [optional]
bidAmount BigDecimal Bid cap in whole currency units. Populated when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. [optional]
roasAverageFloor BigDecimal Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Populated when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. [optional]
promotedObject AdTreeAdSetPromotedObject [optional]
ads List<Ad> Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation (core fields like _id, name, platform, status, budget, metrics, creative, goal are included; targeting and schedule may be absent). When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`. [optional]
daily List<AdDailyMetrics> Per-day metric series for this ad set. Present only when `GET /v1/ads/tree` is called with `timeIncrement=1` and `dailyLevel` is `adset` or `ad`. [optional]