Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 3.5 KB

File metadata and controls

24 lines (21 loc) · 3.5 KB

# AdTreeAdSet

Properties

Name Type Description Notes
platform_ad_set_id string [optional]
ad_set_name string [optional]
status \Zernio\Model\AdStatus Derived from child ad statuses [optional]
ad_count int [optional]
budget \Zernio\Model\AdTreeAdSetBudget [optional]
ad_set_budget \Zernio\Model\AdTreeAdSetAdSetBudget [optional]
metrics \Zernio\Model\AdMetrics [optional]
optimization_goal string What the delivery system optimizes for. Meta ad set optimization goal (e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION), or on LinkedIn the campaign's effective optimizationTargetType (NONE means manual bidding). See the `optimizationGoal` field on `Ad` for the full value spaces. [optional]
bid_strategy \Zernio\Model\BidStrategy [optional]
bid_amount float Bid amount in whole currency units. On Meta/TikTok populated when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP; on LinkedIn it is the campaign's effective unitCost and pairs with `costType`, where 0 is a real, delivery-stopping value. [optional]
roas_average_floor float Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Populated when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. [optional]
cost_type string LinkedIn only. Effective cost model (billing event) of the LinkedIn campaign backing this ad set: CPM, CPC or CPV. Null for non-LinkedIn ad sets. [optional]
serving_statuses string[] LinkedIn only. Why the LinkedIn campaign backing this ad set is (or is not) delivering. A LinkedIn Campaign maps to this ad-set node, so this is the level where LinkedIn's holds actually apply. Empty means no serving data, ["RUNNABLE"] means eligible to serve, anything else is a hold. See the `servingStatuses` field on `Ad` for the known values. [optional]
promoted_object \Zernio\Model\AdTreeAdSetPromotedObject [optional]
ads \Zernio\Model\Ad[] Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`. [optional]
daily \Zernio\Model\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]

[Back to Model list] [Back to API list] [Back to README]