@adcp/client API Reference - v4.19.0
    Preparing search index...

    Variable GetProductsResponseSchemaConst

    GetProductsResponseSchema: ZodObject<
        {
            products: ZodArray<
                ZodObject<
                    {
                        product_id: ZodString;
                        name: ZodString;
                        description: ZodString;
                        publisher_properties: ZodArray<
                            ZodUnion<
                                readonly [
                                    ZodObject<
                                        {
                                            publisher_domain: ZodString;
                                            selection_type: ZodLiteral<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            publisher_domain: ZodString;
                                            selection_type: ZodLiteral<(...)>;
                                            property_ids: ZodArray<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            publisher_domain: ZodString;
                                            selection_type: ZodLiteral<(...)>;
                                            property_tags: ZodArray<(...)>;
                                        },
                                        $loose,
                                    >,
                                ],
                            >,
                        >;
                        channels: ZodOptional<
                            ZodNullable<
                                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<ZodNullable<ZodNumber>>;
                                    height: ZodOptional<ZodNullable<ZodNumber>>;
                                    duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                                },
                                $loose,
                            >,
                        >;
                        placements: ZodOptional<
                            ZodNullable<
                                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<
                            ZodNullable<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"none">,
                                        ZodLiteral<"category">,
                                        ZodLiteral<"exclusive">,
                                    ],
                                >,
                            >,
                        >;
                        pricing_options: ZodArray<
                            ZodUnion<
                                readonly [
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            max_bid: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            max_bid: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            max_bid: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            max_bid: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            max_bid: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            parameters: ZodObject<(...), (...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            parameters: ZodObject<(...), (...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            event_type: ZodUnion<(...)>;
                                            custom_event_name: ZodOptional<(...)>;
                                            event_source_id: ZodOptional<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodNumber;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            parameters: ZodOptional<(...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            pricing_option_id: ZodString;
                                            pricing_model: ZodLiteral<(...)>;
                                            currency: ZodString;
                                            fixed_price: ZodOptional<(...)>;
                                            floor_price: ZodOptional<(...)>;
                                            price_guidance: ZodOptional<(...)>;
                                            parameters: ZodObject<(...), (...)>;
                                            min_spend_per_package: ZodOptional<(...)>;
                                            price_breakdown: ZodOptional<(...)>;
                                            eligible_adjustments: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                ],
                            >,
                        >;
                        forecast: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        points: ZodArray<ZodObject<(...), (...)>>;
                                        forecast_range_unit: ZodOptional<ZodNullable<(...)>>;
                                        method: ZodUnion<readonly [(...), (...), (...)]>;
                                        currency: ZodString;
                                        demographic_system: ZodOptional<ZodNullable<(...)>>;
                                        demographic: ZodOptional<ZodNullable<(...)>>;
                                        reach_unit: ZodOptional<ZodNullable<(...)>>;
                                        generated_at: ZodOptional<ZodNullable<(...)>>;
                                        valid_until: ZodOptional<ZodNullable<(...)>>;
                                        ext: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        outcome_measurement: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        type: ZodString;
                                        attribution: ZodString;
                                        window: ZodOptional<ZodNullable<(...)>>;
                                        reporting: ZodString;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        delivery_measurement: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    { provider: ZodString; notes: ZodOptional<ZodNullable<(...)>> },
                                    $loose,
                                >,
                            >,
                        >;
                        reporting_capabilities: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        available_reporting_frequencies: ZodArray<ZodUnion<(...)>>;
                                        expected_delay_minutes: ZodNumber;
                                        timezone: ZodString;
                                        supports_webhooks: ZodBoolean;
                                        available_metrics: ZodArray<ZodUnion<(...)>>;
                                        supports_creative_breakdown: ZodOptional<ZodNullable<(...)>>;
                                        supports_keyword_breakdown: ZodOptional<ZodNullable<(...)>>;
                                        supports_geo_breakdown: ZodOptional<ZodNullable<(...)>>;
                                        supports_device_type_breakdown: ZodOptional<ZodNullable<(...)>>;
                                        supports_device_platform_breakdown: ZodOptional<ZodNullable<(...)>>;
                                        supports_audience_breakdown: ZodOptional<ZodNullable<(...)>>;
                                        supports_placement_breakdown: ZodOptional<ZodNullable<(...)>>;
                                        date_range_support: ZodUnion<readonly [(...), (...)]>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        creative_policy: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        co_branding: ZodUnion<readonly [(...), (...), (...)]>;
                                        landing_page: ZodUnion<readonly [(...), (...), (...)]>;
                                        templates_available: ZodBoolean;
                                        provenance_required: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        is_custom: ZodOptional<ZodNullable<ZodBoolean>>;
                        property_targeting_allowed: ZodOptional<ZodNullable<ZodBoolean>>;
                        data_provider_signals: ZodOptional<
                            ZodNullable<
                                ZodArray<
                                    ZodUnion<
                                        readonly [
                                            ZodObject<(...), (...)>,
                                            ZodObject<(...), (...)>,
                                            ZodObject<(...), (...)>,
                                        ],
                                    >,
                                >,
                            >,
                        >;
                        signal_targeting_allowed: ZodOptional<ZodNullable<ZodBoolean>>;
                        catalog_types: ZodOptional<
                            ZodNullable<
                                ZodArray<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >,
                        >;
                        metric_optimization: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        supported_metrics: ZodArray<ZodUnion<(...)>>;
                                        supported_reach_units: ZodOptional<ZodNullable<(...)>>;
                                        supported_view_durations: ZodOptional<ZodNullable<(...)>>;
                                        supported_targets: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        max_optimization_goals: ZodOptional<ZodNullable<ZodNumber>>;
                        measurement_readiness: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        status: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        required_event_types: ZodOptional<ZodNullable<(...)>>;
                                        missing_event_types: ZodOptional<ZodNullable<(...)>>;
                                        issues: ZodOptional<ZodNullable<(...)>>;
                                        notes: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        conversion_tracking: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        action_sources: ZodOptional<ZodNullable<(...)>>;
                                        supported_targets: ZodOptional<ZodNullable<(...)>>;
                                        platform_managed: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        catalog_match: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        matched_gtins: ZodOptional<ZodNullable<(...)>>;
                                        matched_ids: ZodOptional<ZodNullable<(...)>>;
                                        matched_count: ZodOptional<ZodNullable<(...)>>;
                                        submitted_count: ZodNumber;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        brief_relevance: ZodOptional<ZodNullable<ZodString>>;
                        expires_at: ZodOptional<ZodNullable<ZodString>>;
                        product_card: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        format_id: ZodObject<
                                            {
                                                agent_url: ...;
                                                id: ...;
                                                width: ...;
                                                height: ...;
                                                duration_ms: ...;
                                            },
                                            $loose,
                                        >;
                                        manifest: ZodObject<{}, $loose>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        product_card_detailed: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        format_id: ZodObject<
                                            {
                                                agent_url: ...;
                                                id: ...;
                                                width: ...;
                                                height: ...;
                                                duration_ms: ...;
                                            },
                                            $loose,
                                        >;
                                        manifest: ZodObject<{}, $loose>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        collections: ZodOptional<
                            ZodNullable<
                                ZodArray<
                                    ZodObject<
                                        { publisher_domain: ZodString; collection_ids: ZodArray<(...)> },
                                        $loose,
                                    >,
                                >,
                            >,
                        >;
                        collection_targeting_allowed: ZodOptional<ZodNullable<ZodBoolean>>;
                        installments: ZodOptional<
                            ZodNullable<
                                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<ZodNullable<ZodArray<ZodString>>>;
                        trusted_match: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        context_match: ZodBoolean;
                                        identity_match: ZodOptional<ZodNullable<(...)>>;
                                        response_types: ZodOptional<ZodNullable<(...)>>;
                                        dynamic_brands: ZodOptional<ZodNullable<(...)>>;
                                        providers: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        material_submission: ZodOptional<
                            ZodNullable<
                                ZodObject<
                                    {
                                        url: ZodOptional<ZodNullable<(...)>>;
                                        email: ZodOptional<ZodNullable<(...)>>;
                                        instructions: ZodOptional<ZodNullable<(...)>>;
                                        ext: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        ext: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
                    },
                    $loose,
                >,
            >;
            proposals: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodObject<
                            {
                                proposal_id: ZodString;
                                name: ZodString;
                                description: ZodOptional<ZodNullable<ZodString>>;
                                allocations: ZodArray<
                                    ZodObject<
                                        {
                                            product_id: ZodString;
                                            allocation_percentage: ZodNumber;
                                            pricing_option_id: ZodOptional<(...)>;
                                            rationale: ZodOptional<(...)>;
                                            sequence: ZodOptional<(...)>;
                                            tags: ZodOptional<(...)>;
                                            start_time: ZodOptional<(...)>;
                                            end_time: ZodOptional<(...)>;
                                            daypart_targets: ZodOptional<(...)>;
                                            forecast: ZodOptional<(...)>;
                                            ext: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >;
                                proposal_status: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...)]>>,
                                >;
                                expires_at: ZodOptional<ZodNullable<ZodString>>;
                                insertion_order: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                io_id: ...;
                                                terms: ...;
                                                terms_url: ...;
                                                signing_url: ...;
                                                requires_signature: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                                total_budget_guidance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            { min: ...; recommended: ...; max: ...; currency: ... },
                                            $loose,
                                        >,
                                    >,
                                >;
                                brief_alignment: ZodOptional<ZodNullable<ZodString>>;
                                forecast: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                points: ...;
                                                forecast_range_unit: ...;
                                                method: ...;
                                                currency: ...;
                                                demographic_system: ...;
                                                demographic: ...;
                                                reach_unit: ...;
                                                generated_at: ...;
                                                valid_until: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                                ext: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            errors: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodObject<
                            {
                                code: ZodString;
                                message: ZodString;
                                field: ZodOptional<ZodNullable<ZodString>>;
                                suggestion: ZodOptional<ZodNullable<ZodString>>;
                                retry_after: ZodOptional<ZodNullable<ZodNumber>>;
                                details: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
                                recovery: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            property_list_applied: ZodOptional<ZodNullable<ZodBoolean>>;
            catalog_applied: ZodOptional<ZodNullable<ZodBoolean>>;
            refinement_applied: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodObject<
                            {
                                scope: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                                id: ZodOptional<ZodNullable<ZodString>>;
                                status: ZodUnion<
                                    readonly [
                                        ZodLiteral<"applied">,
                                        ZodLiteral<"partial">,
                                        ZodLiteral<"unable">,
                                    ],
                                >;
                                notes: ZodOptional<ZodNullable<ZodString>>;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            incomplete: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodObject<
                            {
                                scope: ZodUnion<
                                    readonly [
                                        ZodLiteral<"products">,
                                        ZodLiteral<"pricing">,
                                        ZodLiteral<"forecast">,
                                        ZodLiteral<"proposals">,
                                    ],
                                >;
                                description: ZodString;
                                estimated_wait: ZodOptional<
                                    ZodNullable<ZodObject<{ interval: ...; unit: ... }, $loose>>,
                                >;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            pagination: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            has_more: ZodBoolean;
                            cursor: ZodOptional<ZodNullable<ZodString>>;
                            total_count: ZodOptional<ZodNullable<ZodNumber>>;
                        },
                        $loose,
                    >,
                >,
            >;
            sandbox: ZodOptional<ZodNullable<ZodBoolean>>;
            context: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
            ext: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
        },
        $loose,
    > = ...