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

    Interface InlineCreativesForPackagesLegacyOptions<TPackage>

    Options for the explicit legacy inline-creative compatibility helper.

    Prefer canonical selectors and inlineCreativesForPackages.

    interface InlineCreativesForPackagesLegacyOptions<
        TPackage extends
            LegacyInlineCreativePackage = LegacyInlineCreativePackage,
    > {
        assignments?: readonly InlineCreativeAssignment[];
        includeUnassignedCreatives?: boolean;
        filterByFormat?: boolean;
        packageId?: (pkg: TPackage, index: number) => string | undefined;
        onUnmatchedAssignment?: "ignore" | "throw";
        onMissingCreative?: "ignore" | "throw";
        onIncompatibleAssignment?: "ignore" | "throw";
        creativeFormatWireMode?: "unknown" | "legacy";
        legacyFormatConverter?: LegacyFormatConverter;
        canonicalFormatLegacyResolver?: CanonicalFormatLegacyResolver;
    }

    Type Parameters

    Hierarchy

    • InlineCreativesForPackagesBaseOptions<TPackage>
      • InlineCreativesForPackagesLegacyOptions
    Index

    Properties

    assignments? includeUnassignedCreatives? filterByFormat? packageId? onUnmatchedAssignment? onMissingCreative? onIncompatibleAssignment? creativeFormatWireMode? legacyFormatConverter? canonicalFormatLegacyResolver?

    Properties

    assignments?: readonly InlineCreativeAssignment[]

    Package-scoped assignment instructions. When supplied, only creatives assigned to each package are inlined unless includeUnassignedCreatives is true.

    includeUnassignedCreatives?: boolean

    Include compatible creatives that have no assignment entry. Defaults to false when assignments are supplied and true when no assignments exist.

    filterByFormat?: boolean

    Filter creatives by package format selectors (format_option_refs or format_kind). The legacy helper also recognizes format_ids. Defaults to true.

    packageId?: (pkg: TPackage, index: number) => string | undefined

    Resolve the package identifier used to match assignment.package_id. Defaults to package_id, then context.buyer_ref, then buyer_ref.

    onUnmatchedAssignment?: "ignore" | "throw"

    Behavior when an assignment names a package not present in the package list. Defaults to throw so package scoping mistakes do not broaden delivery silently.

    onMissingCreative?: "ignore" | "throw"

    Behavior when an assignment names a creative not present in creatives. Defaults to throw because inline payloads cannot reference library-only creatives.

    onIncompatibleAssignment?: "ignore" | "throw"

    Behavior when an explicit assignment names a creative whose format cannot satisfy the target package selectors. Defaults to throw so authoring mistakes do not silently remove assigned delivery.

    creativeFormatWireMode?: "unknown" | "legacy"

    Fail closed when the seller's legacy wire shape is not known.

    legacyFormatConverter?: LegacyFormatConverter

    Convert custom legacy creative refs before matching/projecting.

    canonicalFormatLegacyResolver?: CanonicalFormatLegacyResolver

    Resolve canonical custom formats when no built-in or private legacy mapping exists.

    Settings

    Member Visibility

    On This Page

    Properties