Type Alias PreviewCreativeRequest

Type Declaration

• {
      request_type: "single";
      format_id?: FormatID;
      creative_manifest: CreativeManifest;
      inputs?: {
          name: string;
          macros?: { [k: string]: string | undefined };
          context_description?: string;
      }[];
      template_id?: string;
      quality?: CreativeQuality;
      output_format?: PreviewOutputFormat;
      item_limit?: number;
      context?: ContextObject;
      ext?: ExtensionObject;
  }

  • request_type: "single"

    Discriminator indicating this is a single preview request

  • Optionalformat_id?: FormatID

  • creative_manifest: CreativeManifest

  • Optionalinputs?: {
        name: string;
        macros?: { [k: string]: string | undefined };
        context_description?: string;
    }[]

    Array of input sets for generating multiple preview variants. Each input set defines macros and context values for one preview rendering. If not provided, creative agent will generate default previews.

  • Optionaltemplate_id?: string

    Specific template ID for custom format rendering

  • Optionalquality?: CreativeQuality

  • Optionaloutput_format?: PreviewOutputFormat

  • Optionalitem_limit?: number

    Maximum number of catalog items to render in the preview. For catalog-driven generative formats, caps how many items are rendered per preview variant. When item_limit exceeds the format's max_items, the creative agent SHOULD use the lesser of the two. Ignored when the manifest contains no catalog assets. Creative agents SHOULD default to a reasonable sample when omitted and the catalog is large.

  • Optionalcontext?: ContextObject

  • Optionalext?: ExtensionObject

• {
      request_type: "batch";
      requests: {
          format_id?: FormatID;
          creative_manifest: CreativeManifest;
          inputs?: {
              name: string;
              macros?: { [k: string]: string | undefined };
              context_description?: string;
          }[];
          template_id?: string;
          quality?: CreativeQuality;
          output_format?: PreviewOutputFormat;
          item_limit?: number;
      }[];
      quality?: CreativeQuality;
      output_format?: PreviewOutputFormat;
      context?: ContextObject;
      ext?: ExtensionObject;
  }

  • request_type: "batch"

    Discriminator indicating this is a batch preview request

  • requests: {
        format_id?: FormatID;
        creative_manifest: CreativeManifest;
        inputs?: {
            name: string;
            macros?: { [k: string]: string | undefined };
            context_description?: string;
        }[];
        template_id?: string;
        quality?: CreativeQuality;
        output_format?: PreviewOutputFormat;
        item_limit?: number;
    }[]

    Array of preview requests (1-50 items). Each follows the single request structure.

  • Optionalquality?: CreativeQuality

  • Optionaloutput_format?: PreviewOutputFormat

  • Optionalcontext?: ContextObject

  • Optionalext?: ExtensionObject

• {
      request_type: "variant";
      variant_id: string;
      creative_id?: string;
      output_format?: PreviewOutputFormat;
      context?: ContextObject;
      ext?: ExtensionObject;
  }

  • request_type: "variant"

    Discriminator indicating this is a variant preview request

  • variant_id: string

    Platform-assigned variant identifier from get_creative_delivery response

  • Optionalcreative_id?: string

    Creative identifier for context

  • Optionaloutput_format?: PreviewOutputFormat

  • Optionalcontext?: ContextObject

  • Optionalext?: ExtensionObject