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

    Variable FormatSchemaConst

    FormatSchema: ZodObject<
        {
            format_id: ZodObject<
                {
                    agent_url: ZodString;
                    id: ZodString;
                    width: ZodOptional<ZodNumber>;
                    height: ZodOptional<ZodNumber>;
                    duration_ms: ZodOptional<ZodNumber>;
                },
                $loose,
            >;
            name: ZodString;
            description: ZodOptional<ZodString>;
            example_url: ZodOptional<ZodString>;
            accepts_parameters: ZodOptional<
                ZodArray<
                    ZodUnion<readonly [ZodLiteral<"dimensions">, ZodLiteral<"duration">]>,
                >,
            >;
            renders: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodObject<
                                {
                                    role: ZodString;
                                    dimensions: ZodObject<
                                        {
                                            width: ZodOptional<(...)>;
                                            height: ZodOptional<(...)>;
                                            min_width: ZodOptional<(...)>;
                                            min_height: ZodOptional<(...)>;
                                            max_width: ZodOptional<(...)>;
                                            max_height: ZodOptional<(...)>;
                                            unit: ZodOptional<(...)>;
                                            responsive: ZodOptional<(...)>;
                                            aspect_ratio: ZodOptional<(...)>;
                                        },
                                        $loose,
                                    >;
                                },
                                $loose,
                            >,
                            ZodObject<
                                { role: ZodString; parameters_from_format_id: ZodLiteral<true> },
                                $loose,
                            >,
                        ],
                    >,
                >,
            >;
            assets: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodUnion<
                                readonly [
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ...; requirements: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ... }, $loose>,
                                    >,
                                    ZodIntersection<
                                        ZodObject<
                                            {
                                                item_type: ...;
                                                asset_id: ...;
                                                asset_role: ...;
                                                required: ...;
                                                overlays: ...;
                                            },
                                            $loose,
                                        >,
                                        ZodObject<{ asset_type: ... }, $loose>,
                                    >,
                                ],
                            >,
                            ZodObject<
                                {
                                    item_type: ZodLiteral<"repeatable_group">;
                                    asset_group_id: ZodString;
                                    required: ZodBoolean;
                                    min_count: ZodNumber;
                                    max_count: ZodNumber;
                                    selection_mode: ZodOptional<ZodUnion<readonly [(...), (...)]>>;
                                    assets: ZodArray<
                                        ZodUnion<
                                            readonly [
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                                (...),
                                            ],
                                        >,
                                    >;
                                },
                                $loose,
                            >,
                        ],
                    >,
                >,
            >;
            delivery: ZodOptional<ZodObject<{}, $loose>>;
            supported_macros: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"MEDIA_BUY_ID">,
                                    ZodLiteral<"PACKAGE_ID">,
                                    ZodLiteral<"CREATIVE_ID">,
                                    ZodLiteral<"CACHEBUSTER">,
                                    ZodLiteral<"TIMESTAMP">,
                                    ZodLiteral<"CLICK_URL">,
                                    ZodLiteral<"GDPR">,
                                    ZodLiteral<"GDPR_CONSENT">,
                                    ZodLiteral<"US_PRIVACY">,
                                    ZodLiteral<"GPP_STRING">,
                                    ZodLiteral<"GPP_SID">,
                                    ZodLiteral<"IP_ADDRESS">,
                                    ZodLiteral<"LIMIT_AD_TRACKING">,
                                    ZodLiteral<"DEVICE_TYPE">,
                                    ZodLiteral<"OS">,
                                    ZodLiteral<"OS_VERSION">,
                                    ZodLiteral<"DEVICE_MAKE">,
                                    ZodLiteral<"DEVICE_MODEL">,
                                    ZodLiteral<"USER_AGENT">,
                                    ZodLiteral<"APP_BUNDLE">,
                                    ZodLiteral<"APP_NAME">,
                                    ZodLiteral<"COUNTRY">,
                                    ZodLiteral<"REGION">,
                                    ZodLiteral<"CITY">,
                                    ZodLiteral<"ZIP">,
                                    ZodLiteral<"DMA">,
                                    ZodLiteral<"LAT">,
                                    ZodLiteral<"LONG">,
                                    ZodLiteral<"DEVICE_ID">,
                                    ZodLiteral<"DEVICE_ID_TYPE">,
                                    ZodLiteral<"DOMAIN">,
                                    ZodLiteral<"PAGE_URL">,
                                    ZodLiteral<"REFERRER">,
                                    ZodLiteral<"KEYWORDS">,
                                    ZodLiteral<"PLACEMENT_ID">,
                                    ZodLiteral<"FOLD_POSITION">,
                                    ZodLiteral<"AD_WIDTH">,
                                    ZodLiteral<"AD_HEIGHT">,
                                    ZodLiteral<"VIDEO_ID">,
                                    ZodLiteral<"VIDEO_TITLE">,
                                    ZodLiteral<"VIDEO_DURATION">,
                                    ZodLiteral<"VIDEO_CATEGORY">,
                                    ZodLiteral<"CONTENT_GENRE">,
                                    ZodLiteral<"CONTENT_RATING">,
                                    ZodLiteral<"PLAYER_WIDTH">,
                                    ZodLiteral<"PLAYER_HEIGHT">,
                                    ZodLiteral<"POD_POSITION">,
                                    ZodLiteral<"POD_SIZE">,
                                    ZodLiteral<"AD_BREAK_ID">,
                                    ZodLiteral<"STATION_ID">,
                                    ZodLiteral<"COLLECTION_NAME">,
                                    ZodLiteral<"INSTALLMENT_ID">,
                                    ZodLiteral<"AUDIO_DURATION">,
                                    ZodLiteral<"TMPX">,
                                    ZodLiteral<"AXEM">,
                                    ZodLiteral<"CATALOG_ID">,
                                    ZodLiteral<"SKU">,
                                    ZodLiteral<"GTIN">,
                                    ZodLiteral<"OFFERING_ID">,
                                    ZodLiteral<"JOB_ID">,
                                    ZodLiteral<"HOTEL_ID">,
                                    ZodLiteral<"FLIGHT_ID">,
                                    ZodLiteral<"VEHICLE_ID">,
                                    ZodLiteral<"LISTING_ID">,
                                    ZodLiteral<"STORE_ID">,
                                    ZodLiteral<"PROGRAM_ID">,
                                    ZodLiteral<"DESTINATION_ID">,
                                    ZodLiteral<"CREATIVE_VARIANT_ID">,
                                    ZodLiteral<"APP_ITEM_ID">,
                                ],
                            >,
                            ZodString,
                        ],
                    >,
                >,
            >;
            input_format_ids: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            agent_url: ZodString;
                            id: ZodString;
                            width: ZodOptional<ZodNumber>;
                            height: ZodOptional<ZodNumber>;
                            duration_ms: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >,
            >;
            output_format_ids: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            agent_url: ZodString;
                            id: ZodString;
                            width: ZodOptional<ZodNumber>;
                            height: ZodOptional<ZodNumber>;
                            duration_ms: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >,
            >;
            format_card: ZodOptional<
                ZodObject<
                    {
                        format_id: ZodObject<
                            {
                                agent_url: ZodString;
                                id: ZodString;
                                width: ZodOptional<ZodNumber>;
                                height: ZodOptional<ZodNumber>;
                                duration_ms: ZodOptional<ZodNumber>;
                            },
                            $loose,
                        >;
                        manifest: ZodObject<{}, $loose>;
                    },
                    $loose,
                >,
            >;
            accessibility: ZodOptional<
                ZodObject<
                    {
                        wcag_level: ZodUnion<
                            readonly [ZodLiteral<"A">, ZodLiteral<"AA">, ZodLiteral<"AAA">],
                        >;
                        requires_accessible_assets: ZodOptional<ZodBoolean>;
                    },
                    $loose,
                >,
            >;
            supported_disclosure_positions: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodLiteral<"prominent">,
                            ZodLiteral<"footer">,
                            ZodLiteral<"audio">,
                            ZodLiteral<"subtitle">,
                            ZodLiteral<"overlay">,
                            ZodLiteral<"end_card">,
                            ZodLiteral<"pre_roll">,
                            ZodLiteral<"companion">,
                        ],
                    >,
                >,
            >;
            disclosure_capabilities: ZodOptional<
                ZodArray<
                    ZodObject<
                        {
                            position: ZodUnion<
                                readonly [
                                    ZodLiteral<"prominent">,
                                    ZodLiteral<"footer">,
                                    ZodLiteral<"audio">,
                                    ZodLiteral<"subtitle">,
                                    ZodLiteral<"overlay">,
                                    ZodLiteral<"end_card">,
                                    ZodLiteral<"pre_roll">,
                                    ZodLiteral<"companion">,
                                ],
                            >;
                            persistence: ZodArray<
                                ZodUnion<
                                    readonly [
                                        ZodLiteral<"continuous">,
                                        ZodLiteral<"initial">,
                                        ZodLiteral<"flexible">,
                                    ],
                                >,
                            >;
                        },
                        $loose,
                    >,
                >,
            >;
            format_card_detailed: ZodOptional<
                ZodObject<
                    {
                        format_id: ZodObject<
                            {
                                agent_url: ZodString;
                                id: ZodString;
                                width: ZodOptional<ZodNumber>;
                                height: ZodOptional<ZodNumber>;
                                duration_ms: ZodOptional<ZodNumber>;
                            },
                            $loose,
                        >;
                        manifest: ZodObject<{}, $loose>;
                    },
                    $loose,
                >,
            >;
            reported_metrics: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodLiteral<"impressions">,
                            ZodLiteral<"spend">,
                            ZodLiteral<"clicks">,
                            ZodLiteral<"ctr">,
                            ZodLiteral<"video_completions">,
                            ZodLiteral<"completion_rate">,
                            ZodLiteral<"conversions">,
                            ZodLiteral<"conversion_value">,
                            ZodLiteral<"roas">,
                            ZodLiteral<"cost_per_acquisition">,
                            ZodLiteral<"new_to_brand_rate">,
                            ZodLiteral<"viewability">,
                            ZodLiteral<"engagement_rate">,
                            ZodLiteral<"views">,
                            ZodLiteral<"completed_views">,
                            ZodLiteral<"leads">,
                            ZodLiteral<"reach">,
                            ZodLiteral<"frequency">,
                            ZodLiteral<"grps">,
                            ZodLiteral<"quartile_data">,
                            ZodLiteral<"dooh_metrics">,
                            ZodLiteral<"cost_per_click">,
                        ],
                    >,
                >,
            >;
            pricing_options: ZodOptional<
                ZodArray<
                    ZodIntersection<
                        ZodObject<{ pricing_option_id: ZodString }, $loose>,
                        ZodUnion<
                            readonly [
                                ZodObject<
                                    {
                                        model: ZodLiteral<"cpm">;
                                        cpm: ZodNumber;
                                        currency: ZodString;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        model: ZodLiteral<"percent_of_media">;
                                        percent: ZodNumber;
                                        max_cpm: ZodOptional<ZodNumber>;
                                        currency: ZodString;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        model: ZodLiteral<"flat_fee">;
                                        amount: ZodNumber;
                                        period: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        currency: ZodString;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        model: ZodLiteral<"per_unit">;
                                        unit: ZodString;
                                        unit_price: ZodNumber;
                                        currency: ZodString;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        model: ZodLiteral<"custom">;
                                        description: ZodString;
                                        metadata: ZodObject<{ summary_for_operator: ... }, $loose>;
                                        currency: ZodOptional<ZodString>;
                                        ext: ZodOptional<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            ],
                        >,
                    >,
                >,
            >;
        },
        $loose,
    > = ...