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

    Variable PackageSchemaConst

    PackageSchema: ZodObject<
        {
            package_id: ZodString;
            product_id: ZodOptional<ZodString>;
            budget: ZodOptional<ZodNumber>;
            pacing: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodLiteral<"even">,
                        ZodLiteral<"asap">,
                        ZodLiteral<"front_loaded">,
                    ],
                >,
            >;
            pricing_option_id: ZodOptional<ZodString>;
            bid_price: ZodOptional<ZodNumber>;
            price_breakdown: ZodOptional<
                ZodObject<
                    {
                        list_price: ZodNumber;
                        adjustments: ZodArray<ZodRecord<ZodString, ZodUnknown>>;
                    },
                    $loose,
                >,
            >;
            impressions: ZodOptional<ZodNumber>;
            catalogs: ZodOptional<
                ZodArray<
                    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<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            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<(...)>;
                                            catalog_field: ZodOptional<(...)>;
                                            asset_group_id: ZodOptional<(...)>;
                                            value: ZodOptional<(...)>;
                                            transform: ZodOptional<(...)>;
                                            format: ZodOptional<(...)>;
                                            timezone: ZodOptional<(...)>;
                                            by: ZodOptional<(...)>;
                                            separator: ZodOptional<(...)>;
                                            default: ZodOptional<(...)>;
                                            ext: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            format_ids: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            agent_url: ZodString;
                            id: ZodString;
                            width: ZodOptional<ZodNumber>;
                            height: ZodOptional<ZodNumber>;
                            duration_ms: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >,
            >;
            targeting_overlay: ZodOptional<
                ZodObject<
                    {
                        geo_countries: ZodOptional<ZodArray<ZodString>>;
                        geo_countries_exclude: ZodOptional<ZodArray<ZodString>>;
                        geo_regions: ZodOptional<ZodArray<ZodString>>;
                        geo_regions_exclude: ZodOptional<ZodArray<ZodString>>;
                        geo_metros: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        system: ZodUnion<readonly [(...), (...), (...), (...), (...)]>;
                                        values: ZodArray<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        geo_metros_exclude: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        system: ZodUnion<readonly [(...), (...), (...), (...), (...)]>;
                                        values: ZodArray<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        geo_postal_areas: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        system: ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >;
                                        values: ZodArray<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        geo_postal_areas_exclude: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        system: ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >;
                                        values: ZodArray<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        daypart_targets: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        days: ZodArray<ZodUnion<(...)>>;
                                        start_hour: ZodNumber;
                                        end_hour: ZodNumber;
                                        label: ZodOptional<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        axe_include_segment: ZodOptional<ZodString>;
                        axe_exclude_segment: ZodOptional<ZodString>;
                        audience_include: ZodOptional<ZodArray<ZodString>>;
                        audience_exclude: ZodOptional<ZodArray<ZodString>>;
                        frequency_cap: ZodOptional<
                            ZodObject<
                                {
                                    suppress: ZodOptional<
                                        ZodObject<{ interval: ...; unit: ... }, $loose>,
                                    >;
                                    suppress_minutes: ZodOptional<ZodNumber>;
                                    max_impressions: ZodOptional<ZodNumber>;
                                    per: ZodOptional<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...), (...)]>,
                                    >;
                                    window: ZodOptional<ZodObject<{ interval: ...; unit: ... }, $loose>>;
                                },
                                $loose,
                            >,
                        >;
                        property_list: ZodOptional<
                            ZodObject<
                                {
                                    agent_url: ZodString;
                                    list_id: ZodString;
                                    auth_token: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        collection_list: ZodOptional<
                            ZodObject<
                                {
                                    agent_url: ZodString;
                                    list_id: ZodString;
                                    auth_token: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        collection_list_exclude: ZodOptional<
                            ZodObject<
                                {
                                    agent_url: ZodString;
                                    list_id: ZodString;
                                    auth_token: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        age_restriction: ZodOptional<
                            ZodObject<
                                {
                                    min: ZodNumber;
                                    verification_required: ZodOptional<ZodBoolean>;
                                    accepted_methods: ZodOptional<ZodArray<ZodUnion<(...)>>>;
                                },
                                $loose,
                            >,
                        >;
                        device_platform: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"ios">,
                                        ZodLiteral<"android">,
                                        ZodLiteral<"windows">,
                                        ZodLiteral<"macos">,
                                        ZodLiteral<"linux">,
                                        ZodLiteral<"chromeos">,
                                        ZodLiteral<"tvos">,
                                        ZodLiteral<"tizen">,
                                        ZodLiteral<"webos">,
                                        ZodLiteral<"fire_os">,
                                        ZodLiteral<"roku_os">,
                                        ZodLiteral<"unknown">,
                                    ],
                                >,
                            >,
                        >;
                        device_type: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"desktop">,
                                        ZodLiteral<"mobile">,
                                        ZodLiteral<"tablet">,
                                        ZodLiteral<"ctv">,
                                        ZodLiteral<"dooh">,
                                        ZodLiteral<"unknown">,
                                    ],
                                >,
                            >,
                        >;
                        device_type_exclude: ZodOptional<
                            ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"desktop">,
                                        ZodLiteral<"mobile">,
                                        ZodLiteral<"tablet">,
                                        ZodLiteral<"ctv">,
                                        ZodLiteral<"dooh">,
                                        ZodLiteral<"unknown">,
                                    ],
                                >,
                            >,
                        >;
                        store_catchments: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        catalog_id: ZodString;
                                        store_ids: ZodOptional<ZodArray<(...)>>;
                                        catchment_ids: ZodOptional<ZodArray<(...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        geo_proximity: ZodOptional<ZodArray<ZodRecord<ZodString, ZodUnknown>>>;
                        language: ZodOptional<ZodArray<ZodString>>;
                        keyword_targets: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        keyword: ZodString;
                                        match_type: ZodUnion<readonly [(...), (...), (...)]>;
                                        bid_price: ZodOptional<ZodNumber>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        negative_keywords: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        keyword: ZodString;
                                        match_type: ZodUnion<readonly [(...), (...), (...)]>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
            measurement_terms: ZodOptional<
                ZodObject<
                    {
                        billing_measurement: ZodOptional<
                            ZodObject<
                                {
                                    vendor: ZodObject<
                                        {
                                            domain: ZodString;
                                            brand_id: ZodOptional<(...)>;
                                            industries: ZodOptional<(...)>;
                                            data_subject_contestation: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >;
                                    max_variance_percent: ZodOptional<ZodNumber>;
                                    measurement_window: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        makegood_policy: ZodOptional<
                            ZodObject<
                                {
                                    available_remedies: ZodArray<
                                        ZodUnion<readonly [(...), (...), (...)]>,
                                    >;
                                },
                                $loose,
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
            performance_standards: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            metric: ZodUnion<
                                readonly [
                                    ZodLiteral<"viewability">,
                                    ZodLiteral<"ivt">,
                                    ZodLiteral<"completion_rate">,
                                    ZodLiteral<"brand_safety">,
                                    ZodLiteral<"attention_score">,
                                ],
                            >;
                            threshold: ZodNumber;
                            standard: ZodOptional<
                                ZodUnion<readonly [ZodLiteral<"mrc">, ZodLiteral<"groupm">]>,
                            >;
                            vendor: ZodObject<
                                {
                                    domain: ZodString;
                                    brand_id: ZodOptional<ZodString>;
                                    industries: ZodOptional<ZodArray<ZodString>>;
                                    data_subject_contestation: ZodOptional<
                                        ZodRecord<ZodString, ZodUnknown>,
                                    >;
                                },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            creative_assignments: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            creative_id: ZodString;
                            weight: ZodOptional<ZodNumber>;
                            placement_ids: ZodOptional<ZodArray<ZodString>>;
                        },
                        $loose,
                    >,
                >,
            >;
            format_ids_to_provide: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            agent_url: ZodString;
                            id: ZodString;
                            width: ZodOptional<ZodNumber>;
                            height: ZodOptional<ZodNumber>;
                            duration_ms: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >,
            >;
            optimization_goals: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodObject<
                                {
                                    kind: ZodLiteral<"metric">;
                                    metric: ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >;
                                    reach_unit: ZodOptional<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...), (...)]>,
                                    >;
                                    target_frequency: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
                                    view_duration_seconds: ZodOptional<ZodNumber>;
                                    target: ZodOptional<ZodUnion<readonly [(...), (...)]>>;
                                    priority: ZodOptional<ZodNumber>;
                                },
                                $loose,
                            >,
                            ZodObject<
                                {
                                    kind: ZodLiteral<"event">;
                                    event_sources: ZodArray<
                                        ZodObject<
                                            {
                                                event_source_id: ...;
                                                event_type: ...;
                                                custom_event_name: ...;
                                                value_field: ...;
                                                value_factor: ...;
                                            },
                                            $loose,
                                        >,
                                    >;
                                    target: ZodOptional<ZodUnion<readonly [(...), (...), (...)]>>;
                                    attribution_window: ZodOptional<
                                        ZodObject<{ post_click: ...; post_view: ... }, $loose>,
                                    >;
                                    priority: ZodOptional<ZodNumber>;
                                },
                                $loose,
                            >,
                        ],
                    >,
                >,
            >;
            start_time: ZodOptional<ZodISODateTime>;
            end_time: ZodOptional<ZodISODateTime>;
            paused: ZodOptional<ZodBoolean>;
            canceled: ZodOptional<ZodBoolean>;
            cancellation: ZodOptional<
                ZodObject<
                    {
                        canceled_at: ZodISODateTime;
                        canceled_by: ZodUnion<
                            readonly [ZodLiteral<"buyer">, ZodLiteral<"seller">],
                        >;
                        reason: ZodOptional<ZodString>;
                        acknowledged_at: ZodOptional<ZodISODateTime>;
                    },
                    $loose,
                >,
            >;
            agency_estimate_number: ZodOptional<ZodString>;
            creative_deadline: ZodOptional<ZodISODateTime>;
            context: ZodOptional<ZodObject<{}, $loose>>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...