Skip to content

Latest commit

 

History

History
36 lines (33 loc) · 4.48 KB

File metadata and controls

36 lines (33 loc) · 4.48 KB

# AdTreeCampaign

Properties

Name Type Description Notes
platform_campaign_id string [optional]
platform string [optional]
campaign_name string [optional]
status \Zernio\Model\AdStatus Delivery status derived from child ad statuses. Distinct from `reviewStatus`, which reflects the platform-side review state. [optional]
review_status string Platform-side review state of the campaign. Independent of the children-derived delivery `status`: a campaign can have ads already active (status=active) while the campaign itself is still being reviewed by the platform (reviewStatus=in_review). For Meta, derived from `effective_status` + `issues_info` on the Campaign, plus ad-level PENDING_REVIEW rollup. [optional]
platform_campaign_status string Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES). Distinct from per-ad `platformStatus`. [optional]
campaign_issues_info object[] Platform-reported campaign issues (Meta `issues_info[]`). Populated only when the platform has delivery issues to report; contains the specific error codes and messages. [optional]
ad_count int Total ads across all ad sets [optional]
ad_set_count int [optional]
budget \Zernio\Model\AdTreeCampaignBudget [optional]
campaign_budget \Zernio\Model\AdTreeCampaignCampaignBudget [optional]
budget_level string Canonical CBO/ABO indicator. `campaign` = CBO (Advantage Campaign Budget, budget lives on the campaign). `adset` = ABO (budget lives on each ad set). Route budget updates to the matching Meta entity. [optional]
is_budget_schedule_enabled bool Meta-only. Mirrors Campaign.is_budget_schedule_enabled — true when the campaign uses budget scheduling (time-based budget changes). Independent of CBO/ABO. [optional] [default to false]
currency string ISO 4217 currency code (e.g. USD, EUR, CLP, JPY) for all budget amounts in this campaign node. Budgets are NOT normalized to USD. [optional]
metrics \Zernio\Model\AdMetrics [optional]
platform_ad_account_id string [optional]
platform_ad_account_name string Human-readable advertiser/account name from the platform. Refreshed on every sync. [optional]
account_id string [optional]
profile_id string [optional]
advertising_channel_type string Google-only. Raw campaign.advertising_channel_type (SEARCH, PERFORMANCE_MAX, VIDEO, DEMAND_GEN, DISPLAY, SHOPPING, ...). Serving surface, distinct from platformObjective (advertiser intent). Null/absent for non-Google platforms. [optional]
platform_objective string Raw Meta campaign objective (e.g. OUTCOME_SALES, OUTCOME_LEADS, OUTCOME_TRAFFIC) [optional]
optimization_goal string Meta optimization goal shared across ad sets, or comma-separated values when ad sets differ (e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION) [optional]
bid_strategy \Zernio\Model\BidStrategy [optional]
bid_amount float Representative bid cap for the campaign — bubbled up from the top-spending ad set's `bid_amount` (whole currency units). Populated when the ad-set bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. [optional]
roas_average_floor float Representative ROAS floor for the campaign — bubbled up from the top-spending ad set. Decimal multiplier (2.0 = 2.0x). [optional]
promoted_object \Zernio\Model\AdTreeCampaignPromotedObject [optional]
ad_sets \Zernio\Model\AdTreeAdSet[] [optional]
daily \Zernio\Model\AdDailyMetrics[] Per-day metric series for this campaign. Present only when `GET /v1/ads/tree` is called with `timeIncrement=1` (any `dailyLevel`). This is the per-campaign daily trend — summing its additive fields reproduces the campaign `metrics` total. [optional]

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