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

    Variable GetProductsRequestSchemaConst

    GetProductsRequestSchema: ZodObject<
        {
            adcp_major_version: ZodOptional<ZodNumber>;
            buying_mode: ZodUnion<
                readonly [
                    ZodLiteral<"brief">,
                    ZodLiteral<"wholesale">,
                    ZodLiteral<"refine">,
                ],
            >;
            brief: ZodOptional<ZodString>;
            refine: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodObject<{ scope: ZodLiteral<"request">; ask: ZodString }, $loose>,
                            ZodObject<
                                {
                                    scope: ZodLiteral<"product">;
                                    product_id: ZodString;
                                    action: ZodOptional<ZodUnion<readonly [(...), (...), (...)]>>;
                                    ask: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                            ZodObject<
                                {
                                    scope: ZodLiteral<"proposal">;
                                    proposal_id: ZodString;
                                    action: ZodOptional<ZodUnion<readonly [(...), (...), (...)]>>;
                                    ask: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        ],
                    >,
                >,
            >;
            brand: ZodOptional<
                ZodObject<
                    {
                        domain: ZodString;
                        brand_id: ZodOptional<ZodString>;
                        industries: ZodOptional<ZodArray<ZodString>>;
                        data_subject_contestation: ZodOptional<
                            ZodRecord<ZodString, ZodUnknown>,
                        >;
                    },
                    $loose,
                >,
            >;
            catalog: ZodOptional<
                ZodObject<
                    {
                        catalog_id: ZodOptional<ZodString>;
                        name: ZodOptional<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<ZodString>;
                        feed_format: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"google_merchant_center">,
                                    ZodLiteral<"facebook_catalog">,
                                    ZodLiteral<"shopify">,
                                    ZodLiteral<"linkedin_jobs">,
                                    ZodLiteral<"custom">,
                                ],
                            >,
                        >;
                        update_frequency: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"realtime">,
                                    ZodLiteral<"hourly">,
                                    ZodLiteral<"daily">,
                                    ZodLiteral<"weekly">,
                                ],
                            >,
                        >;
                        items: ZodOptional<ZodArray<ZodObject<{}, $loose>>>;
                        ids: ZodOptional<ZodArray<ZodString>>;
                        gtins: ZodOptional<ZodArray<ZodString>>;
                        tags: ZodOptional<ZodArray<ZodString>>;
                        category: ZodOptional<ZodString>;
                        query: ZodOptional<ZodString>;
                        conversion_events: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"page_view">,
                                        ZodLiteral<"view_content">,
                                        ZodLiteral<"select_content">,
                                        ZodLiteral<"select_item">,
                                        ZodLiteral<"search">,
                                        ZodLiteral<"share">,
                                        ZodLiteral<"add_to_cart">,
                                        ZodLiteral<"remove_from_cart">,
                                        ZodLiteral<"viewed_cart">,
                                        ZodLiteral<"add_to_wishlist">,
                                        ZodLiteral<"initiate_checkout">,
                                        ZodLiteral<"add_payment_info">,
                                        ZodLiteral<"purchase">,
                                        ZodLiteral<"refund">,
                                        ZodLiteral<"lead">,
                                        ZodLiteral<"qualify_lead">,
                                        ZodLiteral<"close_convert_lead">,
                                        ZodLiteral<"disqualify_lead">,
                                        ZodLiteral<"complete_registration">,
                                        ZodLiteral<"subscribe">,
                                        ZodLiteral<"start_trial">,
                                        ZodLiteral<"app_install">,
                                        ZodLiteral<"app_launch">,
                                        ZodLiteral<"contact">,
                                        ZodLiteral<"schedule">,
                                        ZodLiteral<"donate">,
                                        ZodLiteral<"submit_application">,
                                        ZodLiteral<"custom">,
                                    ],
                                >,
                            >,
                        >;
                        content_id_type: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"sku">,
                                    ZodLiteral<"gtin">,
                                    ZodLiteral<"offering_id">,
                                    ZodLiteral<"job_id">,
                                    ZodLiteral<"hotel_id">,
                                    ZodLiteral<"flight_id">,
                                    ZodLiteral<"vehicle_id">,
                                    ZodLiteral<"listing_id">,
                                    ZodLiteral<"store_id">,
                                    ZodLiteral<"program_id">,
                                    ZodLiteral<"destination_id">,
                                    ZodLiteral<"app_id">,
                                ],
                            >,
                        >;
                        feed_field_mappings: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        feed_field: ZodOptional<ZodString>;
                                        catalog_field: ZodOptional<ZodString>;
                                        asset_group_id: ZodOptional<ZodString>;
                                        value: ZodOptional<ZodUnknown>;
                                        transform: ZodOptional<ZodUnion<(...)>>;
                                        format: ZodOptional<ZodString>;
                                        timezone: ZodOptional<ZodString>;
                                        by: ZodOptional<ZodNumber>;
                                        separator: ZodOptional<ZodString>;
                                        default: ZodOptional<ZodUnknown>;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
            account: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodObject<{ account_id: ZodString }, $loose>,
                        ZodObject<
                            {
                                brand: ZodObject<
                                    {
                                        domain: ZodString;
                                        brand_id: ZodOptional<ZodString>;
                                        industries: ZodOptional<ZodArray<(...)>>;
                                        data_subject_contestation: ZodOptional<ZodRecord<(...), (...)>>;
                                    },
                                    $loose,
                                >;
                                operator: ZodString;
                                sandbox: ZodOptional<ZodBoolean>;
                            },
                            $loose,
                        >,
                    ],
                >,
            >;
            preferred_delivery_types: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [ZodLiteral<"guaranteed">, ZodLiteral<"non_guaranteed">],
                    >,
                >,
            >;
            filters: ZodOptional<
                ZodObject<
                    {
                        delivery_type: ZodOptional<
                            ZodUnion<
                                readonly [ZodLiteral<"guaranteed">, ZodLiteral<"non_guaranteed">],
                            >,
                        >;
                        exclusivity: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"none">,
                                    ZodLiteral<"category">,
                                    ZodLiteral<"exclusive">,
                                ],
                            >,
                        >;
                        is_fixed_price: ZodOptional<ZodBoolean>;
                        format_ids: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        agent_url: ZodString;
                                        id: ZodString;
                                        width: ZodOptional<ZodNumber>;
                                        height: ZodOptional<ZodNumber>;
                                        duration_ms: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        standard_formats_only: ZodOptional<ZodBoolean>;
                        min_exposures: ZodOptional<ZodNumber>;
                        start_date: ZodOptional<ZodISODate>;
                        end_date: ZodOptional<ZodISODate>;
                        budget_range: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
                        countries: ZodOptional<ZodArray<ZodString>>;
                        regions: ZodOptional<ZodArray<ZodString>>;
                        metros: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        system: ZodUnion<readonly [(...), (...), (...), (...), (...)]>;
                                        code: ZodString;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        channels: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"display">,
                                        ZodLiteral<"olv">,
                                        ZodLiteral<"social">,
                                        ZodLiteral<"search">,
                                        ZodLiteral<"ctv">,
                                        ZodLiteral<"linear_tv">,
                                        ZodLiteral<"radio">,
                                        ZodLiteral<"streaming_audio">,
                                        ZodLiteral<"podcast">,
                                        ZodLiteral<"dooh">,
                                        ZodLiteral<"ooh">,
                                        ZodLiteral<"print">,
                                        ZodLiteral<"cinema">,
                                        ZodLiteral<"email">,
                                        ZodLiteral<"gaming">,
                                        ZodLiteral<"retail_media">,
                                        ZodLiteral<"influencer">,
                                        ZodLiteral<"affiliate">,
                                        ZodLiteral<"product_placement">,
                                        ZodLiteral<"sponsored_intelligence">,
                                    ],
                                >,
                            >,
                        >;
                        required_axe_integrations: ZodOptional<ZodArray<ZodString>>;
                        trusted_match: ZodOptional<
                            ZodObject<
                                {
                                    providers: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    response_types: ZodOptional<ZodArray<ZodUnion<(...)>>>;
                                },
                                $loose,
                            >,
                        >;
                        required_features: ZodOptional<
                            ZodIntersection<
                                ZodRecord<ZodString, ZodBoolean>,
                                ZodObject<
                                    {
                                        inline_creative_management: ZodOptional<ZodBoolean>;
                                        property_list_filtering: ZodOptional<ZodBoolean>;
                                        catalog_management: ZodOptional<ZodBoolean>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        required_geo_targeting: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        level: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        system: ZodOptional<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        signal_targeting: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodObject<
                                            { signal_id: ...; value_type: ...; value: ... },
                                            $loose,
                                        >,
                                        ZodObject<{ signal_id: ...; value_type: ...; values: ... }, $loose>,
                                        ZodObject<
                                            {
                                                signal_id: ...;
                                                value_type: ...;
                                                min_value: ...;
                                                max_value: ...;
                                            },
                                            $loose,
                                        >,
                                    ],
                                >,
                            >,
                        >;
                        postal_areas: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        system: ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >;
                                        values: ZodArray<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        geo_proximity: ZodOptional<ZodArray<ZodRecord<ZodString, ZodUnknown>>>;
                        required_performance_standards: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        metric: ZodUnion<readonly [(...), (...), (...), (...), (...)]>;
                                        threshold: ZodNumber;
                                        standard: ZodOptional<ZodUnion<(...)>>;
                                        vendor: ZodObject<
                                            {
                                                domain: ...;
                                                brand_id: ...;
                                                industries: ...;
                                                data_subject_contestation: ...;
                                            },
                                            $loose,
                                        >;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        keywords: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    { keyword: ZodString; match_type: ZodOptional<ZodUnion<(...)>> },
                                    $loose,
                                >,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
            property_list: ZodOptional<
                ZodObject<
                    {
                        agent_url: ZodString;
                        list_id: ZodString;
                        auth_token: ZodOptional<ZodString>;
                    },
                    $loose,
                >,
            >;
            fields: ZodOptional<
                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<
                ZodObject<
                    {
                        interval: ZodNumber;
                        unit: ZodUnion<
                            readonly [
                                ZodLiteral<"seconds">,
                                ZodLiteral<"minutes">,
                                ZodLiteral<"hours">,
                                ZodLiteral<"days">,
                                ZodLiteral<"campaign">,
                            ],
                        >;
                    },
                    $loose,
                >,
            >;
            pagination: ZodOptional<
                ZodObject<
                    {
                        max_results: ZodOptional<ZodNumber>;
                        cursor: ZodOptional<ZodString>;
                    },
                    $loose,
                >,
            >;
            context: ZodOptional<ZodObject<{}, $loose>>;
            required_policies: ZodOptional<ZodArray<ZodString>>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...