Skip to content

AdCampaign.md

Latest commit

 

History

History
70 lines (64 loc) · 3.56 KB

AdCampaign.md

File metadata and controls

70 lines (64 loc) · 3.56 KB
Raw

Zernio::AdCampaign

Properties

Name Type Description Notes
platform_campaign_id String [optional]
platform String [optional]
campaign_name String [optional]
status AdStatus Delivery status derived from child ad statuses. Distinct from `reviewStatus`. [optional]
review_status String Platform-side review state of the campaign. See AdTreeCampaign.reviewStatus for the full description. [optional]
platform_campaign_status String Raw platform-level campaign status (Meta `effective_status`). [optional]
campaign_issues_info Array<Object> Platform-reported campaign issues (Meta `issues_info[]`). [optional]
ad_count Integer [optional]
budget AdCampaignBudget [optional]
campaign_budget AdCampaignCampaignBudget [optional]
budget_level String Canonical CBO/ABO indicator. See AdTreeCampaign.budgetLevel. [optional]
is_budget_schedule_enabled Boolean Meta-only. Mirrors Campaign.is_budget_schedule_enabled. [optional][default to false]
currency String ISO 4217 currency code for all budget amounts. Budgets are NOT normalized to USD. [optional]
metrics 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. See AdTreeCampaign.advertisingChannelType. [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 BidStrategy [optional]
bid_amount Float 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]
roas_average_floor Float Representative ROAS floor from the top-spending ad set. Decimal multiplier (2.0 = 2.0x). [optional]
promoted_object AdTreeCampaignPromotedObject [optional]
earliest_ad Time [optional]
latest_ad Time [optional]

Example

require 'zernio-sdk'

instance = Zernio::AdCampaign.new(
  platform_campaign_id: null,
  platform: null,
  campaign_name: null,
  status: null,
  review_status: null,
  platform_campaign_status: null,
  campaign_issues_info: null,
  ad_count: null,
  budget: null,
  campaign_budget: null,
  budget_level: null,
  is_budget_schedule_enabled: null,
  currency: null,
  metrics: null,
  platform_ad_account_id: null,
  platform_ad_account_name: null,
  account_id: null,
  profile_id: null,
  advertising_channel_type: null,
  platform_objective: null,
  optimization_goal: null,
  bid_strategy: null,
  bid_amount: null,
  roas_average_floor: null,
  promoted_object: null,
  earliest_ad: null,
  latest_ad: null
)