Skip to content

AdTreeAdSet.md

Latest commit

 

History

History
48 lines (42 loc) · 3.76 KB

AdTreeAdSet.md

File metadata and controls

48 lines (42 loc) · 3.76 KB
Raw

Zernio::AdTreeAdSet

Properties

Name Type Description Notes
platform_ad_set_id String [optional]
ad_set_name String [optional]
status AdStatus Derived from child ad statuses [optional]
ad_count Integer [optional]
budget AdTreeAdSetBudget [optional]
ad_set_budget AdTreeAdSetAdSetBudget [optional]
metrics 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 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 Array<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, [&quot;RUNNABLE&quot;] means eligible to serve, anything else is a hold. See the `servingStatuses` field on `Ad` for the known values. [optional]
promoted_object AdTreeAdSetPromotedObject [optional]
ads Array<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 Array<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]

Example

require 'zernio-sdk'

instance = Zernio::AdTreeAdSet.new(
  platform_ad_set_id: null,
  ad_set_name: null,
  status: null,
  ad_count: null,
  budget: null,
  ad_set_budget: null,
  metrics: null,
  optimization_goal: null,
  bid_strategy: null,
  bid_amount: null,
  roas_average_floor: null,
  cost_type: null,
  serving_statuses: [RUNNABLE],
  promoted_object: null,
  ads: null,
  daily: null
)