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

    Variable CreativeVariantSchemaConst

    CreativeVariantSchema: ZodIntersection<
        ZodObject<
            {
                impressions: ZodOptional<ZodNumber>;
                spend: ZodOptional<ZodNumber>;
                clicks: ZodOptional<ZodNumber>;
                ctr: ZodOptional<ZodNumber>;
                views: ZodOptional<ZodNumber>;
                completed_views: ZodOptional<ZodNumber>;
                completion_rate: ZodOptional<ZodNumber>;
                conversions: ZodOptional<ZodNumber>;
                conversion_value: ZodOptional<ZodNumber>;
                roas: ZodOptional<ZodNumber>;
                cost_per_acquisition: ZodOptional<ZodNumber>;
                new_to_brand_rate: ZodOptional<ZodNumber>;
                leads: ZodOptional<ZodNumber>;
                by_event_type: ZodOptional<
                    ZodArray<
                        ZodObject<
                            {
                                event_type: 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">,
                                    ],
                                >;
                                event_source_id: ZodOptional<ZodString>;
                                count: ZodNumber;
                                value: ZodOptional<ZodNumber>;
                            },
                            $loose,
                        >,
                    >,
                >;
                grps: ZodOptional<ZodNumber>;
                reach: ZodOptional<ZodNumber>;
                reach_unit: ZodOptional<
                    ZodUnion<
                        readonly [
                            ZodLiteral<"individuals">,
                            ZodLiteral<"households">,
                            ZodLiteral<"devices">,
                            ZodLiteral<"accounts">,
                            ZodLiteral<"cookies">,
                            ZodLiteral<"custom">,
                        ],
                    >,
                >;
                frequency: ZodOptional<ZodNumber>;
                quartile_data: ZodOptional<
                    ZodObject<
                        {
                            q1_views: ZodOptional<ZodNumber>;
                            q2_views: ZodOptional<ZodNumber>;
                            q3_views: ZodOptional<ZodNumber>;
                            q4_views: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >;
                dooh_metrics: ZodOptional<
                    ZodObject<
                        {
                            loop_plays: ZodOptional<ZodNumber>;
                            screens_used: ZodOptional<ZodNumber>;
                            screen_time_seconds: ZodOptional<ZodNumber>;
                            sov_achieved: ZodOptional<ZodNumber>;
                            calculation_notes: ZodOptional<ZodString>;
                            venue_breakdown: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            venue_id: ZodString;
                                            venue_name: ZodOptional<(...)>;
                                            venue_type: ZodOptional<(...)>;
                                            impressions: ZodNumber;
                                            loop_plays: ZodOptional<(...)>;
                                            screens_used: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                        },
                        $loose,
                    >,
                >;
                viewability: ZodOptional<
                    ZodObject<
                        {
                            measurable_impressions: ZodOptional<ZodNumber>;
                            viewable_impressions: ZodOptional<ZodNumber>;
                            viewable_rate: ZodOptional<ZodNumber>;
                            standard: ZodOptional<
                                ZodUnion<readonly [ZodLiteral<"mrc">, ZodLiteral<"groupm">]>,
                            >;
                        },
                        $loose,
                    >,
                >;
                engagements: ZodOptional<ZodNumber>;
                follows: ZodOptional<ZodNumber>;
                saves: ZodOptional<ZodNumber>;
                profile_visits: ZodOptional<ZodNumber>;
                engagement_rate: ZodOptional<ZodNumber>;
                cost_per_click: ZodOptional<ZodNumber>;
                by_action_source: ZodOptional<
                    ZodArray<
                        ZodObject<
                            {
                                action_source: ZodUnion<
                                    readonly [
                                        ZodLiteral<"website">,
                                        ZodLiteral<"app">,
                                        ZodLiteral<"offline">,
                                        ZodLiteral<"phone_call">,
                                        ZodLiteral<"chat">,
                                        ZodLiteral<"email">,
                                        ZodLiteral<"in_store">,
                                        ZodLiteral<"system_generated">,
                                        ZodLiteral<"other">,
                                    ],
                                >;
                                event_source_id: ZodOptional<ZodString>;
                                count: ZodNumber;
                                value: ZodOptional<ZodNumber>;
                            },
                            $loose,
                        >,
                    >,
                >;
            },
            $loose,
        >,
        ZodObject<
            {
                variant_id: ZodString;
                manifest: ZodOptional<
                    ZodObject<
                        {
                            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,
                                        >,
                                    ],
                                >,
                            >;
                            rights: ZodOptional<
                                ZodArray<
                                    ZodObject<
                                        {
                                            rights_id: ZodString;
                                            rights_agent: ZodObject<(...), (...)>;
                                            valid_from: ZodOptional<(...)>;
                                            valid_until: ZodOptional<(...)>;
                                            uses: ZodArray<(...)>;
                                            countries: ZodOptional<(...)>;
                                            excluded_countries: ZodOptional<(...)>;
                                            impression_cap: ZodOptional<(...)>;
                                            right_type: ZodOptional<(...)>;
                                            approval_status: ZodOptional<(...)>;
                                            verification_url: ZodOptional<(...)>;
                                            ext: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            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,
                                >,
                            >;
                            ext: ZodOptional<ZodObject<{}, $loose>>;
                        },
                        $loose,
                    >,
                >;
                generation_context: ZodOptional<
                    ZodObject<
                        {
                            context_type: ZodOptional<ZodString>;
                            artifact: ZodOptional<
                                ZodObject<
                                    {
                                        property_id: ZodObject<{ type: ...; value: ... }, $loose>;
                                        artifact_id: ZodString;
                                    },
                                    $loose,
                                >,
                            >;
                            ext: ZodOptional<ZodObject<{}, $loose>>;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >,
    > = ...