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

    Variable BuildCreativeSuccessSchemaConst

    BuildCreativeSuccessSchema: ZodObject<
        {
            creative_manifest: 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<"image">;
                                        url: ZodString;
                                        width: ZodNumber;
                                        height: ZodNumber;
                                        format: ZodOptional<ZodString>;
                                        alt_text: ZodOptional<ZodString>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"video">;
                                        url: ZodString;
                                        width: ZodNumber;
                                        height: ZodNumber;
                                        duration_ms: ZodOptional<ZodNumber>;
                                        file_size_bytes: ZodOptional<ZodNumber>;
                                        container_format: ZodOptional<ZodString>;
                                        video_codec: ZodOptional<ZodString>;
                                        video_bitrate_kbps: ZodOptional<ZodNumber>;
                                        frame_rate: ZodOptional<ZodString>;
                                        frame_rate_type: ZodOptional<ZodUnion<(...)>>;
                                        scan_type: ZodOptional<ZodUnion<(...)>>;
                                        color_space: ZodOptional<ZodUnion<(...)>>;
                                        hdr_format: ZodOptional<ZodUnion<(...)>>;
                                        chroma_subsampling: ZodOptional<ZodUnion<(...)>>;
                                        video_bit_depth: ZodOptional<ZodUnion<(...)>>;
                                        gop_interval_seconds: ZodOptional<ZodNumber>;
                                        gop_type: ZodOptional<ZodUnion<(...)>>;
                                        moov_atom_position: ZodOptional<ZodUnion<(...)>>;
                                        has_audio: ZodOptional<ZodBoolean>;
                                        audio_codec: ZodOptional<ZodString>;
                                        audio_sampling_rate_hz: ZodOptional<ZodNumber>;
                                        audio_channels: ZodOptional<ZodUnion<(...)>>;
                                        audio_bit_depth: ZodOptional<ZodUnion<(...)>>;
                                        audio_bitrate_kbps: ZodOptional<ZodNumber>;
                                        audio_loudness_lufs: ZodOptional<ZodNumber>;
                                        audio_true_peak_dbfs: ZodOptional<ZodNumber>;
                                        captions_url: ZodOptional<ZodString>;
                                        transcript_url: ZodOptional<ZodString>;
                                        audio_description_url: ZodOptional<ZodString>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"audio">;
                                        url: ZodString;
                                        duration_ms: ZodOptional<ZodNumber>;
                                        file_size_bytes: ZodOptional<ZodNumber>;
                                        container_format: ZodOptional<ZodString>;
                                        codec: ZodOptional<ZodString>;
                                        sampling_rate_hz: ZodOptional<ZodNumber>;
                                        channels: ZodOptional<ZodUnion<(...)>>;
                                        bit_depth: ZodOptional<ZodUnion<(...)>>;
                                        bitrate_kbps: ZodOptional<ZodNumber>;
                                        loudness_lufs: ZodOptional<ZodNumber>;
                                        true_peak_dbfs: ZodOptional<ZodNumber>;
                                        transcript_url: ZodOptional<ZodString>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodIntersection<
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            vast_version: ZodOptional<(...)>;
                                            vpaid_enabled: ZodOptional<(...)>;
                                            duration_ms: ZodOptional<(...)>;
                                            tracking_events: ZodOptional<(...)>;
                                            captions_url: ZodOptional<(...)>;
                                            audio_description_url: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodUnion<
                                        readonly [ZodObject<(...), (...)>, ZodObject<(...), (...)>],
                                    >,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"text">;
                                        content: ZodString;
                                        language: ZodOptional<ZodString>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"url">;
                                        url: ZodString;
                                        url_type: ZodOptional<ZodUnion<(...)>>;
                                        description: ZodOptional<ZodString>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"html">;
                                        content: ZodString;
                                        version: ZodOptional<ZodString>;
                                        accessibility: ZodOptional<ZodObject<(...), (...)>>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"javascript">;
                                        content: ZodString;
                                        module_type: ZodOptional<ZodUnion<(...)>>;
                                        accessibility: ZodOptional<ZodObject<(...), (...)>>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"webhook">;
                                        url: ZodString;
                                        method: ZodOptional<ZodUnion<(...)>>;
                                        timeout_ms: ZodOptional<ZodNumber>;
                                        supported_macros: ZodOptional<ZodArray<(...)>>;
                                        required_macros: ZodOptional<ZodArray<(...)>>;
                                        response_type: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        security: ZodObject<
                                            { method: ...; hmac_header: ...; api_key_header: ... },
                                            $loose,
                                        >;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"css">;
                                        content: ZodString;
                                        media: ZodOptional<ZodString>;
                                        provenance: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodIntersection<
                                    ZodObject<
                                        {
                                            asset_type: ZodLiteral<(...)>;
                                            daast_version: ZodOptional<(...)>;
                                            duration_ms: ZodOptional<(...)>;
                                            tracking_events: ZodOptional<(...)>;
                                            companion_ads: ZodOptional<(...)>;
                                            transcript_url: ZodOptional<(...)>;
                                            provenance: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                    ZodUnion<
                                        readonly [ZodObject<(...), (...)>, ZodObject<(...), (...)>],
                                    >,
                                >,
                                ZodObject<
                                    {
                                        asset_type: ZodLiteral<"markdown">;
                                        content: ZodString;
                                        language: ZodOptional<ZodString>;
                                        markdown_flavor: ZodOptional<ZodUnion<(...)>>;
                                        allow_raw_html: ZodOptional<ZodBoolean>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        name: ZodString;
                                        objective: ZodOptional<ZodUnion<(...)>>;
                                        tone: ZodOptional<ZodString>;
                                        audience: ZodOptional<ZodString>;
                                        territory: ZodOptional<ZodString>;
                                        messaging: ZodOptional<ZodObject<(...), (...)>>;
                                        reference_assets: ZodOptional<ZodArray<(...)>>;
                                        compliance: ZodOptional<ZodObject<(...), (...)>>;
                                        asset_type: ZodLiteral<"brief">;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        catalog_id: ZodOptional<ZodString>;
                                        name: ZodOptional<ZodString>;
                                        type: ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >;
                                        url: ZodOptional<ZodString>;
                                        feed_format: ZodOptional<ZodUnion<(...)>>;
                                        update_frequency: ZodOptional<ZodUnion<(...)>>;
                                        items: ZodOptional<ZodArray<(...)>>;
                                        ids: ZodOptional<ZodArray<(...)>>;
                                        gtins: ZodOptional<ZodArray<(...)>>;
                                        tags: ZodOptional<ZodArray<(...)>>;
                                        category: ZodOptional<ZodString>;
                                        query: ZodOptional<ZodString>;
                                        conversion_events: ZodOptional<ZodArray<(...)>>;
                                        content_id_type: ZodOptional<ZodUnion<(...)>>;
                                        feed_field_mappings: ZodOptional<ZodArray<(...)>>;
                                        asset_type: ZodLiteral<"catalog">;
                                    },
                                    $loose,
                                >,
                            ],
                        >,
                    >;
                    rights: ZodOptional<
                        ZodArray<
                            ZodObject<
                                {
                                    rights_id: ZodString;
                                    rights_agent: ZodObject<{ url: ZodString; id: ZodString }, $loose>;
                                    valid_from: ZodOptional<ZodISODateTime>;
                                    valid_until: ZodOptional<ZodISODateTime>;
                                    uses: ZodArray<
                                        ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >,
                                    >;
                                    countries: ZodOptional<ZodArray<ZodString>>;
                                    excluded_countries: ZodOptional<ZodArray<ZodString>>;
                                    impression_cap: ZodOptional<ZodNumber>;
                                    right_type: ZodOptional<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...)]>,
                                    >;
                                    approval_status: ZodOptional<
                                        ZodUnion<readonly [(...), (...), (...)]>,
                                    >;
                                    verification_url: ZodOptional<ZodString>;
                                    ext: ZodOptional<ZodObject<{}, $loose>>;
                                },
                                $loose,
                            >,
                        >,
                    >;
                    industry_identifiers: ZodOptional<
                        ZodArray<
                            ZodObject<
                                {
                                    type: ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >;
                                    value: ZodString;
                                },
                                $loose,
                            >,
                        >,
                    >;
                    provenance: ZodOptional<
                        ZodObject<
                            {
                                digital_source_type: ZodOptional<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >;
                                ai_tool: ZodOptional<
                                    ZodObject<
                                        {
                                            name: ZodString;
                                            version: ZodOptional<(...)>;
                                            provider: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >;
                                human_oversight: ZodOptional<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >;
                                declared_by: ZodOptional<
                                    ZodObject<
                                        { agent_url: ZodOptional<(...)>; role: ZodUnion<(...)> },
                                        $loose,
                                    >,
                                >;
                                declared_at: ZodOptional<ZodISODateTime>;
                                created_time: ZodOptional<ZodISODateTime>;
                                c2pa: ZodOptional<ZodObject<{ manifest_url: ZodString }, $loose>>;
                                disclosure: ZodOptional<
                                    ZodObject<
                                        { required: ZodBoolean; jurisdictions: ZodOptional<(...)> },
                                        $loose,
                                    >,
                                >;
                                verification: ZodOptional<
                                    ZodArray<
                                        ZodObject<
                                            {
                                                verified_by: ...;
                                                verified_time: ...;
                                                result: ...;
                                                confidence: ...;
                                                details_url: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                                ext: ZodOptional<ZodObject<{}, $loose>>;
                            },
                            $loose,
                        >,
                    >;
                    ext: ZodOptional<ZodObject<{}, $loose>>;
                },
                $loose,
            >;
            sandbox: ZodOptional<ZodBoolean>;
            expires_at: ZodOptional<ZodISODateTime>;
            preview: ZodOptional<
                ZodObject<
                    {
                        previews: ZodArray<
                            ZodObject<
                                {
                                    preview_id: ZodString;
                                    renders: ZodArray<ZodUnion<readonly [(...), (...), (...)]>>;
                                    input: ZodObject<
                                        {
                                            name: ZodString;
                                            macros: ZodOptional<(...)>;
                                            context_description: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >;
                                },
                                $loose,
                            >,
                        >;
                        interactive_url: ZodOptional<ZodString>;
                        expires_at: ZodISODateTime;
                    },
                    $loose,
                >,
            >;
            preview_error: ZodOptional<
                ZodObject<
                    {
                        code: ZodString;
                        message: ZodString;
                        field: ZodOptional<ZodString>;
                        suggestion: ZodOptional<ZodString>;
                        retry_after: ZodOptional<ZodNumber>;
                        issues: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        pointer: ZodString;
                                        message: ZodString;
                                        keyword: ZodString;
                                        schemaPath: ZodOptional<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        details: ZodOptional<ZodObject<{}, $loose>>;
                        recovery: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"transient">,
                                    ZodLiteral<"correctable">,
                                    ZodLiteral<"terminal">,
                                ],
                            >,
                        >;
                    },
                    $loose,
                >,
            >;
            pricing_option_id: ZodOptional<ZodString>;
            vendor_cost: ZodOptional<ZodNumber>;
            currency: ZodOptional<ZodString>;
            consumption: ZodOptional<
                ZodObject<
                    {
                        tokens: ZodOptional<ZodNumber>;
                        images_generated: ZodOptional<ZodNumber>;
                        renders: ZodOptional<ZodNumber>;
                        duration_seconds: ZodOptional<ZodNumber>;
                    },
                    $loose,
                >,
            >;
            context: ZodOptional<ZodObject<{}, $loose>>;
            ext: ZodOptional<ZodObject<{}, $loose>>;
        },
        $loose,
    > = ...