Type Alias LegacyPreviewCreativeRequest

Type Declaration

• Optionaladcp_version?: string

  Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

• Optionaladcp_major_version?: number

  Deprecated

  DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

• request_type: "single" | "batch" | "variant"

  Preview mode. 'single' previews one creative manifest. 'batch' previews multiple creatives in one call. 'variant' replays a post-flight variant by ID.

• Optionalcreative_manifest?: LegacyCreativeManifest

• Optionaltarget_capability_id?: string

  Canonical preview-operation selector. Identifies one get_adcp_capabilities creative.supported_formats[].capability_id entry whose operations contains preview. In single mode it selects the renderer for this request; in batch mode it is the default for items that omit their own target_capability_id. When omitted, the agent MAY resolve the renderer only if exactly one advertised preview capability satisfies the manifest's canonical declaration; zero matches or multiple matches MUST be rejected with FORMAT_NOT_SUPPORTED rather than choosing nondeterministically. Mutually exclusive with deprecated format_id.

  Pattern

  ^[a-zA-Z0-9_-]+$

• Optionalformat_id?: LegacyFormatReferenceStructuredObject

• 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. Used in single mode.

• Optionaltemplate_id?: string

  Specific template ID for custom format rendering. Used in single mode.

• Optionalquality?: CreativeQuality

• Optionaloutput_format?: PreviewOutputFormat

• Optionalitem_limit?: number

  Maximum number of catalog items to render per preview variant. Used in single mode. Creative agents SHOULD default to a reasonable sample when omitted and the catalog is large.

  Minimum

  1

• Optionalrequests?: {
      target_capability_id?: string;
      format_id?: LegacyFormatReferenceStructuredObject;
      creative_manifest?: LegacyCreativeManifest;
      creative_id?: string;
      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). Required when request_type is 'batch'. Each item follows the single request structure.

• Optionalvariant_id?: string

  Platform-assigned variant identifier from get_creative_delivery response. Required when request_type is 'variant'.

• Optionalcreative_id?: string

  Creative-library identifier. In single mode, previews the stored canonical creative without requiring the caller to reconstruct its manifest. Also available as context in variant mode.

• Optionalallow_async?: boolean

  Opt in to an asynchronous preview response. When true, the creative agent MAY return status 'submitted' with a task_id only when rendering has been handed to a queue or external renderer and will continue after the request connection is released. Active processing on an open connection uses working progress instead. The buyer polls get_task_status for completion. When false or absent, the agent MUST return a synchronous preview response or a terminal protocol error; it MUST NOT return the submitted shape. This field applies to preview_creative only; build_creative already defines its own async lifecycle.

• Optionalpush_notification_config?: PushNotificationConfig

• Optionalcontext?: ContextObject

• Optionalext?: ExtensionObject