@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Variable CanonicalFormatConst

    CanonicalFormat: {
        declaration: <K extends keyof CanonicalFormatDeclarationMap>(
            format_kind: K,
            params: CanonicalFormatParams<K>,
            fields?: CanonicalFormatDeclarationFields<K>,
        ) => CanonicalFormatDeclaration<K>;
        image: (
            params: Record<string, unknown> & CanonicalFormatImage,
            fields?: CanonicalFormatDeclarationFields<"image">,
        ) => WithCommonDeclaration<ImageFormatDeclaration>;
        html5: (
            params: Record<string, unknown> & CanonicalFormatHTML5Banner,
            fields?: CanonicalFormatDeclarationFields<"html5">,
        ) => WithCommonDeclaration<HTML5FormatDeclaration>;
        displayTag: (
            params: Record<string, unknown> & CanonicalFormatDisplayTag,
            fields?: CanonicalFormatDeclarationFields<"display_tag">,
        ) => WithCommonDeclaration<DisplayTagFormatDeclaration>;
        imageCarousel: (
            params: Record<string, unknown> & CanonicalFormatImageCarousel,
            fields?: CanonicalFormatDeclarationFields<"image_carousel">,
        ) => WithCommonDeclaration<ImageCarouselFormatDeclaration>;
        videoHosted: (
            params: Record<string, unknown> & CanonicalFormatHostedVideo,
            fields?: CanonicalFormatDeclarationFields<"video_hosted">,
        ) => WithCommonDeclaration<HostedVideoFormatDeclaration>;
        videoVast: (
            params: Record<string, unknown> & CanonicalFormatVASTVideo,
            fields?: CanonicalFormatDeclarationFields<"video_vast">,
        ) => WithCommonDeclaration<VASTVideoFormatDeclaration>;
        audioHosted: (
            params: Record<string, unknown> & CanonicalFormatHostedAudio,
            fields?: CanonicalFormatDeclarationFields<"audio_hosted">,
        ) => WithCommonDeclaration<HostedAudioFormatDeclaration>;
        audioDaast: (
            params: Record<string, unknown> & CanonicalFormatDAASTAudio,
            fields?: CanonicalFormatDeclarationFields<"audio_daast">,
        ) => WithCommonDeclaration<DAASTAudioFormatDeclaration>;
        sponsoredPlacement: (
            params: Record<string, unknown> & CanonicalFormatSponsoredPlacementRetailMediaCatalogDriven,
            fields?: CanonicalFormatDeclarationFields<"sponsored_placement">,
        ) => WithCommonDeclaration<SponsoredPlacementFormatDeclaration>;
        nativeInFeed: (
            params: Record<string, unknown> & CanonicalFormatNativeInFeed,
            fields?: CanonicalFormatDeclarationFields<"native_in_feed">,
        ) => WithCommonDeclaration<NativeInFeedFormatDeclaration>;
        responsiveCreative: (
            params: Record<string, unknown> & CanonicalFormatResponsiveCreative,
            fields?: CanonicalFormatDeclarationFields<"responsive_creative">,
        ) => WithCommonDeclaration<ResponsiveCreativeFormatDeclaration>;
        agentPlacement: (
            params: Record<string, unknown> & CanonicalFormatAgentPlacementAISurfaceSponsoredPlacement,
            fields?: CanonicalFormatDeclarationFields<"agent_placement">,
        ) => WithCommonDeclaration<AgentPlacementFormatDeclaration>;
        custom: (
            format_shape: string,
            format_schema: { uri: string; digest: string },
            params: CanonicalFormatParams<"custom">,
            fields?: Omit<
                CanonicalFormatDeclarationFields<"custom">,
                "format_shape" | "format_schema",
            >,
        ) => WithCommonDeclaration<CustomFormatDeclaration>;
        productCard: (fields: ProductCardFields) => ProductCardFields;
        productCardDetailed: (
            fields: ProductCardDetailedFields,
        ) => ProductCardDetailedFields;
    } = ...

    Type Declaration