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

    Variable FormatSchemaConst

    FormatSchema: ZodObject<
        {
            format_id: ZodObject<
                {
                    agent_url: ZodString;
                    id: ZodString;
                    width: ZodOptional<ZodNullable<ZodNumber>>;
                    height: ZodOptional<ZodNullable<ZodNumber>>;
                    duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                },
                $loose,
            >;
            name: ZodString;
            description: ZodOptional<ZodNullable<ZodString>>;
            example_url: ZodOptional<ZodNullable<ZodString>>;
            accepts_parameters: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodUnion<
                            readonly [ZodLiteral<"dimensions">, ZodLiteral<"duration">],
                        >,
                    >,
                >,
            >;
            renders: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodUnion<
                            readonly [
                                ZodRecord<ZodString, ZodUnknown>,
                                ZodObject<{ parameters_from_format_id: ZodLiteral<true> }, $loose>,
                            ],
                        >,
                    >,
                >,
            >;
            assets: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodUnion<
                            readonly [
                                ZodObject<
                                    {
                                        item_type: ZodLiteral<"individual">;
                                        asset_id: ZodString;
                                        asset_role: ZodOptional<ZodNullable<(...)>>;
                                        required: ZodBoolean;
                                        overlays: ZodOptional<ZodNullable<(...)>>;
                                    },
                                    $loose,
                                >,
                                ZodObject<
                                    {
                                        item_type: ZodLiteral<"repeatable_group">;
                                        asset_group_id: ZodString;
                                        required: ZodBoolean;
                                        min_count: ZodNumber;
                                        max_count: ZodNumber;
                                        selection_mode: ZodOptional<ZodNullable<(...)>>;
                                        assets: ZodArray<ZodObject<(...), (...)>>;
                                    },
                                    $loose,
                                >,
                            ],
                        >,
                    >,
                >,
            >;
            delivery: ZodOptional<ZodNullable<ZodObject<{}, $loose>>>;
            supported_macros: ZodOptional<
                ZodNullable<
                    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<"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<
                ZodNullable<
                    ZodArray<
                        ZodObject<
                            {
                                agent_url: ZodString;
                                id: ZodString;
                                width: ZodOptional<ZodNullable<ZodNumber>>;
                                height: ZodOptional<ZodNullable<ZodNumber>>;
                                duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            output_format_ids: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodObject<
                            {
                                agent_url: ZodString;
                                id: ZodString;
                                width: ZodOptional<ZodNullable<ZodNumber>>;
                                height: ZodOptional<ZodNullable<ZodNumber>>;
                                duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            format_card: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            format_id: ZodObject<
                                {
                                    agent_url: ZodString;
                                    id: ZodString;
                                    width: ZodOptional<ZodNullable<ZodNumber>>;
                                    height: ZodOptional<ZodNullable<ZodNumber>>;
                                    duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                                },
                                $loose,
                            >;
                            manifest: ZodObject<{}, $loose>;
                        },
                        $loose,
                    >,
                >,
            >;
            accessibility: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            wcag_level: ZodUnion<
                                readonly [ZodLiteral<"A">, ZodLiteral<"AA">, ZodLiteral<"AAA">],
                            >;
                            requires_accessible_assets: ZodOptional<ZodNullable<ZodBoolean>>;
                        },
                        $loose,
                    >,
                >,
            >;
            supported_disclosure_positions: ZodOptional<
                ZodNullable<
                    ZodArray<
                        ZodUnion<
                            readonly [
                                ZodLiteral<"prominent">,
                                ZodLiteral<"footer">,
                                ZodLiteral<"audio">,
                                ZodLiteral<"subtitle">,
                                ZodLiteral<"overlay">,
                                ZodLiteral<"end_card">,
                                ZodLiteral<"pre_roll">,
                                ZodLiteral<"companion">,
                            ],
                        >,
                    >,
                >,
            >;
            disclosure_capabilities: ZodOptional<
                ZodNullable<
                    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<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >,
                                >;
                            },
                            $loose,
                        >,
                    >,
                >,
            >;
            format_card_detailed: ZodOptional<
                ZodNullable<
                    ZodObject<
                        {
                            format_id: ZodObject<
                                {
                                    agent_url: ZodString;
                                    id: ZodString;
                                    width: ZodOptional<ZodNullable<ZodNumber>>;
                                    height: ZodOptional<ZodNullable<ZodNumber>>;
                                    duration_ms: ZodOptional<ZodNullable<ZodNumber>>;
                                },
                                $loose,
                            >;
                            manifest: ZodObject<{}, $loose>;
                        },
                        $loose,
                    >,
                >,
            >;
            reported_metrics: ZodOptional<
                ZodNullable<
                    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">,
                            ],
                        >,
                    >,
                >,
            >;
        },
        $loose,
    > = ...