@adcp/client API Reference - v4.19.0
    Preparing search index...

    Variable CreativeAssetSchemaConst

    CreativeAssetSchema: ZodObject<
        {
            creative_id: ZodString;
            name: ZodString;
            format_id: ZodObject<
                {
                    agent_url: ZodString;
                    id: ZodString;
                    width: ZodOptional<ZodNullable<ZodNumber>>;
                    height: ZodOptional<ZodNullable<ZodNumber>>;
                    duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                },
                $loose,
            >;
            assets: ZodRecord<
                ZodString,
                ZodUnion<
                    readonly [
                        ZodObject<
                            {
                                url: ZodString;
                                width: ZodNumber;
                                height: ZodNumber;
                                format: ZodOptional<ZodNullable<ZodString>>;
                                alt_text: ZodOptional<ZodNullable<ZodString>>;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                url: ZodString;
                                width: ZodNumber;
                                height: ZodNumber;
                                duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                                file_size_bytes: ZodOptional<ZodNullable<ZodNumber>>;
                                container_format: ZodOptional<ZodNullable<ZodString>>;
                                video_codec: ZodOptional<ZodNullable<ZodString>>;
                                video_bitrate_kbps: ZodOptional<ZodNullable<ZodNumber>>;
                                frame_rate: ZodOptional<ZodNullable<ZodString>>;
                                frame_rate_type: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...)]>>,
                                >;
                                scan_type: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...)]>>,
                                >;
                                color_space: ZodOptional<
                                    ZodNullable<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...)]>,
                                    >,
                                >;
                                hdr_format: ZodOptional<
                                    ZodNullable<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...)]>,
                                    >,
                                >;
                                chroma_subsampling: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                                video_bit_depth: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                                gop_interval_seconds: ZodOptional<ZodNullable<ZodNumber>>;
                                gop_type: ZodOptional<ZodNullable<ZodUnion<readonly [(...), (...)]>>>;
                                moov_atom_position: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...)]>>,
                                >;
                                has_audio: ZodOptional<ZodNullable<ZodBoolean>>;
                                audio_codec: ZodOptional<ZodNullable<ZodString>>;
                                audio_sampling_rate_hz: ZodOptional<ZodNullable<ZodNumber>>;
                                audio_channels: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...), (...)]>>,
                                >;
                                audio_bit_depth: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                                audio_bitrate_kbps: ZodOptional<ZodNullable<ZodNumber>>;
                                audio_loudness_lufs: ZodOptional<ZodNullable<ZodNumber>>;
                                audio_true_peak_dbfs: ZodOptional<ZodNullable<ZodNumber>>;
                                captions_url: ZodOptional<ZodNullable<ZodString>>;
                                transcript_url: ZodOptional<ZodNullable<ZodString>>;
                                audio_description_url: ZodOptional<ZodNullable<ZodString>>;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                url: ZodString;
                                duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                                file_size_bytes: ZodOptional<ZodNullable<ZodNumber>>;
                                container_format: ZodOptional<ZodNullable<ZodString>>;
                                codec: ZodOptional<ZodNullable<ZodString>>;
                                sampling_rate_hz: ZodOptional<ZodNullable<ZodNumber>>;
                                channels: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...), (...)]>>,
                                >;
                                bit_depth: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                                bitrate_kbps: ZodOptional<ZodNullable<ZodNumber>>;
                                loudness_lufs: ZodOptional<ZodNullable<ZodNumber>>;
                                true_peak_dbfs: ZodOptional<ZodNullable<ZodNumber>>;
                                transcript_url: ZodOptional<ZodNullable<ZodString>>;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodUnion<
                            readonly [
                                ZodObject<
                                    {
                                        delivery_type: ZodLiteral<"url">;
                                        url: ZodString;
                                        vast_version: ZodOptional<ZodNullable<(...)>>;
                                        vpaid_enabled: ZodOptional<ZodNullable<(...)>>;
                                        duration_ms: ZodOptional<ZodNullable<(...)>>;
                                        tracking_events: ZodOptional<ZodNullable<(...)>>;
                                        captions_url: ZodOptional<ZodNullable<(...)>>;
                                        audio_description_url: ZodOptional<ZodNullable<(...)>>;
                                        provenance: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        delivery_type: ZodLiteral<"inline">;
                                        content: ZodString;
                                        vast_version: ZodOptional<ZodNullable<(...)>>;
                                        vpaid_enabled: ZodOptional<ZodNullable<(...)>>;
                                        duration_ms: ZodOptional<ZodNullable<(...)>>;
                                        tracking_events: ZodOptional<ZodNullable<(...)>>;
                                        captions_url: ZodOptional<ZodNullable<(...)>>;
                                        audio_description_url: ZodOptional<ZodNullable<(...)>>;
                                        provenance: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            ],
                        >,
                        ZodObject<
                            {
                                content: ZodString;
                                language: ZodOptional<ZodNullable<ZodString>>;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                url: ZodString;
                                url_type: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                                description: ZodOptional<ZodNullable<ZodString>>;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                content: ZodString;
                                version: ZodOptional<ZodNullable<ZodString>>;
                                accessibility: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                alt_text: ...;
                                                keyboard_navigable: ...;
                                                motion_control: ...;
                                                screen_reader_tested: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                content: ZodString;
                                module_type: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...)]>>,
                                >;
                                accessibility: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                alt_text: ...;
                                                keyboard_navigable: ...;
                                                motion_control: ...;
                                                screen_reader_tested: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                url: ZodString;
                                method: ZodOptional<ZodNullable<ZodUnion<readonly [(...), (...)]>>>;
                                timeout_ms: ZodOptional<ZodNullable<ZodNumber>>;
                                supported_macros: ZodOptional<ZodNullable<ZodArray<ZodUnion<(...)>>>>;
                                required_macros: ZodOptional<ZodNullable<ZodArray<ZodUnion<(...)>>>>;
                                response_type: ZodUnion<
                                    readonly [
                                        ZodLiteral<"html">,
                                        ZodLiteral<"json">,
                                        ZodLiteral<"xml">,
                                        ZodLiteral<"javascript">,
                                    ],
                                >;
                                security: ZodObject<
                                    {
                                        method: ZodUnion<readonly [(...), (...), (...)]>;
                                        hmac_header: ZodOptional<ZodNullable<(...)>>;
                                        api_key_header: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                content: ZodString;
                                media: ZodOptional<ZodNullable<ZodString>>;
                                provenance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            {
                                                digital_source_type: ...;
                                                ai_tool: ...;
                                                human_oversight: ...;
                                                declared_by: ...;
                                                declared_at: ...;
                                                created_time: ...;
                                                c2pa: ...;
                                                disclosure: ...;
                                                verification: ...;
                                                ext: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodUnion<
                            readonly [
                                ZodObject<
                                    {
                                        delivery_type: ZodLiteral<"url">;
                                        url: ZodString;
                                        daast_version: ZodOptional<ZodNullable<(...)>>;
                                        duration_ms: ZodOptional<ZodNullable<(...)>>;
                                        tracking_events: ZodOptional<ZodNullable<(...)>>;
                                        companion_ads: ZodOptional<ZodNullable<(...)>>;
                                        transcript_url: ZodOptional<ZodNullable<(...)>>;
                                        provenance: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        delivery_type: ZodLiteral<"inline">;
                                        content: ZodString;
                                        daast_version: ZodOptional<ZodNullable<(...)>>;
                                        duration_ms: ZodOptional<ZodNullable<(...)>>;
                                        tracking_events: ZodOptional<ZodNullable<(...)>>;
                                        companion_ads: ZodOptional<ZodNullable<(...)>>;
                                        transcript_url: ZodOptional<ZodNullable<(...)>>;
                                        provenance: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                            ],
                        >,
                        ZodObject<
                            {
                                content: ZodString;
                                language: ZodOptional<ZodNullable<ZodString>>;
                                markdown_flavor: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...)]>>,
                                >;
                                allow_raw_html: ZodOptional<ZodNullable<ZodBoolean>>;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                name: ZodString;
                                objective: ZodOptional<
                                    ZodNullable<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...)]>,
                                    >,
                                >;
                                tone: ZodOptional<ZodNullable<ZodString>>;
                                audience: ZodOptional<ZodNullable<ZodString>>;
                                territory: ZodOptional<ZodNullable<ZodString>>;
                                messaging: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            { headline: ...; tagline: ...; cta: ...; key_messages: ... },
                                            $loose,
                                        >,
                                    >,
                                >;
                                reference_assets: ZodOptional<
                                    ZodNullable<ZodArray<ZodObject<(...), (...)>>>,
                                >;
                                compliance: ZodOptional<
                                    ZodNullable<
                                        ZodObject<
                                            { required_disclosures: ...; prohibited_claims: ... },
                                            $loose,
                                        >,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                        ZodObject<
                            {
                                catalog_id: ZodOptional<ZodNullable<ZodString>>;
                                name: ZodOptional<ZodNullable<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<ZodNullable<ZodString>>;
                                feed_format: ZodOptional<
                                    ZodNullable<
                                        ZodUnion<readonly [(...), (...), (...), (...), (...)]>,
                                    >,
                                >;
                                update_frequency: ZodOptional<
                                    ZodNullable<ZodUnion<readonly [(...), (...), (...), (...)]>>,
                                >;
                                items: ZodOptional<ZodNullable<ZodArray<ZodObject<(...), (...)>>>>;
                                ids: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                                gtins: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                                tags: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
                                category: ZodOptional<ZodNullable<ZodString>>;
                                query: ZodOptional<ZodNullable<ZodString>>;
                                conversion_events: ZodOptional<
                                    ZodNullable<ZodArray<ZodUnion<(...)>>>,
                                >;
                                content_id_type: ZodOptional<
                                    ZodNullable<
                                        ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >,
                                    >,
                                >;
                                feed_field_mappings: ZodOptional<
                                    ZodNullable<ZodArray<ZodObject<(...), (...)>>>,
                                >;
                            },
                            $loose,
                        >,
                    ],
                >,
            >;
            inputs: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodObject<
                            {
                                name: ZodString;
                                macros: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>;
                                context_description: ZodOptional<ZodNullable<ZodString>>;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            tags: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
            status: ZodOptional<
                ZodNullable<
                    ZodUnion<
                        readonly [
                            ZodLiteral<"processing">,
                            ZodLiteral<"pending_review">,
                            ZodLiteral<"approved">,
                            ZodLiteral<"rejected">,
                            ZodLiteral<"archived">,
                        ],
                    >,
                >,
            >;
            weight: ZodOptional<ZodNullable<ZodNumber>>;
            placement_ids: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
            provenance: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            digital_source_type: ZodOptional<
                                ZodNullable<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            ai_tool: ZodOptional<
                                ZodNullable<
                                    ZodObject<
                                        {
                                            name: ZodString;
                                            version: ZodOptional<(...)>;
                                            provider: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >,
                                >,
                            >;
                            human_oversight: ZodOptional<
                                ZodNullable<
                                    ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >,
                            >;
                            declared_by: ZodOptional<
                                ZodNullable<
                                    ZodObject<
                                        { agent_url: ZodOptional<(...)>; role: ZodUnion<(...)> },
                                        $loose,
                                    >,
                                >,
                            >;
                            declared_at: ZodOptional<ZodNullable<ZodString>>;
                            created_time: ZodOptional<ZodNullable<ZodString>>;
                            c2pa: ZodOptional<
                                ZodNullable<ZodObject<{ manifest_url: ZodString }, $loose>>,
                            >;
                            disclosure: ZodOptional<
                                ZodNullable<
                                    ZodObject<
                                        { required: ZodBoolean; jurisdictions: ZodOptional<(...)> },
                                        $loose,
                                    >,
                                >,
                            >;
                            verification: ZodOptional<
                                ZodNullable<
                                    ZodArray<
                                        ZodObject<
                                            {
                                                verified_by: ...;
                                                verified_time: ...;
                                                result: ...;
                                                confidence: ...;
                                                details_url: ...;
                                            },
                                            $loose,
                                        >,
                                    >,
                                >,
                            >;
                            ext: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
                        },
                        $loose,
                    >,
                >,
            >;
        },
        $loose,
    > = ...