Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 4.52 KB

File metadata and controls

73 lines (53 loc) · 4.52 KB

AdTreeCampaign

Campaign with nested ad sets and rolled-up metrics

Properties

Name Type Description Notes
platformCampaignId String [optional]
platform PlatformEnum [optional]
campaignName String [optional]
status AdStatus Delivery status derived from child ad statuses. Distinct from `reviewStatus`, which reflects the platform-side review state. [optional]
reviewStatus ReviewStatusEnum 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]
platformCampaignStatus String Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES). Distinct from per-ad `platformStatus`. [optional]
campaignIssuesInfo List<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]
adCount Integer Total ads across all ad sets [optional]
adSetCount Integer [optional]
budget AdTreeCampaignBudget [optional]
campaignBudget AdTreeCampaignCampaignBudget [optional]
budgetLevel BudgetLevelEnum 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]
isBudgetScheduleEnabled Boolean Meta-only. Mirrors Campaign.is_budget_schedule_enabled — true when the campaign uses budget scheduling (time-based budget changes). Independent of CBO/ABO. [optional]
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 AdMetrics [optional]
platformAdAccountId String [optional]
platformAdAccountName String Human-readable advertiser/account name from the platform. Refreshed on every sync. [optional]
accountId String [optional]
profileId String [optional]
platformObjective String Raw Meta campaign objective (e.g. OUTCOME_SALES, OUTCOME_LEADS, OUTCOME_TRAFFIC) [optional]
optimizationGoal String Meta optimization goal shared across ad sets, or comma-separated values when ad sets differ (e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION) [optional]
bidStrategy BidStrategy Campaign-level bid strategy. Ad sets inherit this unless they override. [optional]
bidAmount BigDecimal 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]
roasAverageFloor BigDecimal Representative ROAS floor for the campaign — bubbled up from the top-spending ad set. Decimal multiplier (2.0 = 2.0x). [optional]
promotedObject AdTreeCampaignPromotedObject [optional]
adSets List<AdTreeAdSet> [optional]

Enum: PlatformEnum

Name Value
FACEBOOK "facebook"
INSTAGRAM "instagram"
TIKTOK "tiktok"
LINKEDIN "linkedin"
PINTEREST "pinterest"
GOOGLE "google"
TWITTER "twitter"

Enum: ReviewStatusEnum

Name Value
IN_REVIEW "in_review"
APPROVED "approved"
REJECTED "rejected"
WITH_ISSUES "with_issues"

Enum: BudgetLevelEnum

Name Value
CAMPAIGN "campaign"
ADSET "adset"