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

    Variable GetProductsAsyncInputRequiredSchemaConst

    GetProductsAsyncInputRequiredSchema: ZodObject<
        {
            reason: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodLiteral<"CLARIFICATION_NEEDED">,
                        ZodLiteral<"BUDGET_REQUIRED">,
                    ],
                >,
            >;
            partial_results: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            product_id: ZodString;
                            name: ZodString;
                            description: ZodString;
                            publisher_properties: ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodObject<
                                            { publisher_domain: ...; selection_type: ... },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                publisher_domain: ...;
                                                selection_type: ...;
                                                property_ids: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                publisher_domain: ...;
                                                selection_type: ...;
                                                property_tags: ...;
                                            },
                                            $loose,
                                        >,
                                    ],
                                >,
                            >;
                            channels: ZodOptional<
                                ZodArray<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            format_ids: ZodArray<
                                ZodObject<
                                    {
                                        agent_url: ZodString;
                                        id: ZodString;
                                        width: ZodOptional<ZodNumber>;
                                        height: ZodOptional<ZodNumber>;
                                        duration_ms: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >;
                            placements: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            placement_id: ZodString;
                                            name: ZodString;
                                            description: ZodOptional<(...)>;
                                            tags: ZodOptional<(...)>;
                                            format_ids: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            delivery_type: ZodUnion<
                                readonly [ZodLiteral<"guaranteed">, ZodLiteral<"non_guaranteed">],
                            >;
                            exclusivity: ZodOptional<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"none">,
                                        ZodLiteral<"category">,
                                        ZodLiteral<"exclusive">,
                                    ],
                                >,
                            >;
                            pricing_options: ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                max_bid: ...;
                                                price_guidance: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                max_bid: ...;
                                                price_guidance: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                max_bid: ...;
                                                price_guidance: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                max_bid: ...;
                                                price_guidance: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                max_bid: ...;
                                                price_guidance: ...;
                                                parameters: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                price_guidance: ...;
                                                parameters: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                event_type: ...;
                                                custom_event_name: ...;
                                                event_source_id: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                price_guidance: ...;
                                                parameters: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                pricing_option_id: ...;
                                                pricing_model: ...;
                                                currency: ...;
                                                fixed_price: ...;
                                                floor_price: ...;
                                                price_guidance: ...;
                                                parameters: ...;
                                                min_spend_per_package: ...;
                                                price_breakdown: ...;
                                                eligible_adjustments: ...;
                                            },
                                            $loose,
                                        >,
                                    ],
                                >,
                            >;
                            forecast: ZodOptional<
                                ZodObject<
                                    {
                                        points: ZodArray<ZodObject<(...), (...)>>;
                                        forecast_range_unit: ZodOptional<ZodUnion<(...)>>;
                                        method: ZodUnion<readonly [(...), (...), (...)]>;
                                        currency: ZodString;
                                        demographic_system: ZodOptional<ZodUnion<(...)>>;
                                        demographic: ZodOptional<ZodString>;
                                        measurement_source: ZodOptional<ZodString>;
                                        reach_unit: ZodOptional<ZodUnion<(...)>>;
                                        generated_at: ZodOptional<ZodISODateTime>;
                                        valid_until: ZodOptional<ZodISODateTime>;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            >;
                            outcome_measurement: ZodOptional<
                                ZodObject<
                                    {
                                        type: ZodString;
                                        attribution: ZodString;
                                        window: ZodOptional<ZodObject<(...), (...)>>;
                                        reporting: ZodString;
                                    },
                                    $loose,
                                >,
                            >;
                            delivery_measurement: ZodOptional<
                                ZodObject<
                                    { provider: ZodString; notes: ZodOptional<ZodString> },
                                    $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,
                                    >,
                                >,
                            >;
                            cancellation_policy: ZodOptional<
                                ZodObject<
                                    {
                                        notice_period: ZodObject<{ interval: ...; unit: ... }, $loose>;
                                        cancellation_fee: ZodObject<
                                            { type: ...; rate: ...; amount: ... },
                                            $loose,
                                        >;
                                    },
                                    $loose,
                                >,
                            >;
                            reporting_capabilities: ZodObject<
                                {
                                    available_reporting_frequencies: ZodArray<
                                        ZodUnion<readonly [(...), (...), (...)]>,
                                    >;
                                    expected_delay_minutes: ZodNumber;
                                    timezone: ZodString;
                                    supports_webhooks: ZodBoolean;
                                    available_metrics: ZodArray<
                                        ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >,
                                    >;
                                    supports_creative_breakdown: ZodOptional<ZodBoolean>;
                                    supports_keyword_breakdown: ZodOptional<ZodBoolean>;
                                    supports_geo_breakdown: ZodOptional<
                                        ZodObject<
                                            { country: ...; region: ...; metro: ...; postal_area: ... },
                                            $loose,
                                        >,
                                    >;
                                    supports_device_type_breakdown: ZodOptional<ZodBoolean>;
                                    supports_device_platform_breakdown: ZodOptional<ZodBoolean>;
                                    supports_audience_breakdown: ZodOptional<ZodBoolean>;
                                    supports_placement_breakdown: ZodOptional<ZodBoolean>;
                                    date_range_support: ZodUnion<
                                        readonly [ZodLiteral<(...)>, ZodLiteral<(...)>],
                                    >;
                                    measurement_windows: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                },
                                $loose,
                            >;
                            creative_policy: ZodOptional<
                                ZodObject<
                                    {
                                        co_branding: ZodUnion<readonly [(...), (...), (...)]>;
                                        landing_page: ZodUnion<readonly [(...), (...), (...)]>;
                                        templates_available: ZodBoolean;
                                        provenance_required: ZodOptional<ZodBoolean>;
                                    },
                                    $loose,
                                >,
                            >;
                            is_custom: ZodOptional<ZodBoolean>;
                            property_targeting_allowed: ZodOptional<ZodBoolean>;
                            data_provider_signals: ZodOptional<
                                ZodArray<
                                    ZodUnion<
                                        readonly [
                                            ZodObject<(...), (...)>,
                                            ZodObject<(...), (...)>,
                                            ZodObject<(...), (...)>,
                                        ],
                                    >,
                                >,
                            >;
                            signal_targeting_allowed: ZodOptional<ZodBoolean>;
                            catalog_types: ZodOptional<
                                ZodArray<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            metric_optimization: ZodOptional<
                                ZodObject<
                                    {
                                        supported_metrics: ZodArray<ZodUnion<(...)>>;
                                        supported_reach_units: ZodOptional<ZodArray<(...)>>;
                                        supported_view_durations: ZodOptional<ZodArray<(...)>>;
                                        supported_targets: ZodOptional<ZodArray<(...)>>;
                                    },
                                    $loose,
                                >,
                            >;
                            max_optimization_goals: ZodOptional<ZodNumber>;
                            measurement_readiness: ZodOptional<
                                ZodObject<
                                    {
                                        status: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        required_event_types: ZodOptional<ZodArray<(...)>>;
                                        missing_event_types: ZodOptional<ZodArray<(...)>>;
                                        issues: ZodOptional<ZodArray<(...)>>;
                                        notes: ZodOptional<ZodString>;
                                    },
                                    $loose,
                                >,
                            >;
                            conversion_tracking: ZodOptional<
                                ZodObject<
                                    {
                                        action_sources: ZodOptional<ZodArray<(...)>>;
                                        supported_targets: ZodOptional<ZodArray<(...)>>;
                                        platform_managed: ZodOptional<ZodBoolean>;
                                    },
                                    $loose,
                                >,
                            >;
                            catalog_match: ZodOptional<
                                ZodObject<
                                    {
                                        matched_gtins: ZodOptional<ZodArray<(...)>>;
                                        matched_ids: ZodOptional<ZodArray<(...)>>;
                                        matched_count: ZodOptional<ZodNumber>;
                                        submitted_count: ZodNumber;
                                    },
                                    $loose,
                                >,
                            >;
                            brief_relevance: ZodOptional<ZodString>;
                            expires_at: ZodOptional<ZodISODateTime>;
                            product_card: ZodOptional<
                                ZodObject<
                                    {
                                        format_id: ZodObject<
                                            {
                                                agent_url: ...;
                                                id: ...;
                                                width: ...;
                                                height: ...;
                                                duration_ms: ...;
                                            },
                                            $loose,
                                        >;
                                        manifest: ZodObject<{}, $loose>;
                                    },
                                    $loose,
                                >,
                            >;
                            product_card_detailed: ZodOptional<
                                ZodObject<
                                    {
                                        format_id: ZodObject<
                                            {
                                                agent_url: ...;
                                                id: ...;
                                                width: ...;
                                                height: ...;
                                                duration_ms: ...;
                                            },
                                            $loose,
                                        >;
                                        manifest: ZodObject<{}, $loose>;
                                    },
                                    $loose,
                                >,
                            >;
                            collections: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        { publisher_domain: ZodString; collection_ids: ZodArray<(...)> },
                                        $loose,
                                    >,
                                >,
                            >;
                            collection_targeting_allowed: ZodOptional<ZodBoolean>;
                            installments: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            installment_id: ZodString;
                                            collection_id: ZodOptional<(...)>;
                                            name: ZodOptional<(...)>;
                                            season: ZodOptional<(...)>;
                                            installment_number: ZodOptional<(...)>;
                                            scheduled_at: ZodOptional<(...)>;
                                            status: ZodOptional<(...)>;
                                            duration_seconds: ZodOptional<(...)>;
                                            flexible_end: ZodOptional<(...)>;
                                            valid_until: ZodOptional<(...)>;
                                            content_rating: ZodOptional<(...)>;
                                            topics: ZodOptional<(...)>;
                                            special: ZodOptional<(...)>;
                                            guest_talent: ZodOptional<(...)>;
                                            ad_inventory: ZodOptional<(...)>;
                                            deadlines: ZodOptional<(...)>;
                                            derivative_of: ZodOptional<(...)>;
                                            ext: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            enforced_policies: ZodOptional<ZodArray<ZodString>>;
                            trusted_match: ZodOptional<
                                ZodObject<
                                    {
                                        context_match: ZodBoolean;
                                        identity_match: ZodOptional<ZodBoolean>;
                                        response_types: ZodOptional<ZodArray<(...)>>;
                                        dynamic_brands: ZodOptional<ZodBoolean>;
                                        providers: ZodOptional<ZodArray<(...)>>;
                                    },
                                    $loose,
                                >,
                            >;
                            material_submission: ZodOptional<
                                ZodObject<
                                    {
                                        url: ZodOptional<ZodString>;
                                        email: ZodOptional<ZodEmail>;
                                        instructions: ZodOptional<ZodString>;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            >;
                            ext: ZodOptional<ZodObject<{}, $loose>>;
                        },
                        $loose,
                    >,
                >,
            >;
            suggestions: ZodOptional<ZodArray<ZodString>>;
            context: ZodOptional<ZodObject<{}, $loose>>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...