/*
* Zernio API
*
* API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api
*
* The version of the OpenAPI document: 1.0.4
* Contact: support@zernio.com
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Ad {
#[serde(rename = "_id", skip_serializing_if = "Option::is_none")]
pub _id: Option<String>,
#[serde(rename = "name", skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(rename = "platform", skip_serializing_if = "Option::is_none")]
pub platform: Option<Platform>,
#[serde(rename = "status", skip_serializing_if = "Option::is_none")]
pub status: Option<models::AdStatus>,
#[serde(rename = "adType", skip_serializing_if = "Option::is_none")]
pub ad_type: Option<AdType>,
/// Available goals vary by platform. Meta (Facebook/Instagram) and TikTok support all 7. LinkedIn supports all except app_promotion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
#[serde(rename = "goal", skip_serializing_if = "Option::is_none")]
pub goal: Option<Goal>,
/// True for ads synced from platform ad managers
#[serde(rename = "isExternal", skip_serializing_if = "Option::is_none")]
pub is_external: Option<bool>,
#[serde(rename = "budget", skip_serializing_if = "Option::is_none")]
pub budget: Option<Box<models::AdBudget>>,
#[serde(rename = "metrics", skip_serializing_if = "Option::is_none")]
pub metrics: Option<Box<models::AdMetrics>>,
#[serde(rename = "platformAdId", skip_serializing_if = "Option::is_none")]
pub platform_ad_id: Option<String>,
#[serde(
rename = "platformAdAccountId",
skip_serializing_if = "Option::is_none"
)]
pub platform_ad_account_id: Option<String>,
#[serde(rename = "platformCampaignId", skip_serializing_if = "Option::is_none")]
pub platform_campaign_id: Option<String>,
#[serde(rename = "platformAdSetId", skip_serializing_if = "Option::is_none")]
pub platform_ad_set_id: Option<String>,
#[serde(rename = "campaignName", skip_serializing_if = "Option::is_none")]
pub campaign_name: Option<String>,
#[serde(rename = "adSetName", skip_serializing_if = "Option::is_none")]
pub ad_set_name: Option<String>,
/// Raw Meta campaign objective (e.g. OUTCOME_SALES, OUTCOME_LEADS, OUTCOME_TRAFFIC). Only present for Meta ads.
#[serde(rename = "platformObjective", skip_serializing_if = "Option::is_none")]
pub platform_objective: Option<String>,
/// Meta ad set optimization goal (e.g. OFFSITE_CONVERSIONS, VALUE, LEAD_GENERATION, LINK_CLICKS). Only present for Meta ads.
#[serde(rename = "optimizationGoal", skip_serializing_if = "Option::is_none")]
pub optimization_goal: Option<String>,
/// Human-readable advertiser/account name (Meta `AdAccount.name`, TikTok `advertiser_name`, LinkedIn / X / Pinterest equivalents). Refreshed every sync so platform-side renames propagate within one cycle. `null` when the platform doesn't return a name or the sync hasn't run yet.
#[serde(
rename = "platformAdAccountName",
skip_serializing_if = "Option::is_none"
)]
pub platform_ad_account_name: Option<String>,
/// Platform-reported creation timestamp (Meta `created_time`, TikTok `create_time`). Distinct from `createdAt` which reflects when Zernio first synced the doc — for sort/filter by \"when the ad was actually created on the platform\", read this field. `null` for legacy ads synced before this field was added; aggregations fall back to `createdAt` in that case.
#[serde(rename = "platformCreatedAt", skip_serializing_if = "Option::is_none")]
pub platform_created_at: Option<String>,
/// Ad-set bid strategy (overrides campaign level on Meta). Populated for Meta and TikTok. TikTok's native `bid_type` is normalized to the cross-platform Meta enum: `BID_TYPE_NO_BID` -> `LOWEST_COST_WITHOUT_CAP`, `BID_TYPE_CUSTOM` -> `LOWEST_COST_WITH_BID_CAP`, deep_bid_type=MIN_ROAS or roas_bid>0 -> `LOWEST_COST_WITH_MIN_ROAS`, `BID_TYPE_MAX_CONVERSION` -> `LOWEST_COST_WITHOUT_CAP`.
#[serde(rename = "bidStrategy", skip_serializing_if = "Option::is_none")]
pub bid_strategy: Option<models::BidStrategy>,
/// Bid cap in WHOLE currency units of the ad account (USD: 5 = $5.00; JPY: 100 = ¥100). Populated when bidStrategy is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. `null` for auto-bid (`LOWEST_COST_WITHOUT_CAP`). - Meta source: `bid_amount` on the ad set (smallest-denomination int, decoded here). - TikTok source: priority order `bid_price` -> `conversion_bid_price` -> `deep_cpa_bid` (whichever is set on the ad group). TikTok stores all three in whole currency units. Source: facebook-business-sdk-codegen api_specs/specs/AdSet.json (`bid_amount`).
#[serde(rename = "bidAmount", skip_serializing_if = "Option::is_none")]
pub bid_amount: Option<f64>,
/// Minimum ROAS as a decimal multiplier (2.0 = 2.0x ROAS). Populated when bidStrategy is `LOWEST_COST_WITH_MIN_ROAS`. - Meta source: decoded from `bid_constraints.roas_average_floor` (Meta stores as fixed-point int × 10000; we return the decimal). - TikTok source: `roas_bid` on the ad group (already a decimal). Source: facebook-business-sdk-codegen api_specs/specs/AdCampaignBidConstraint.json.
#[serde(rename = "roasAverageFloor", skip_serializing_if = "Option::is_none")]
pub roas_average_floor: Option<f64>,
#[serde(rename = "promotedObject", skip_serializing_if = "Option::is_none")]
pub promoted_object: Option<Box<models::AdPromotedObject>>,
#[serde(rename = "creative", skip_serializing_if = "Option::is_none")]
pub creative: Option<Box<models::AdCreative>>,
#[serde(rename = "targeting", skip_serializing_if = "Option::is_none")]
pub targeting: Option<serde_json::Value>,
#[serde(rename = "schedule", skip_serializing_if = "Option::is_none")]
pub schedule: Option<Box<models::AdSchedule>>,
#[serde(rename = "rejectionReason", skip_serializing_if = "Option::is_none")]
pub rejection_reason: Option<String>,
#[serde(rename = "createdAt", skip_serializing_if = "Option::is_none")]
pub created_at: Option<String>,
#[serde(rename = "updatedAt", skip_serializing_if = "Option::is_none")]
pub updated_at: Option<String>,
}
impl Ad {
pub fn new() -> Ad {
Ad {
_id: None,
name: None,
platform: None,
status: None,
ad_type: None,
goal: None,
is_external: None,
budget: None,
metrics: None,
platform_ad_id: None,
platform_ad_account_id: None,
platform_campaign_id: None,
platform_ad_set_id: None,
campaign_name: None,
ad_set_name: None,
platform_objective: None,
optimization_goal: None,
platform_ad_account_name: None,
platform_created_at: None,
bid_strategy: None,
bid_amount: None,
roas_average_floor: None,
promoted_object: None,
creative: None,
targeting: None,
schedule: None,
rejection_reason: None,
created_at: None,
updated_at: None,
}
}
}
///
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Platform {
#[serde(rename = "facebook")]
Facebook,
#[serde(rename = "instagram")]
Instagram,
#[serde(rename = "tiktok")]
Tiktok,
#[serde(rename = "linkedin")]
Linkedin,
#[serde(rename = "pinterest")]
Pinterest,
#[serde(rename = "google")]
Google,
#[serde(rename = "twitter")]
Twitter,
}
impl Default for Platform {
fn default() -> Platform {
Self::Facebook
}
}
///
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum AdType {
#[serde(rename = "boost")]
Boost,
#[serde(rename = "standalone")]
Standalone,
}
impl Default for AdType {
fn default() -> AdType {
Self::Boost
}
}
/// Available goals vary by platform. Meta (Facebook/Instagram) and TikTok support all 7. LinkedIn supports all except app_promotion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Goal {
#[serde(rename = "engagement")]
Engagement,
#[serde(rename = "traffic")]
Traffic,
#[serde(rename = "awareness")]
Awareness,
#[serde(rename = "video_views")]
VideoViews,
#[serde(rename = "lead_generation")]
LeadGeneration,
#[serde(rename = "conversions")]
Conversions,
#[serde(rename = "app_promotion")]
AppPromotion,
}
impl Default for Goal {
fn default() -> Goal {
Self::Engagement
}
}