@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Variable CreateMediaBuyRequestSchemaConst

    CreateMediaBuyRequestSchema: ZodObject<
        {
            adcp_major_version: ZodOptional<ZodNumber>;
            idempotency_key: ZodString;
            plan_id: ZodOptional<ZodString>;
            account: ZodUnion<
                readonly [
                    ZodObject<{ account_id: ZodString }, $loose>,
                    ZodObject<
                        {
                            brand: ZodObject<
                                {
                                    domain: ZodString;
                                    brand_id: ZodOptional<ZodString>;
                                    industries: ZodOptional<ZodArray<ZodString>>;
                                    data_subject_contestation: ZodOptional<
                                        ZodRecord<ZodString, ZodUnknown>,
                                    >;
                                },
                                $loose,
                            >;
                            operator: ZodString;
                            sandbox: ZodOptional<ZodBoolean>;
                        },
                        $loose,
                    >,
                ],
            >;
            proposal_id: ZodOptional<ZodString>;
            total_budget: ZodOptional<
                ZodObject<{ amount: ZodNumber; currency: ZodString }, $loose>,
            >;
            packages: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            adcp_major_version: ZodOptional<ZodNumber>;
                            product_id: ZodString;
                            format_ids: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            agent_url: ZodString;
                                            id: ZodString;
                                            width: ZodOptional<(...)>;
                                            height: ZodOptional<(...)>;
                                            duration_ms: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            budget: ZodNumber;
                            pacing: ZodOptional<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"even">,
                                        ZodLiteral<"asap">,
                                        ZodLiteral<"front_loaded">,
                                    ],
                                >,
                            >;
                            pricing_option_id: ZodString;
                            bid_price: ZodOptional<ZodNumber>;
                            impressions: ZodOptional<ZodNumber>;
                            start_time: ZodOptional<ZodISODateTime>;
                            end_time: ZodOptional<ZodISODateTime>;
                            paused: ZodOptional<ZodBoolean>;
                            catalogs: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            catalog_id: ZodOptional<(...)>;
                                            name: ZodOptional<(...)>;
                                            type: ZodUnion<(...)>;
                                            url: ZodOptional<(...)>;
                                            feed_format: ZodOptional<(...)>;
                                            update_frequency: ZodOptional<(...)>;
                                            items: ZodOptional<(...)>;
                                            ids: ZodOptional<(...)>;
                                            gtins: ZodOptional<(...)>;
                                            tags: ZodOptional<(...)>;
                                            category: ZodOptional<(...)>;
                                            query: ZodOptional<(...)>;
                                            conversion_events: ZodOptional<(...)>;
                                            content_id_type: ZodOptional<(...)>;
                                            feed_field_mappings: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            optimization_goals: ZodOptional<
                                ZodArray<
                                    ZodUnion<
                                        readonly [ZodObject<(...), (...)>, ZodObject<(...), (...)>],
                                    >,
                                >,
                            >;
                            targeting_overlay: ZodOptional<
                                ZodObject<
                                    {
                                        geo_countries: ZodOptional<ZodArray<(...)>>;
                                        geo_countries_exclude: ZodOptional<ZodArray<(...)>>;
                                        geo_regions: ZodOptional<ZodArray<(...)>>;
                                        geo_regions_exclude: ZodOptional<ZodArray<(...)>>;
                                        geo_metros: ZodOptional<ZodArray<(...)>>;
                                        geo_metros_exclude: ZodOptional<ZodArray<(...)>>;
                                        geo_postal_areas: ZodOptional<ZodArray<(...)>>;
                                        geo_postal_areas_exclude: ZodOptional<ZodArray<(...)>>;
                                        daypart_targets: ZodOptional<ZodArray<(...)>>;
                                        axe_include_segment: ZodOptional<ZodString>;
                                        axe_exclude_segment: ZodOptional<ZodString>;
                                        audience_include: ZodOptional<ZodArray<(...)>>;
                                        audience_exclude: ZodOptional<ZodArray<(...)>>;
                                        frequency_cap: ZodOptional<ZodObject<(...), (...)>>;
                                        property_list: ZodOptional<ZodObject<(...), (...)>>;
                                        collection_list: ZodOptional<ZodObject<(...), (...)>>;
                                        collection_list_exclude: ZodOptional<ZodObject<(...), (...)>>;
                                        age_restriction: ZodOptional<ZodObject<(...), (...)>>;
                                        device_platform: ZodOptional<ZodArray<(...)>>;
                                        device_type: ZodOptional<ZodArray<(...)>>;
                                        device_type_exclude: ZodOptional<ZodArray<(...)>>;
                                        store_catchments: ZodOptional<ZodArray<(...)>>;
                                        geo_proximity: ZodOptional<ZodArray<(...)>>;
                                        language: ZodOptional<ZodArray<(...)>>;
                                        keyword_targets: ZodOptional<ZodArray<(...)>>;
                                        negative_keywords: ZodOptional<ZodArray<(...)>>;
                                    },
                                    $loose,
                                >,
                            >;
                            measurement_terms: ZodOptional<
                                ZodObject<
                                    {
                                        billing_measurement: ZodOptional<ZodObject<(...), (...)>>;
                                        makegood_policy: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            >;
                            performance_standards: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            metric: ZodUnion<(...)>;
                                            threshold: ZodNumber;
                                            standard: ZodOptional<(...)>;
                                            vendor: ZodObject<(...), (...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            creative_assignments: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            creative_id: ZodString;
                                            weight: ZodOptional<(...)>;
                                            placement_ids: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            creatives: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            creative_id: ZodString;
                                            name: ZodString;
                                            format_id: ZodObject<(...), (...)>;
                                            assets: ZodRecord<(...), (...)>;
                                            inputs: ZodOptional<(...)>;
                                            tags: ZodOptional<(...)>;
                                            status: ZodOptional<(...)>;
                                            weight: ZodOptional<(...)>;
                                            placement_ids: ZodOptional<(...)>;
                                            industry_identifiers: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            agency_estimate_number: ZodOptional<ZodString>;
                            context: ZodOptional<ZodObject<{}, $loose>>;
                            ext: ZodOptional<ZodObject<{}, $loose>>;
                        },
                        $loose,
                    >,
                >,
            >;
            brand: ZodObject<
                {
                    domain: ZodString;
                    brand_id: ZodOptional<ZodString>;
                    industries: ZodOptional<ZodArray<ZodString>>;
                    data_subject_contestation: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
                },
                $loose,
            >;
            advertiser_industry: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodLiteral<"automotive">,
                        ZodLiteral<"automotive.electric_vehicles">,
                        ZodLiteral<"automotive.parts_accessories">,
                        ZodLiteral<"automotive.luxury">,
                        ZodLiteral<"beauty_cosmetics">,
                        ZodLiteral<"beauty_cosmetics.skincare">,
                        ZodLiteral<"beauty_cosmetics.fragrance">,
                        ZodLiteral<"beauty_cosmetics.haircare">,
                        ZodLiteral<"cannabis">,
                        ZodLiteral<"cpg">,
                        ZodLiteral<"cpg.personal_care">,
                        ZodLiteral<"cpg.household">,
                        ZodLiteral<"dating">,
                        ZodLiteral<"education">,
                        ZodLiteral<"education.higher_education">,
                        ZodLiteral<"education.online_learning">,
                        ZodLiteral<"education.k12">,
                        ZodLiteral<"energy_utilities">,
                        ZodLiteral<"energy_utilities.renewable">,
                        ZodLiteral<"fashion_apparel">,
                        ZodLiteral<"fashion_apparel.luxury">,
                        ZodLiteral<"fashion_apparel.sportswear">,
                        ZodLiteral<"finance">,
                        ZodLiteral<"finance.banking">,
                        ZodLiteral<"finance.insurance">,
                        ZodLiteral<"finance.investment">,
                        ZodLiteral<"finance.cryptocurrency">,
                        ZodLiteral<"food_beverage">,
                        ZodLiteral<"food_beverage.alcohol">,
                        ZodLiteral<"food_beverage.restaurants">,
                        ZodLiteral<"food_beverage.packaged_goods">,
                        ZodLiteral<"gambling_betting">,
                        ZodLiteral<"gambling_betting.sports_betting">,
                        ZodLiteral<"gambling_betting.casino">,
                        ZodLiteral<"gaming">,
                        ZodLiteral<"gaming.mobile">,
                        ZodLiteral<"gaming.console_pc">,
                        ZodLiteral<"gaming.esports">,
                        ZodLiteral<"government_nonprofit">,
                        ZodLiteral<"government_nonprofit.political">,
                        ZodLiteral<"government_nonprofit.charity">,
                        ZodLiteral<"healthcare">,
                        ZodLiteral<"healthcare.pharmaceutical">,
                        ZodLiteral<"healthcare.medical_devices">,
                        ZodLiteral<"healthcare.wellness">,
                        ZodLiteral<"home_garden">,
                        ZodLiteral<"home_garden.furniture">,
                        ZodLiteral<"home_garden.home_improvement">,
                        ZodLiteral<"media_entertainment">,
                        ZodLiteral<"media_entertainment.podcasts">,
                        ZodLiteral<"media_entertainment.music">,
                        ZodLiteral<"media_entertainment.film_tv">,
                        ZodLiteral<"media_entertainment.publishing">,
                        ZodLiteral<"media_entertainment.live_events">,
                        ZodLiteral<"pets">,
                        ZodLiteral<"professional_services">,
                        ZodLiteral<"professional_services.legal">,
                        ZodLiteral<"professional_services.consulting">,
                        ZodLiteral<"real_estate">,
                        ZodLiteral<"real_estate.residential">,
                        ZodLiteral<"real_estate.commercial">,
                        ZodLiteral<"recruitment_hr">,
                        ZodLiteral<"retail">,
                        ZodLiteral<"retail.ecommerce">,
                        ZodLiteral<"retail.department_stores">,
                        ZodLiteral<"sports_fitness">,
                        ZodLiteral<"sports_fitness.equipment">,
                        ZodLiteral<"sports_fitness.teams_leagues">,
                        ZodLiteral<"technology">,
                        ZodLiteral<"technology.software">,
                        ZodLiteral<"technology.hardware">,
                        ZodLiteral<"technology.ai_ml">,
                        ZodLiteral<"telecom">,
                        ZodLiteral<"telecom.mobile_carriers">,
                        ZodLiteral<"telecom.internet_providers">,
                        ZodLiteral<"transportation_logistics">,
                        ZodLiteral<"travel_hospitality">,
                        ZodLiteral<"travel_hospitality.airlines">,
                        ZodLiteral<"travel_hospitality.hotels">,
                        ZodLiteral<"travel_hospitality.cruise">,
                        ZodLiteral<"travel_hospitality.tourism">,
                    ],
                >,
            >;
            invoice_recipient: ZodOptional<
                ZodObject<
                    {
                        legal_name: ZodString;
                        vat_id: ZodOptional<ZodString>;
                        tax_id: ZodOptional<ZodString>;
                        registration_number: ZodOptional<ZodString>;
                        address: ZodOptional<
                            ZodObject<
                                {
                                    street: ZodString;
                                    city: ZodString;
                                    postal_code: ZodString;
                                    region: ZodOptional<ZodString>;
                                    country: ZodString;
                                },
                                $loose,
                            >,
                        >;
                        contacts: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        role: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        name: ZodOptional<ZodString>;
                                        email: ZodOptional<ZodEmail>;
                                        phone: ZodOptional<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        bank: ZodOptional<
                            ZodObject<
                                {
                                    account_holder: ZodString;
                                    iban: ZodOptional<ZodString>;
                                    bic: ZodOptional<ZodString>;
                                    routing_number: ZodOptional<ZodString>;
                                    account_number: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        ext: ZodOptional<ZodObject<{}, $loose>>;
                    },
                    $loose,
                >,
            >;
            io_acceptance: ZodOptional<
                ZodObject<
                    {
                        io_id: ZodString;
                        accepted_at: ZodISODateTime;
                        signatory: ZodString;
                        signature_id: ZodOptional<ZodString>;
                    },
                    $loose,
                >,
            >;
            po_number: ZodOptional<ZodString>;
            agency_estimate_number: ZodOptional<ZodString>;
            start_time: ZodUnion<readonly [ZodLiteral<"asap">, ZodString]>;
            end_time: ZodISODateTime;
            push_notification_config: ZodOptional<
                ZodObject<
                    {
                        url: ZodString;
                        token: ZodOptional<ZodString>;
                        authentication: ZodOptional<
                            ZodObject<
                                {
                                    schemes: ZodArray<ZodUnion<readonly [(...), (...)]>>;
                                    credentials: ZodString;
                                },
                                $loose,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
            reporting_webhook: ZodOptional<
                ZodObject<
                    {
                        url: ZodString;
                        token: ZodOptional<ZodString>;
                        authentication: ZodObject<
                            {
                                schemes: ZodArray<
                                    ZodUnion<readonly [ZodLiteral<(...)>, ZodLiteral<(...)>]>,
                                >;
                                credentials: ZodString;
                            },
                            $loose,
                        >;
                        reporting_frequency: ZodUnion<
                            readonly [
                                ZodLiteral<"hourly">,
                                ZodLiteral<"daily">,
                                ZodLiteral<"monthly">,
                            ],
                        >;
                        requested_metrics: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"impressions">,
                                        ZodLiteral<"spend">,
                                        ZodLiteral<"clicks">,
                                        ZodLiteral<"ctr">,
                                        ZodLiteral<"video_completions">,
                                        ZodLiteral<"completion_rate">,
                                        ZodLiteral<"conversions">,
                                        ZodLiteral<"conversion_value">,
                                        ZodLiteral<"roas">,
                                        ZodLiteral<"cost_per_acquisition">,
                                        ZodLiteral<"new_to_brand_rate">,
                                        ZodLiteral<"viewability">,
                                        ZodLiteral<"engagement_rate">,
                                        ZodLiteral<"views">,
                                        ZodLiteral<"completed_views">,
                                        ZodLiteral<"leads">,
                                        ZodLiteral<"reach">,
                                        ZodLiteral<"frequency">,
                                        ZodLiteral<"grps">,
                                        ZodLiteral<"quartile_data">,
                                        ZodLiteral<"dooh_metrics">,
                                        ZodLiteral<"cost_per_click">,
                                    ],
                                >,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
            artifact_webhook: ZodOptional<
                ZodObject<
                    {
                        url: ZodString;
                        token: ZodOptional<ZodString>;
                        authentication: ZodObject<
                            {
                                schemes: ZodArray<
                                    ZodUnion<readonly [ZodLiteral<(...)>, ZodLiteral<(...)>]>,
                                >;
                                credentials: ZodString;
                            },
                            $loose,
                        >;
                        delivery_mode: ZodUnion<
                            readonly [ZodLiteral<"realtime">, ZodLiteral<"batched">],
                        >;
                        batch_frequency: ZodOptional<
                            ZodUnion<readonly [ZodLiteral<"hourly">, ZodLiteral<"daily">]>,
                        >;
                        sampling_rate: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
            context: ZodOptional<ZodObject<{}, $loose>>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...