import {z} from 'zod' export type CampaignViewability = {vendor_id: number, type: 'AUTO_TAG' | 'BYOV', sample_rate: number} | null; export type CampaignIdentity = {device_graph_only?: boolean | undefined, bid_min_devices?: number | undefined, connected_id_type?: ('DETERMINISTIC_FIRST' | null) | undefined}; export type CampaignAdServer = {ad_server_id?: number | undefined, ad_server_username?: string | undefined, ad_server_password?: string | undefined, use_default_ad_server?: boolean | undefined, ad_server_fee?: number | undefined}; export type CampaignPacing = {pacing_alert?: number | undefined, impression_cap_automatic?: boolean | undefined, impression_cap_amount?: (number | null) | undefined, impression_cap_type?: ('even' | 'asap' | 'no-limit') | undefined, spend_cap_type?: ('even' | 'asap' | 'no-limit') | undefined, spend_cap_amount?: (number | null) | undefined, spend_cap_automatic?: boolean | undefined, brain_intraday_pacing?: boolean | undefined, spend_pace_ahead?: boolean | undefined, impression_pace_ahead?: boolean | undefined}; export type CampaignAttribution = {has_custom_attribution?: boolean | undefined, custom_attribution_source?: ('3rd Party Attribution' | 'T1 MTA via Neustar' | null) | undefined, pc_window_minutes?: (number | null) | undefined, pv_window_minutes?: (number | null) | undefined, pv_pct?: number | undefined, merit_pixel_id?: (number | null) | undefined, merit_pixels?: (Array<{id?: number | undefined, pixel_id: number, weight?: number | undefined, funnel_position?: (number | null) | undefined}>) | undefined, conversion_type?: ('every' | 'variable') | undefined, conversion_variable_minutes?: number | undefined}; export type VendorContractBase = {vendor_id: number, use_mm_contract?: boolean | undefined, price?: (number | null) | undefined, rate_card_type?: ('CPM' | 'FIXED' | null) | undefined}; export type CampaignGoalsCreate = {goal_type: 'spend' | 'reach' | 'cpc' | 'cpe' | 'cpa' | 'roi' | 'ctr' | 'vcr' | 'viewability_rate' | 'vcpm', goal_alert?: number | undefined, goal_value: number, goal_category?: ('audience' | 'engagement' | 'response' | null) | undefined}; export type CampaignBudgetFlightsCreate = {start_date: string, end_date: string, total_budget: number, total_impression_budget?: (number | null) | undefined}; export type CampaignFrequency = {frequency_type?: ('even' | 'asap' | 'no-limit' | 't1-optimized' | 'frequency_goal') | undefined, frequency_interval?: ('hour' | 'day' | 'week' | 'month' | 'not-applicable' | null) | undefined, frequency_amount?: (number | null) | undefined, use_mm_freq?: boolean | undefined, frequency_optimization?: boolean | undefined}; export type CampaignInventory = {ads_txt_verified?: ('ANY' | 'AUTHORIZED_ONLY' | 'AUTHORIZED_DIRECT_ONLY' | 'NONE' | null) | undefined, minimize_multi_ads?: boolean | undefined, override_suspicious_traffic_filter?: boolean | undefined, suspicious_traffic_filter_level?: number | undefined, dcs_data_is_campaign_level?: boolean | undefined, restrict_targeting_to_deterministic_id?: boolean | undefined, restrict_targeting_to_same_device_id?: boolean | undefined}; export type CampaignCreate = {archived?: boolean | undefined, status?: boolean | undefined, name: string, service_type: 'SELF' | 'MANAGED', io_name?: string | undefined, io_reference_num?: string | undefined, is_programmatic_guaranteed?: boolean | undefined, political?: boolean | undefined, source_campaign_id?: (number | null) | undefined, zone_name?: string | undefined, viewability?: CampaignViewability | undefined, identity?: CampaignIdentity | undefined, ad_server?: CampaignAdServer | undefined, pacing?: CampaignPacing | undefined, attribution?: CampaignAttribution | undefined, vendor_contracts?: Array | undefined, mfa_avoidance?: ('INHERIT' | 'ALLOW_ALL' | 'EXCLUDE_MFA') | undefined, targeting_identity_level?: ('INHERIT' | 'INDIVIDUAL' | 'HOUSEHOLD') | undefined, advertiser_id: number, goals: CampaignGoalsCreate, budget: {total_budget?: (number | null) | undefined, total_impression_budget?: (number | null) | undefined, currency_code: string, margin_pct?: number | undefined, dynamic_budget_allocation_type?: ('SBA_AUTO_ALLOCATION' | 'SBA_RECOMMENDATIONS_ONLY' | 'OFF') | undefined, dynamic_budget_allocation_applied?: string | undefined, dynamic_budget_allocation_available?: string | undefined, flights: Array}, frequency?: CampaignFrequency | undefined, inventory?: CampaignInventory | undefined, site_lists?: Array<{id: number, assigned: boolean}> | undefined, custom_brain_selections?: (Array<{selection_id?: number | undefined, selection_type?: ('Audience Target' | 'Data Pixel' | 'Event Pixel' | 'Segment' | 'Dynamic') | undefined}>) | undefined}; export type CreateApiCampaignsArgs = {body: CampaignCreate}; export type CreateApiCampaignsOptions = {baseUrl?: string | undefined, Auth0?: string | undefined, fetch?: typeof fetch | undefined}; export const campaignViewability = z.object({vendor_id: z.number().int(), type: z.enum(["AUTO_TAG", "BYOV"]), sample_rate: z.number().gte(0).lte(1)}).nullable(); export const campaignIdentity = z.object({device_graph_only: z.boolean().optional(), bid_min_devices: z.number().int().gte(-32768).lte(32767).optional(), connected_id_type: z.literal("DETERMINISTIC_FIRST").nullable().optional()}); export const campaignAdServer = z.object({ad_server_id: z.number().int().optional(), ad_server_username: z.string().max(64).optional(), ad_server_password: z.string().max(64).optional(), use_default_ad_server: z.boolean().optional(), ad_server_fee: z.number().gte(0).lte(9999999.99).optional()}); export const campaignPacing = z.object({pacing_alert: z.number().gte(0).lte(999.99).optional(), impression_cap_automatic: z.boolean().optional(), impression_cap_amount: z.number().int().nullable().optional(), impression_cap_type: z.enum(["even", "asap", "no-limit"]).optional(), spend_cap_type: z.enum(["even", "asap", "no-limit"]).optional(), spend_cap_amount: z.number().gte(0).lte(9999999.99).nullable().optional(), spend_cap_automatic: z.boolean().optional(), brain_intraday_pacing: z.boolean().optional(), spend_pace_ahead: z.boolean().optional(), impression_pace_ahead: z.boolean().optional()}); export const campaignAttribution = z.object({has_custom_attribution: z.boolean().optional(), custom_attribution_source: z.enum(["3rd Party Attribution", "T1 MTA via Neustar"]).nullable().optional(), pc_window_minutes: z.number().int().gte(0).lte(43200).nullable().optional(), pv_window_minutes: z.number().int().gte(0).lte(43200).nullable().optional(), pv_pct: z.number().gte(0).lte(100).optional(), merit_pixel_id: z.number().int().nullable().optional(), merit_pixels: z.array(z.object({id: z.number().int().optional(), pixel_id: z.number().int().gte(1), weight: z.number().gte(0).lte(10).multipleOf(0.01).optional(), funnel_position: z.number().int().gte(1).lte(10).nullable().optional()})).optional(), conversion_type: z.enum(["every", "variable"]).optional(), conversion_variable_minutes: z.number().int().optional()}); export const vendorContractBase = z.object({vendor_id: z.number().int(), use_mm_contract: z.boolean().optional(), price: z.number().nullable().optional(), rate_card_type: z.enum(["CPM", "FIXED"]).nullable().optional()}); export const campaignGoals = z.object({goal_type: z.enum(["spend", "reach", "cpc", "cpe", "cpa", "roi", "ctr", "vcr", "viewability_rate", "vcpm"]).optional(), goal_alert: z.number().gte(0).lte(999.99).optional(), goal_value: z.number().gte(0.0001).lte(9999999.9999).optional(), goal_category: z.enum(["audience", "engagement", "response"]).nullable().optional()}); export const campaignBudgetFlights = z.object({id: z.number().int().optional(), start_date: z.string().optional(), end_date: z.string().optional(), total_budget: z.number().optional(), total_impression_budget: z.number().int().gte(1).nullable().optional(), is_relevant: z.boolean().optional()}); export const campaignFrequency = z.object({frequency_type: z.enum(["even", "asap", "no-limit", "t1-optimized", "frequency_goal"]).optional(), frequency_interval: z.enum(["hour", "day", "week", "month", "not-applicable"]).min(1).nullable().optional(), frequency_amount: z.number().int().nullable().optional(), use_mm_freq: z.boolean().optional(), frequency_optimization: z.boolean().optional()}); export const campaignSiteList = z.object({id: z.number().int().optional(), name: z.string().optional(), version: z.number().int().optional(), status: z.boolean().optional(), organization_id: z.number().int().optional(), created_on: z.string().optional(), updated_on: z.string().optional(), restriction: z.string().optional(), filename: z.string().optional(), campaign_id: z.number().int().optional(), assigned: z.boolean().optional(), sites_count: z.number().int().optional(), sites_count_app: z.number().int().optional(), sites_count_domain: z.number().int().optional(), sites_count_primary_seller_id: z.number().int().optional()}); export const campaignCustomBrainSelection = z.object({id: z.number().int().optional(), version: z.number().int().optional(), campaign_id: z.number().int().optional(), selection_id: z.number().int().optional(), selection_type: z.string().optional(), active: z.boolean().optional(), enable_mm_audiences_in_brain: z.boolean().optional(), is_retired: z.boolean().optional(), full_path: z.string().optional(), owner_name: z.string().optional(), selection_name: z.string().optional(), child_count: z.number().int().optional(), parent_audience_segment_id: z.number().int().optional(), retail_cpm: z.number().optional(), uniques: z.number().int().optional(), wholesale_cpm: z.number().optional()}); export const campaignFullWithInherited = z.object({archived: z.boolean().optional(), status: z.boolean().optional(), name: z.string().min(1).max(256).optional(), service_type: z.enum(["SELF", "MANAGED"]).optional(), io_name: z.string().max(256).optional(), io_reference_num: z.string().max(32).optional(), is_programmatic_guaranteed: z.boolean().optional(), political: z.boolean().optional(), source_campaign_id: z.number().int().nullable().optional(), zone_name: z.string().min(1).optional(), viewability: campaignViewability.optional(), identity: campaignIdentity.optional(), ad_server: campaignAdServer.optional(), pacing: campaignPacing.optional(), attribution: campaignAttribution.optional(), vendor_contracts: z.array(vendorContractBase).optional(), mfa_avoidance: z.enum(["INHERIT", "ALLOW_ALL", "EXCLUDE_MFA"]).optional(), targeting_identity_level: z.enum(["INHERIT", "INDIVIDUAL", "HOUSEHOLD"]).optional(), id: z.number().int().optional(), entity_type: z.string().optional(), version: z.number().int().optional(), advertiser_id: z.number().int().optional(), created_on: z.string().optional(), updated_on: z.string().optional(), locked_on: z.string().nullable().optional(), v3_usage: z.boolean().optional(), duration: z.object({start_date: z.string().optional(), end_date: z.string().optional(), initial_start_date: z.string().optional()}).optional(), goals: campaignGoals.optional(), budget: z.object({total_budget: z.number().nullable().optional(), total_impression_budget: z.number().int().gte(1).nullable().optional(), currency_code: z.string().min(3).max(3).optional(), margin_pct: z.number().gte(0).lte(9999999.9999).optional(), dynamic_budget_allocation_type: z.enum(["SBA_AUTO_ALLOCATION", "SBA_RECOMMENDATIONS_ONLY", "OFF"]).optional(), dynamic_budget_allocation_applied: z.string().optional(), dynamic_budget_allocation_available: z.string().optional(), flights: z.array(campaignBudgetFlights).optional()}).optional(), frequency: campaignFrequency.optional(), inventory: z.object({ads_txt_verified: z.enum(["ANY", "AUTHORIZED_ONLY", "AUTHORIZED_DIRECT_ONLY", "NONE"]).nullable().optional(), minimize_multi_ads: z.boolean().optional(), override_suspicious_traffic_filter: z.boolean().optional(), suspicious_traffic_filter_level: z.number().int().gte(0).lte(100).optional(), dcs_data_is_campaign_level: z.boolean().optional(), restrict_targeting_to_deterministic_id: z.boolean().optional(), restrict_targeting_to_same_device_id: z.boolean().optional(), effective_ads_txt_verified: z.enum(["ANY", "AUTHORIZED_ONLY", "AUTHORIZED_DIRECT_ONLY", "NONE"]).min(1).optional()}).optional(), site_lists: z.array(campaignSiteList).optional(), custom_brain_selections: z.array(campaignCustomBrainSelection).optional(), strategies: z.object({count: z.number().int().optional(), strategies_list: z.array(z.number().int()).optional(), distinct_strategy_goal_types: z.array(z.enum(["spend", "reach", "cpc", "cpe", "cpa", "roi", "ctr", "vcr", "viewability_rate", "vcpm"])).optional()}).optional(), strategy_groups: z.object({count: z.number().int().optional(), strategy_groups_list: z.array(z.string()).optional()}).optional(), inherited_mfa_avoidance: z.enum(["INHERIT", "ALLOW_ALL", "EXCLUDE_MFA"]).optional(), inherited_mfa_from: z.enum(["Organization", "Agency", "Advertiser", "Campaign"]).optional(), inherited_targeting_identity_level: z.enum(["INDIVIDUAL", "HOUSEHOLD"]).optional()}); export const singleMetadata = z.object({status: z.string()}); export const createApiCampaignsResponse = z.object({data: campaignFullWithInherited.optional(), meta: singleMetadata.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Create a Campaign * * POST /campaigns */ export const createApiCampaigns = async (args: CreateApiCampaignsArgs, options?: CreateApiCampaignsOptions) => { const {baseUrl = "https://api.mediamath.com/api/v3.0", fetch: fetchFn = fetch, Auth0} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (Auth0 !== undefined) headers.set('authorization', `Bearer ${Auth0}`) const url = `${baseUrl.replace(/\/+$/, '')}/campaigns${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiCampaignsResponse, await res.json()) };