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

    Function getOptionalAssets

    • Get only optional assets from a Format

      Note: When using deprecated assets_required, this will always return empty since assets_required only contained required assets.

      Parameters

      • format: Format

        The Format object

      Returns (
          | BaseIndividualAsset
          | {
              item_type: "repeatable_group";
              asset_group_id: string;
              required: boolean;
              min_count: number;
              max_count: number;
              selection_mode?: "sequential"
              | "optimize";
              assets: BaseGroupAsset[];
          }
      )[]

      Array of optional assets only

      • BaseIndividualAsset
      • {
            item_type: "repeatable_group";
            asset_group_id: string;
            required: boolean;
            min_count: number;
            max_count: number;
            selection_mode?: "sequential" | "optimize";
            assets: BaseGroupAsset[];
        }
        • item_type: "repeatable_group"

          Discriminator indicating this is a repeatable asset group

        • asset_group_id: string

          Identifier for this asset group (e.g., 'product', 'slide', 'card')

        • required: boolean

          Whether this asset group is required. If true, at least min_count repetitions must be provided.

        • min_count: number

          Minimum number of repetitions required (if group is required) or allowed (if optional)

        • max_count: number

          Maximum number of repetitions allowed

        • Optionalselection_mode?: "sequential" | "optimize"

          How the platform uses repetitions of this group. 'sequential' means all items display in order (carousels, playlists). 'optimize' means the platform selects the best-performing combination from alternatives (asset group optimization like Meta Advantage+ or Google Pmax).

        • assets: BaseGroupAsset[]

          Assets within each repetition of this group

      const optionalAssets = getOptionalAssets(format);
      console.log(`Can optionally provide ${optionalAssets.length} additional assets`);