Campaign data model

export type AdsCampaign = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The campaign's name
	organization_id?: string; // The ID of the ad account the campaign belongs to (an AdsOrganization ID)
	status?: 'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED';
	effective_status?: 'UNSPECIFIED' | 'SERVING' | 'LIMITED' | 'LEARNING' | 'PAUSED' | 'PENDING' | 'ENDED' | 'MISCONFIGURED' | 'NOT_ELIGIBLE' | 'ARCHIVED' | 'REMOVED'; // read-only; controlled by the provider (whether/why the campaign can serve), unlike the user-managed status
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	budget_amount?: number;
	budget_period?: 'DAILY' | 'MONTHLY' | 'TOTAL' | 'LIFETIME';
	budget_unit?: 'UNSPECIFIED' | 'CURRENCY' | 'IMPRESSIONS';
	total_spend_amount?: number;
	targeting?: {
		geographic?: any; 
		demographic?: any; // Demographic targeting (Meta: age_min, age_max, genders) 
		audience?: any; 
		placement?: any; 
		device?: any; 
		language?: []; 
		content?: any; 
		brand_safety?: any; // Brand safety (Meta: excluded_publisher_categories, etc.; Google 
		schedule?: []; 
		optimization?: any; // Optimization (Meta: targeting_automation; Google: observation vs targeting mode) 
		inventory?: any; // Publisher inventory (ad units, placements) to include / exclude 
		custom?: []; // Key-value targeting; clauses are ANDed 
		supply?: any; // Buy-side inventory: exchanges, deals, deal groups and seller authorization (DSPs) 
	};
	goal?: 'UNSPECIFIED' | 'BRAND_AWARENESS' | 'ENGAGEMENT' | 'REACH' | 'WEBSITE_TRAFFIC' | 'LEADS' | 'SALES' | 'APP_PROMOTION';
	planned_spend_amount?: number;
	frequency_cap?: {
		is_unlimited?: boolean; 
		time_unit?: 'UNSPECIFIED' | 'LIFETIME' | 'MONTHS' | 'WEEKS' | 'DAYS' | 'HOURS' | 'MINUTES'; 
		time_unit_count?: number; 
		max_impressions?: number; 
		max_views?: number; 
	};
	advertising_channel_type?: 'TEXT' | 'IMAGE' | 'VIDEO' | 'RESPONSIVE' | 'SHOPPING' | 'APP' | 'CALL' | 'CAROUSEL' | 'SOCIAL' | 'DISPLAY' | 'SEARCH' | 'AUDIO' | 'YOUTUBE' | 'NATIVE' | 'CTV' | 'DOOH' | 'PERFORMANCE_MAX';
	campaign_budget_identifier?: string; // Resource name for existing/shared budget (Google)
	currency?: string;
	category?: string; // Housing, employment, credit, NONE (Meta)
	has_eu_political_ads?: boolean;
	labels?: string[];
	kpi?: {
		type?: 'UNSPECIFIED' | 'CPM' | 'CPC' | 'CPA' | 'CTR' | 'VIEWABILITY' | 'CPIAVC' | 'CPE' | 'CPV' | 'CLICK_CVR' | 'IMPRESSION_CVR' | 'VCPM' | 'VTR' | 'AUDIO_COMPLETION_RATE' | 'VIDEO_COMPLETION_RATE' | 'CPCL' | 'CPCV' | 'TOS10' | 'MAXIMIZE_PACING' | 'CUSTOM_IMPRESSION_VALUE_OVER_COST' | 'OTHER'; 
		amount?: number; 
		percentage?: number; 
		string_value?: string; 
		algorithm_id?: string; 
	};
	metadata?: [];
	raw?: any;
} 

import { z } from 'zod';

export const ZodAdsCampaign = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The campaign's name"),
	organization_id: z.string().optional().describe("The ID of the ad account the campaign belongs to (an AdsOrganization ID)"),
	status: z.enum("UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED").optional(),
	effective_status: z.enum("UNSPECIFIED", "SERVING", "LIMITED", "LEARNING", "PAUSED", "PENDING", "ENDED", "MISCONFIGURED", "NOT_ELIGIBLE", "ARCHIVED", "REMOVED").optional().describe("read-only; controlled by the provider (whether/why the campaign can serve), unlike the user-managed status"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	budget_amount: z.number().optional(),
	budget_period: z.enum("DAILY", "MONTHLY", "TOTAL", "LIFETIME").optional(),
	budget_unit: z.enum("UNSPECIFIED", "CURRENCY", "IMPRESSIONS").optional(),
	total_spend_amount: z.number().optional(),
	targeting: z.object({
			geographic: z.unknown().optional(),
			demographic: z.unknown().optional().describe("Demographic targeting (Meta: age_min, age_max, genders)"),
			audience: z.unknown().optional(),
			placement: z.unknown().optional(),
			device: z.unknown().optional(),
			language: z.array().optional(),
			content: z.unknown().optional(),
			brand_safety: z.unknown().optional().describe("Brand safety (Meta: excluded_publisher_categories, etc.; Google"),
			schedule: z.array().optional(),
			optimization: z.unknown().optional().describe("Optimization (Meta: targeting_automation; Google: observation vs targeting mode)"),
			inventory: z.unknown().optional().describe("Publisher inventory (ad units, placements) to include / exclude"),
			custom: z.array().optional().describe("Key-value targeting; clauses are ANDed"),
			supply: z.unknown().optional().describe("Buy-side inventory: exchanges, deals, deal groups and seller authorization (DSPs)")
}).optional(),
	goal: z.enum("UNSPECIFIED", "BRAND_AWARENESS", "ENGAGEMENT", "REACH", "WEBSITE_TRAFFIC", "LEADS", "SALES", "APP_PROMOTION").optional(),
	planned_spend_amount: z.number().optional(),
	frequency_cap: z.object({
			is_unlimited: z.boolean().optional(),
			time_unit: z.enum("UNSPECIFIED", "LIFETIME", "MONTHS", "WEEKS", "DAYS", "HOURS", "MINUTES").optional(),
			time_unit_count: z.number().optional(),
			max_impressions: z.number().optional(),
			max_views: z.number().optional()
}).optional(),
	advertising_channel_type: z.enum("TEXT", "IMAGE", "VIDEO", "RESPONSIVE", "SHOPPING", "APP", "CALL", "CAROUSEL", "SOCIAL", "DISPLAY", "SEARCH", "AUDIO", "YOUTUBE", "NATIVE", "CTV", "DOOH", "PERFORMANCE_MAX").optional(),
	campaign_budget_identifier: z.string().optional().describe("Resource name for existing/shared budget (Google)"),
	currency: z.string().optional(),
	category: z.string().optional().describe("Housing, employment, credit, NONE (Meta)"),
	has_eu_political_ads: z.boolean().optional(),
	labels: z.array().optional(),
	kpi: z.object({
			type: z.enum("UNSPECIFIED", "CPM", "CPC", "CPA", "CTR", "VIEWABILITY", "CPIAVC", "CPE", "CPV", "CLICK_CVR", "IMPRESSION_CVR", "VCPM", "VTR", "AUDIO_COMPLETION_RATE", "VIDEO_COMPLETION_RATE", "CPCL", "CPCV", "TOS10", "MAXIMIZE_PACING", "CUSTOM_IMPRESSION_VALUE_OVER_COST", "OTHER").optional(),
			amount: z.number().optional(),
			percentage: z.number().optional(),
			string_value: z.string().optional(),
			algorithm_id: z.string().optional()
}).optional(),
	metadata: z.array().optional(),

});

import dataclasses

@dataclasses.dataclass
class AdsCampaignStatus(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	ACTIVE = 'ACTIVE'
	PAUSED = 'PAUSED'
	ARCHIVED = 'ARCHIVED'
	DRAFT = 'DRAFT'
	SCHEDULED_FOR_DELETION = 'SCHEDULED_FOR_DELETION'
	PROCESSING = 'PROCESSING'
	PROCESSING_FAILED = 'PROCESSING_FAILED'

@dataclasses.dataclass
class AdsCampaignEffective_status(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	SERVING = 'SERVING'
	LIMITED = 'LIMITED'
	LEARNING = 'LEARNING'
	PAUSED = 'PAUSED'
	PENDING = 'PENDING'
	ENDED = 'ENDED'
	MISCONFIGURED = 'MISCONFIGURED'
	NOT_ELIGIBLE = 'NOT_ELIGIBLE'
	ARCHIVED = 'ARCHIVED'
	REMOVED = 'REMOVED'

@dataclasses.dataclass
class AdsCampaignBudget_period(str, Enum):
	DAILY = 'DAILY'
	MONTHLY = 'MONTHLY'
	TOTAL = 'TOTAL'
	LIFETIME = 'LIFETIME'

@dataclasses.dataclass
class AdsCampaignBudget_unit(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	CURRENCY = 'CURRENCY'
	IMPRESSIONS = 'IMPRESSIONS'

@dataclasses.dataclass
class AdsCampaignGoal(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	BRAND_AWARENESS = 'BRAND_AWARENESS'
	ENGAGEMENT = 'ENGAGEMENT'
	REACH = 'REACH'
	WEBSITE_TRAFFIC = 'WEBSITE_TRAFFIC'
	LEADS = 'LEADS'
	SALES = 'SALES'
	APP_PROMOTION = 'APP_PROMOTION'

@dataclasses.dataclass
class AdsCampaignAdvertising_channel_type(str, Enum):
	TEXT = 'TEXT'
	IMAGE = 'IMAGE'
	VIDEO = 'VIDEO'
	RESPONSIVE = 'RESPONSIVE'
	SHOPPING = 'SHOPPING'
	APP = 'APP'
	CALL = 'CALL'
	CAROUSEL = 'CAROUSEL'
	SOCIAL = 'SOCIAL'
	DISPLAY = 'DISPLAY'
	SEARCH = 'SEARCH'
	AUDIO = 'AUDIO'
	YOUTUBE = 'YOUTUBE'
	NATIVE = 'NATIVE'
	CTV = 'CTV'
	DOOH = 'DOOH'
	PERFORMANCE_MAX = 'PERFORMANCE_MAX'

@dataclasses.dataclass
class PropertyAdsCampaignTargeting:
	geographic: Optional[PropertyAdsCampaignGeographic]
	"""Demographic targeting (Meta: age_min, age_max, genders)"""
	demographic: Optional[PropertyAdsCampaignDemographic]
	audience: Optional[PropertyAdsCampaignAudience]
	placement: Optional[PropertyAdsCampaignPlacement]
	device: Optional[PropertyAdsCampaignDevice]
	language: Optional[PropertyAdsCampaignLanguage]
	content: Optional[PropertyAdsCampaignContent]
	"""Brand safety (Meta: excluded_publisher_categories, etc.; Google"""
	brand_safety: Optional[PropertyAdsCampaignBrand_safety]
	schedule: Optional[PropertyAdsCampaignSchedule]
	"""Optimization (Meta: targeting_automation; Google: observation vs targeting mode)"""
	optimization: Optional[PropertyAdsCampaignOptimization]
	"""Publisher inventory (ad units, placements) to include / exclude"""
	inventory: Optional[PropertyAdsCampaignInventory]
	"""Key-value targeting; clauses are ANDed"""
	custom: Optional[PropertyAdsCampaignCustom]
	"""Buy-side inventory: exchanges, deals, deal groups and seller authorization (DSPs)"""
	supply: Optional[PropertyAdsCampaignSupply]

@dataclasses.dataclass
class AdsCampaignFrequency_capTime_unit(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	LIFETIME = 'LIFETIME'
	MONTHS = 'MONTHS'
	WEEKS = 'WEEKS'
	DAYS = 'DAYS'
	HOURS = 'HOURS'
	MINUTES = 'MINUTES'

@dataclasses.dataclass
class PropertyAdsCampaignFrequency_cap:
	is_unlimited: Optional[bool]
	time_unit: Optional[AdsCampaignFrequency_capTime_unit]
	time_unit_count: Optional[int]
	max_impressions: Optional[int]
	max_views: Optional[int]

@dataclasses.dataclass
class AdsCampaignKpiType(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	CPM = 'CPM'
	CPC = 'CPC'
	CPA = 'CPA'
	CTR = 'CTR'
	VIEWABILITY = 'VIEWABILITY'
	CPIAVC = 'CPIAVC'
	CPE = 'CPE'
	CPV = 'CPV'
	CLICK_CVR = 'CLICK_CVR'
	IMPRESSION_CVR = 'IMPRESSION_CVR'
	VCPM = 'VCPM'
	VTR = 'VTR'
	AUDIO_COMPLETION_RATE = 'AUDIO_COMPLETION_RATE'
	VIDEO_COMPLETION_RATE = 'VIDEO_COMPLETION_RATE'
	CPCL = 'CPCL'
	CPCV = 'CPCV'
	TOS10 = 'TOS10'
	MAXIMIZE_PACING = 'MAXIMIZE_PACING'
	CUSTOM_IMPRESSION_VALUE_OVER_COST = 'CUSTOM_IMPRESSION_VALUE_OVER_COST'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PropertyAdsCampaignKpi:
	type: Optional[AdsCampaignKpiType]
	amount: Optional[int]
	percentage: Optional[int]
	string_value: Optional[str]
	algorithm_id: Optional[str]

@dataclasses.dataclass
class AdsCampaign:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The campaign's name"""
	name: Optional[str]
	"""The ID of the ad account the campaign belongs to (an AdsOrganization ID)"""
	organization_id: Optional[str]
	status: Optional[AdsCampaignStatus]
	"""read-only; controlled by the provider (whether/why the campaign can serve), unlike the user-managed status"""
	effective_status: Optional[AdsCampaignEffective_status]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	budget_amount: Optional[int]
	budget_period: Optional[AdsCampaignBudget_period]
	budget_unit: Optional[AdsCampaignBudget_unit]
	total_spend_amount: Optional[int]
	targeting: Optional[PropertyAdsCampaignTargeting]
	goal: Optional[AdsCampaignGoal]
	planned_spend_amount: Optional[int]
	frequency_cap: Optional[PropertyAdsCampaignFrequency_cap]
	advertising_channel_type: Optional[AdsCampaignAdvertising_channel_type]
	"""Resource name for existing/shared budget (Google)"""
	campaign_budget_identifier: Optional[str]
	currency: Optional[str]
	"""Housing, employment, credit, NONE (Meta)"""
	category: Optional[str]
	has_eu_political_ads: Optional[bool]
	labels: Optional[List[List[str]]]
	kpi: Optional[PropertyAdsCampaignKpi]
	metadata: Optional[PropertyAdsCampaignMetadata]