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

    Variable GetProductsRequestSchemaConst

    GetProductsRequestSchema: ZodObject<
        {
            buying_mode: ZodUnion<
                readonly [
                    ZodLiteral<"brief">,
                    ZodLiteral<"wholesale">,
                    ZodLiteral<"refine">,
                ],
            >;
            brief: ZodOptional<ZodNullable<ZodString>>;
            refine: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodUnion<
                            readonly [
                                ZodObject<
                                    { scope: ZodLiteral<"request">; ask: ZodString },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        scope: ZodLiteral<"product">;
                                        id: ZodString;
                                        action: ZodUnion<readonly [(...), (...), (...)]>;
                                        ask: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        scope: ZodLiteral<"proposal">;
                                        id: ZodString;
                                        action: ZodUnion<readonly [(...), (...), (...)]>;
                                        ask: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            ],
                        >,
                    >,
                >,
            >;
            brand: ZodOptional<
                ZodNullable<
                    ZodObject<
                        { domain: ZodString; brand_id: ZodOptional<ZodNullable<ZodString>> },
                        $loose,
                    >,
                >,
            >;
            catalog: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            catalog_id: ZodOptional<ZodNullable<ZodString>>;
                            name: ZodOptional<ZodNullable<ZodString>>;
                            type: ZodUnion<
                                readonly [
                                    ZodLiteral<"offering">,
                                    ZodLiteral<"product">,
                                    ZodLiteral<"inventory">,
                                    ZodLiteral<"store">,
                                    ZodLiteral<"promotion">,
                                    ZodLiteral<"hotel">,
                                    ZodLiteral<"flight">,
                                    ZodLiteral<"job">,
                                    ZodLiteral<"vehicle">,
                                    ZodLiteral<"real_estate">,
                                    ZodLiteral<"education">,
                                    ZodLiteral<"destination">,
                                    ZodLiteral<"app">,
                                ],
                            >;
                            url: ZodOptional<ZodNullable<ZodString>>;
                            feed_format: ZodOptional<
                                ZodNullable<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            update_frequency: ZodOptional<
                                ZodNullable<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            items: ZodOptional<ZodNullable<ZodArray<ZodObject<{}, $loose>>>>;
                            ids: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                            gtins: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                            tags: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                            category: ZodOptional<ZodNullable<ZodString>>;
                            query: ZodOptional<ZodNullable<ZodString>>;
                            conversion_events: ZodOptional<
                                ZodNullable<
                                    ZodArray<
                                        ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >,
                                    >,
                                >,
                            >;
                            content_id_type: ZodOptional<
                                ZodNullable<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            feed_field_mappings: ZodOptional<
                                ZodNullable<
                                    ZodArray<
                                        ZodObject<
                                            {
                                                feed_field: ...;
                                                catalog_field: ...;
                                                asset_group_id: ...;
                                                value: ...;
                                                transform: ...;
                                                format: ...;
                                                timezone: ...;
                                                by: ...;
                                                separator: ...;
                                                default: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >,
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            account: ZodOptional<
                ZodNullable<
                    ZodUnion<
                        readonly [
                            ZodObject<{ account_id: ZodString }, $loose>,
                            ZodObject<
                                {
                                    brand: ZodObject<
                                        { domain: ZodString; brand_id: ZodOptional<(...)> },
                                        $loose,
                                    >;
                                    operator: ZodString;
                                    sandbox: ZodOptional<ZodNullable<ZodBoolean>>;
                                },
                                $loose,
                            >,
                        ],
                    >,
                >,
            >;
            preferred_delivery_types: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodUnion<
                            readonly [ZodLiteral<"guaranteed">, ZodLiteral<"non_guaranteed">],
                        >,
                    >,
                >,
            >;
            filters: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            delivery_type: ZodOptional<
                                ZodNullable<
                                    ZodUnion<readonly [ZodLiteral<(...)>, ZodLiteral<(...)>]>,
                                >,
                            >;
                            exclusivity: ZodOptional<
                                ZodNullable<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            is_fixed_price: ZodOptional<ZodNullable<ZodBoolean>>;
                            format_ids: ZodOptional<
                                ZodNullable<
                                    ZodArray<
                                        ZodObject<
                                            {
                                                agent_url: ...;
                                                id: ...;
                                                width: ...;
                                                height: ...;
                                                duration_ms: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >,
                            >;
                            standard_formats_only: ZodOptional<ZodNullable<ZodBoolean>>;
                            min_exposures: ZodOptional<ZodNullable<ZodNumber>>;
                            start_date: ZodOptional<ZodNullable<ZodString>>;
                            end_date: ZodOptional<ZodNullable<ZodString>>;
                            budget_range: ZodOptional<
                                ZodNullable<ZodRecord<ZodString, ZodUnknown>>,
                            >;
                            countries: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                            regions: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                            metros: ZodOptional<
                                ZodNullable<
                                    ZodArray<ZodObject<{ system: ...; code: ... }, $loose>>,
                                >,
                            >;
                            channels: ZodOptional<
                                ZodNullable<
                                    ZodArray<
                                        ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >,
                                    >,
                                >,
                            >;
                            required_axe_integrations: ZodOptional<
                                ZodNullable<ZodArray<ZodString>>,
                            >;
                            trusted_match: ZodOptional<
                                ZodNullable<
                                    ZodObject<
                                        {
                                            providers: ZodOptional<(...)>;
                                            response_types: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            required_features: ZodOptional<
                                ZodNullable<
                                    ZodIntersection<
                                        ZodRecord<ZodString, ZodBoolean>,
                                        ZodObject<
                                            {
                                                inline_creative_management: ...;
                                                property_list_filtering: ...;
                                                content_standards: ...;
                                                conversion_tracking: ...;
                                                audience_targeting: ...;
                                                catalog_management: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >,
                            >;
                            required_geo_targeting: ZodOptional<
                                ZodNullable<
                                    ZodArray<ZodObject<{ level: ...; system: ... }, $loose>>,
                                >,
                            >;
                            signal_targeting: ZodOptional<
                                ZodNullable<ZodArray<ZodUnion<readonly [(...), (...), (...)]>>>,
                            >;
                            postal_areas: ZodOptional<
                                ZodNullable<
                                    ZodArray<ZodObject<{ system: ...; values: ... }, $loose>>,
                                >,
                            >;
                            geo_proximity: ZodOptional<
                                ZodNullable<ZodArray<ZodRecord<ZodString, ZodUnknown>>>,
                            >;
                            keywords: ZodOptional<
                                ZodNullable<
                                    ZodArray<ZodObject<{ keyword: ...; match_type: ... }, $loose>>,
                                >,
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            property_list: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            agent_url: ZodString;
                            list_id: ZodString;
                            auth_token: ZodOptional<ZodNullable<ZodString>>;
                        },
                        $loose,
                    >,
                >,
            >;
            fields: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodUnion<
                            readonly [
                                ZodLiteral<"product_id">,
                                ZodLiteral<"name">,
                                ZodLiteral<"description">,
                                ZodLiteral<"publisher_properties">,
                                ZodLiteral<"channels">,
                                ZodLiteral<"format_ids">,
                                ZodLiteral<"placements">,
                                ZodLiteral<"delivery_type">,
                                ZodLiteral<"exclusivity">,
                                ZodLiteral<"pricing_options">,
                                ZodLiteral<"forecast">,
                                ZodLiteral<"outcome_measurement">,
                                ZodLiteral<"delivery_measurement">,
                                ZodLiteral<"reporting_capabilities">,
                                ZodLiteral<"creative_policy">,
                                ZodLiteral<"catalog_types">,
                                ZodLiteral<"metric_optimization">,
                                ZodLiteral<"conversion_tracking">,
                                ZodLiteral<"data_provider_signals">,
                                ZodLiteral<"max_optimization_goals">,
                                ZodLiteral<"catalog_match">,
                                ZodLiteral<"collections">,
                                ZodLiteral<"collection_targeting_allowed">,
                                ZodLiteral<"installments">,
                                ZodLiteral<"brief_relevance">,
                                ZodLiteral<"expires_at">,
                                ZodLiteral<"product_card">,
                                ZodLiteral<"product_card_detailed">,
                                ZodLiteral<"enforced_policies">,
                                ZodLiteral<"trusted_match">,
                            ],
                        >,
                    >,
                >,
            >;
            time_budget: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            interval: ZodNumber;
                            unit: ZodUnion<
                                readonly [
                                    ZodLiteral<"seconds">,
                                    ZodLiteral<"minutes">,
                                    ZodLiteral<"hours">,
                                    ZodLiteral<"days">,
                                    ZodLiteral<"campaign">,
                                ],
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            pagination: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            max_results: ZodOptional<ZodNullable<ZodNumber>>;
                            cursor: ZodOptional<ZodNullable<ZodString>>;
                        },
                        $loose,
                    >,
                >,
            >;
            context: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
            required_policies: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
            ext: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
        },
        $loose,
    > = ...