SqueezeConfiguredAds (AdPilot)

Swagger API Documentation

Summary

SqueezeConfiguredAds manages pre-configured advertisements for squeezeback events. These ads can be transcoded to match specific requirements (FPS, scale) and are selected based on airing date, event, stream, geographic location, and other targeting parameters.

Use Cases

  • Pre-load ads for scheduled squeezeback events
  • Configure ads with specific durations for precise ad break filling
  • Target ads by geographic location and language
  • Track ad transcoding status via Matrix job IDs
  • Support both L-bar and dual-box ad layouts (L-bar not yet implemented)
  • Configure ad break identifiers (abid) and ad item identifiers (aiid)

Key Configuration Areas

Ad Targeting:

  • Airing date scheduling for precise timing
  • Event and stream associations (event_id, caid)
  • Geographic and language targeting via geo_lang_loc

Ad Identification:

  • Ad break ID (abid) for grouping ads within breaks
  • Ad item ID (aiid) for tracking individual creatives
  • Slot ad unit (slau) for layout configuration

Technical Specifications:

  • Transcoding parameters (FPS, resolution)
  • Ad duration for break filling
  • L-bar vs. dual-box layout support (L-bar not yet implemented)

Operational Tracking:

  • Matrix job IDs for transcoding status
  • Curated vs. decisioned ad flags
  • Creation and update timestamps

API Documentation

See the Swagger API Documentation for complete API details including endpoints, request/response schemas, parameters, and examples.

Ad Break Identifier (abid)

The abid field identifies which ad break the ad belongs to:

  • Used to group ads that should play in the same break
  • Allows multiple ads to be sequenced within a single break
  • Should match the break identifier used in ad break orchestration calls

Ad Item Identifier (aiid)

The aiid field identifies individual ads within a break:

  • Unique identifier for the specific ad creative
  • Used for tracking and reporting
  • Can be combined with abid for precise ad placement

Geographic Targeting

The geo_lang_loc field allows granular geographic and language targeting. See the Swagger API Documentation for format details.

Transcoding Parameters

Frame Rate (ad_fps)

  • Specify target FPS for transcoding
  • If not set, uses original ad frame rate

Scale (ad_scale)

  • Specify target resolution
  • If not set, uses original ad resolution
  • Should match content resolution for best quality

Matrix Job ID

  • Populated when ad is submitted for transcoding
  • Used to track transcoding progress and status

Layout Types

Dual-Box Layout (is_lbar: false)

  • Content and ad displayed side-by-side
  • Both boxes visible simultaneously
  • Default layout type

L-Bar Layout (is_lbar: true) - Not Yet Implemented

  • Ad positioned in an L-shaped configuration
  • Content squeezed to make room for L-bar
  • Alternative layout for specific use cases
  • Note: This feature is planned but not currently available

Slot Audience Unit (slau)

The slau field identifies the audience unit/slot type:

  • Used in ad decisioning and reporting
  • Corresponds to Freewheel slot audience unit parameter