Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 3.52 KB

File metadata and controls

73 lines (53 loc) · 3.52 KB

AdCampaign

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`. [optional]
reviewStatus ReviewStatusEnum Platform-side review state of the campaign. See AdTreeCampaign.reviewStatus for the full description. [optional]
platformCampaignStatus String Raw platform-level campaign status (Meta `effective_status`). [optional]
campaignIssuesInfo List<Object> Platform-reported campaign issues (Meta `issues_info[]`). [optional]
adCount Integer [optional]
budget AdCampaignBudget [optional]
campaignBudget AdCampaignCampaignBudget [optional]
budgetLevel BudgetLevelEnum Canonical CBO/ABO indicator. See AdTreeCampaign.budgetLevel. [optional]
isBudgetScheduleEnabled Boolean Meta-only. Mirrors Campaign.is_budget_schedule_enabled. [optional]
currency String ISO 4217 currency code for all budget amounts. 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]
advertisingChannelType String Google-only. Raw campaign.advertising_channel_type. See AdTreeCampaign.advertisingChannelType. [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 [optional]
bidAmount BigDecimal Representative bid cap from the top-spending ad set (whole currency units). Populated when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. [optional]
roasAverageFloor BigDecimal Representative ROAS floor from the top-spending ad set. Decimal multiplier (2.0 = 2.0x). [optional]
promotedObject AdTreeCampaignPromotedObject [optional]
earliestAd OffsetDateTime [optional]
latestAd OffsetDateTime [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"