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

    Variable PackageUpdateSchemaConst

    PackageUpdateSchema: ZodObject<
        {
            package_id: ZodString;
            budget: ZodOptional<ZodNumber>;
            pacing: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodLiteral<"even">,
                        ZodLiteral<"asap">,
                        ZodLiteral<"front_loaded">,
                    ],
                >,
            >;
            bid_price: ZodOptional<ZodNumber>;
            impressions: ZodOptional<ZodNumber>;
            start_time: ZodOptional<ZodISODateTime>;
            end_time: ZodOptional<ZodISODateTime>;
            paused: ZodOptional<ZodBoolean>;
            canceled: ZodOptional<ZodLiteral<true>>;
            cancellation_reason: ZodOptional<ZodString>;
            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,
                    >,
                >,
            >;
            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,
                            >,
                        ],
                    >,
                >,
            >;
            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,
                >,
            >;
            keyword_targets_add: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            keyword: ZodString;
                            match_type: ZodUnion<
                                readonly [
                                    ZodLiteral<"broad">,
                                    ZodLiteral<"phrase">,
                                    ZodLiteral<"exact">,
                                ],
                            >;
                            bid_price: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >,
            >;
            keyword_targets_remove: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            keyword: ZodString;
                            match_type: ZodUnion<
                                readonly [
                                    ZodLiteral<"broad">,
                                    ZodLiteral<"phrase">,
                                    ZodLiteral<"exact">,
                                ],
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            negative_keywords_add: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            keyword: ZodString;
                            match_type: ZodUnion<
                                readonly [
                                    ZodLiteral<"broad">,
                                    ZodLiteral<"phrase">,
                                    ZodLiteral<"exact">,
                                ],
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            negative_keywords_remove: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            keyword: ZodString;
                            match_type: ZodUnion<
                                readonly [
                                    ZodLiteral<"broad">,
                                    ZodLiteral<"phrase">,
                                    ZodLiteral<"exact">,
                                ],
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            creative_assignments: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            creative_id: ZodString;
                            weight: ZodOptional<ZodNumber>;
                            placement_ids: ZodOptional<ZodArray<ZodString>>;
                        },
                        $loose,
                    >,
                >,
            >;
            creatives: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            creative_id: ZodString;
                            name: ZodString;
                            format_id: ZodObject<
                                {
                                    agent_url: ZodString;
                                    id: ZodString;
                                    width: ZodOptional<ZodNumber>;
                                    height: ZodOptional<ZodNumber>;
                                    duration_ms: ZodOptional<ZodNumber>;
                                },
                                $loose,
                            >;
                            assets: ZodRecord<
                                ZodString,
                                ZodUnion<
                                    readonly [
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                url: ...;
                                                width: ...;
                                                height: ...;
                                                format: ...;
                                                alt_text: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                url: ...;
                                                width: ...;
                                                height: ...;
                                                duration_ms: ...;
                                                file_size_bytes: ...;
                                                container_format: ...;
                                                video_codec: ...;
                                                video_bitrate_kbps: ...;
                                                frame_rate: ...;
                                                frame_rate_type: ...;
                                                scan_type: ...;
                                                color_space: ...;
                                                hdr_format: ...;
                                                chroma_subsampling: ...;
                                                video_bit_depth: ...;
                                                gop_interval_seconds: ...;
                                                gop_type: ...;
                                                moov_atom_position: ...;
                                                has_audio: ...;
                                                audio_codec: ...;
                                                audio_sampling_rate_hz: ...;
                                                audio_channels: ...;
                                                audio_bit_depth: ...;
                                                audio_bitrate_kbps: ...;
                                                audio_loudness_lufs: ...;
                                                audio_true_peak_dbfs: ...;
                                                captions_url: ...;
                                                transcript_url: ...;
                                                audio_description_url: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                url: ...;
                                                duration_ms: ...;
                                                file_size_bytes: ...;
                                                container_format: ...;
                                                codec: ...;
                                                sampling_rate_hz: ...;
                                                channels: ...;
                                                bit_depth: ...;
                                                bitrate_kbps: ...;
                                                loudness_lufs: ...;
                                                true_peak_dbfs: ...;
                                                transcript_url: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodIntersection<ZodObject<(...), (...)>, ZodUnion<(...)>>,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                content: ...;
                                                language: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                url: ...;
                                                url_type: ...;
                                                description: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                content: ...;
                                                version: ...;
                                                accessibility: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                content: ...;
                                                module_type: ...;
                                                accessibility: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                url: ...;
                                                method: ...;
                                                timeout_ms: ...;
                                                supported_macros: ...;
                                                required_macros: ...;
                                                response_type: ...;
                                                security: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            { asset_type: ...; content: ...; media: ...; provenance: ... },
                                            $loose,
                                        >,
                                        ZodIntersection<ZodObject<(...), (...)>, ZodUnion<(...)>>,
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                content: ...;
                                                language: ...;
                                                markdown_flavor: ...;
                                                allow_raw_html: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                name: ...;
                                                objective: ...;
                                                tone: ...;
                                                audience: ...;
                                                territory: ...;
                                                messaging: ...;
                                                reference_assets: ...;
                                                compliance: ...;
                                                asset_type: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<
                                            {
                                                catalog_id: ...;
                                                name: ...;
                                                type: ...;
                                                url: ...;
                                                feed_format: ...;
                                                update_frequency: ...;
                                                items: ...;
                                                ids: ...;
                                                gtins: ...;
                                                tags: ...;
                                                category: ...;
                                                query: ...;
                                                conversion_events: ...;
                                                content_id_type: ...;
                                                feed_field_mappings: ...;
                                                asset_type: ...;
                                            },
                                            $loose,
                                        >,
                                    ],
                                >,
                            >;
                            inputs: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            name: ZodString;
                                            macros: ZodOptional<(...)>;
                                            context_description: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            tags: ZodOptional<ZodArray<ZodString>>;
                            status: ZodOptional<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"processing">,
                                        ZodLiteral<"pending_review">,
                                        ZodLiteral<"approved">,
                                        ZodLiteral<"rejected">,
                                        ZodLiteral<"archived">,
                                    ],
                                >,
                            >;
                            weight: ZodOptional<ZodNumber>;
                            placement_ids: ZodOptional<ZodArray<ZodString>>;
                            industry_identifiers: ZodOptional<
                                ZodArray<
                                    ZodObject<{ type: ZodUnion<(...)>; value: ZodString }, $loose>,
                                >,
                            >;
                            provenance: ZodOptional<
                                ZodObject<
                                    {
                                        digital_source_type: ZodOptional<ZodUnion<(...)>>;
                                        ai_tool: ZodOptional<ZodObject<(...), (...)>>;
                                        human_oversight: ZodOptional<ZodUnion<(...)>>;
                                        declared_by: ZodOptional<ZodObject<(...), (...)>>;
                                        declared_at: ZodOptional<ZodISODateTime>;
                                        created_time: ZodOptional<ZodISODateTime>;
                                        c2pa: ZodOptional<ZodObject<(...), (...)>>;
                                        disclosure: ZodOptional<ZodObject<(...), (...)>>;
                                        verification: ZodOptional<ZodArray<(...)>>;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            context: ZodOptional<ZodObject<{}, $loose>>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...