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

    Variable BuildCreativeRequestSchemaConst

    BuildCreativeRequestSchema: ZodObject<
        {
            adcp_major_version: ZodOptional<ZodNumber>;
            message: ZodOptional<ZodString>;
            creative_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: ZodLiteral<(...)>;
                                            url: ZodString;
                                            width: ZodNumber;
                                            height: ZodNumber;
                                            format: ZodOptional<(...)>;
                                            alt_text: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            url: ZodString;
                                            width: ZodNumber;
                                            height: ZodNumber;
                                            duration_ms: ZodOptional<(...)>;
                                            file_size_bytes: ZodOptional<(...)>;
                                            container_format: ZodOptional<(...)>;
                                            video_codec: ZodOptional<(...)>;
                                            video_bitrate_kbps: ZodOptional<(...)>;
                                            frame_rate: ZodOptional<(...)>;
                                            frame_rate_type: ZodOptional<(...)>;
                                            scan_type: ZodOptional<(...)>;
                                            color_space: ZodOptional<(...)>;
                                            hdr_format: ZodOptional<(...)>;
                                            chroma_subsampling: ZodOptional<(...)>;
                                            video_bit_depth: ZodOptional<(...)>;
                                            gop_interval_seconds: ZodOptional<(...)>;
                                            gop_type: ZodOptional<(...)>;
                                            moov_atom_position: ZodOptional<(...)>;
                                            has_audio: ZodOptional<(...)>;
                                            audio_codec: ZodOptional<(...)>;
                                            audio_sampling_rate_hz: ZodOptional<(...)>;
                                            audio_channels: ZodOptional<(...)>;
                                            audio_bit_depth: ZodOptional<(...)>;
                                            audio_bitrate_kbps: ZodOptional<(...)>;
                                            audio_loudness_lufs: ZodOptional<(...)>;
                                            audio_true_peak_dbfs: ZodOptional<(...)>;
                                            captions_url: ZodOptional<(...)>;
                                            transcript_url: ZodOptional<(...)>;
                                            audio_description_url: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            url: ZodString;
                                            duration_ms: ZodOptional<(...)>;
                                            file_size_bytes: ZodOptional<(...)>;
                                            container_format: ZodOptional<(...)>;
                                            codec: ZodOptional<(...)>;
                                            sampling_rate_hz: ZodOptional<(...)>;
                                            channels: ZodOptional<(...)>;
                                            bit_depth: ZodOptional<(...)>;
                                            bitrate_kbps: ZodOptional<(...)>;
                                            loudness_lufs: ZodOptional<(...)>;
                                            true_peak_dbfs: ZodOptional<(...)>;
                                            transcript_url: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                vast_version: ...;
                                                vpaid_enabled: ...;
                                                duration_ms: ...;
                                                tracking_events: ...;
                                                captions_url: ...;
                                                audio_description_url: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodUnion<readonly [(...), (...)]>,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            content: ZodString;
                                            language: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            url: ZodString;
                                            url_type: ZodOptional<(...)>;
                                            description: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            content: ZodString;
                                            version: ZodOptional<(...)>;
                                            accessibility: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            content: ZodString;
                                            module_type: ZodOptional<(...)>;
                                            accessibility: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            url: ZodString;
                                            method: ZodOptional<(...)>;
                                            timeout_ms: ZodOptional<(...)>;
                                            supported_macros: ZodOptional<(...)>;
                                            required_macros: ZodOptional<(...)>;
                                            response_type: ZodUnion<(...)>;
                                            security: ZodObject<(...), (...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            content: ZodString;
                                            media: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                asset_type: ...;
                                                daast_version: ...;
                                                duration_ms: ...;
                                                tracking_events: ...;
                                                companion_ads: ...;
                                                transcript_url: ...;
                                                provenance: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodUnion<readonly [(...), (...)]>,
                                    >,
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            content: ZodString;
                                            language: ZodOptional<(...)>;
                                            markdown_flavor: ZodOptional<(...)>;
                                            allow_raw_html: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            name: ZodString;
                                            objective: ZodOptional<(...)>;
                                            tone: ZodOptional<(...)>;
                                            audience: ZodOptional<(...)>;
                                            territory: ZodOptional<(...)>;
                                            messaging: ZodOptional<(...)>;
                                            reference_assets: ZodOptional<(...)>;
                                            compliance: ZodOptional<(...)>;
                                            asset_type: ZodLiteral<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodObject<
                                        {
                                            catalog_id: ZodOptional<(...)>;
                                            name: ZodOptional<(...)>;
                                            type: ZodUnion<(...)>;
                                            url: ZodOptional<(...)>;
                                            feed_format: ZodOptional<(...)>;
                                            update_frequency: ZodOptional<(...)>;
                                            items: ZodOptional<(...)>;
                                            ids: ZodOptional<(...)>;
                                            gtins: ZodOptional<(...)>;
                                            tags: ZodOptional<(...)>;
                                            category: ZodOptional<(...)>;
                                            query: ZodOptional<(...)>;
                                            conversion_events: ZodOptional<(...)>;
                                            content_id_type: ZodOptional<(...)>;
                                            feed_field_mappings: ZodOptional<(...)>;
                                            asset_type: ZodLiteral<(...)>;
                                        },
                                        $loose,
                                    >,
                                ],
                            >,
                        >;
                        rights: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        rights_id: ZodString;
                                        rights_agent: ZodObject<{ url: ...; id: ... }, $loose>;
                                        valid_from: ZodOptional<ZodISODateTime>;
                                        valid_until: ZodOptional<ZodISODateTime>;
                                        uses: ZodArray<ZodUnion<(...)>>;
                                        countries: ZodOptional<ZodArray<(...)>>;
                                        excluded_countries: ZodOptional<ZodArray<(...)>>;
                                        impression_cap: ZodOptional<ZodNumber>;
                                        right_type: ZodOptional<ZodUnion<(...)>>;
                                        approval_status: ZodOptional<ZodUnion<(...)>>;
                                        verification_url: ZodOptional<ZodString>;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        industry_identifiers: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        type: ZodUnion<readonly [(...), (...), (...)]>;
                                        value: ZodString;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        provenance: ZodOptional<
                            ZodObject<
                                {
                                    digital_source_type: ZodOptional<
                                        ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >,
                                    >;
                                    ai_tool: ZodOptional<
                                        ZodObject<{ name: ...; version: ...; provider: ... }, $loose>,
                                    >;
                                    human_oversight: ZodOptional<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...)]>,
                                    >;
                                    declared_by: ZodOptional<
                                        ZodObject<{ agent_url: ...; role: ... }, $loose>,
                                    >;
                                    declared_at: ZodOptional<ZodISODateTime>;
                                    created_time: ZodOptional<ZodISODateTime>;
                                    c2pa: ZodOptional<ZodObject<{ manifest_url: ... }, $loose>>;
                                    disclosure: ZodOptional<
                                        ZodObject<{ required: ...; jurisdictions: ... }, $loose>,
                                    >;
                                    verification: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                    ext: ZodOptional<ZodObject<{}, $loose>>;
                                },
                                $loose,
                            >,
                        >;
                        ext: ZodOptional<ZodObject<{}, $loose>>;
                    },
                    $loose,
                >,
            >;
            creative_id: ZodOptional<ZodString>;
            concept_id: ZodOptional<ZodString>;
            media_buy_id: ZodOptional<ZodString>;
            package_id: ZodOptional<ZodString>;
            target_format_id: ZodOptional<
                ZodObject<
                    {
                        agent_url: ZodString;
                        id: ZodString;
                        width: ZodOptional<ZodNumber>;
                        height: ZodOptional<ZodNumber>;
                        duration_ms: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
            target_format_ids: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            agent_url: ZodString;
                            id: ZodString;
                            width: ZodOptional<ZodNumber>;
                            height: ZodOptional<ZodNumber>;
                            duration_ms: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >,
            >;
            account: ZodOptional<
                ZodUnion<
                    readonly [
                        ZodObject<{ account_id: ZodString }, $loose>,
                        ZodObject<
                            {
                                brand: ZodObject<
                                    {
                                        domain: ZodString;
                                        brand_id: ZodOptional<ZodString>;
                                        industries: ZodOptional<ZodArray<(...)>>;
                                        data_subject_contestation: ZodOptional<ZodRecord<(...), (...)>>;
                                    },
                                    $loose,
                                >;
                                operator: ZodString;
                                sandbox: ZodOptional<ZodBoolean>;
                            },
                            $loose,
                        >,
                    ],
                >,
            >;
            brand: ZodOptional<
                ZodObject<
                    {
                        domain: ZodString;
                        brand_id: ZodOptional<ZodString>;
                        industries: ZodOptional<ZodArray<ZodString>>;
                        data_subject_contestation: ZodOptional<
                            ZodRecord<ZodString, ZodUnknown>,
                        >;
                    },
                    $loose,
                >,
            >;
            quality: ZodOptional<
                ZodUnion<readonly [ZodLiteral<"draft">, ZodLiteral<"production">]>,
            >;
            item_limit: ZodOptional<ZodNumber>;
            include_preview: ZodOptional<ZodBoolean>;
            preview_inputs: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            name: ZodString;
                            macros: ZodOptional<ZodRecord<ZodString, ZodString>>;
                            context_description: ZodOptional<ZodString>;
                        },
                        $loose,
                    >,
                >,
            >;
            preview_quality: ZodOptional<
                ZodUnion<readonly [ZodLiteral<"draft">, ZodLiteral<"production">]>,
            >;
            preview_output_format: ZodOptional<
                ZodUnion<readonly [ZodLiteral<"url">, ZodLiteral<"html">]>,
            >;
            macro_values: ZodOptional<ZodRecord<ZodString, ZodString>>;
            idempotency_key: ZodString;
            context: ZodOptional<ZodObject<{}, $loose>>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...