Inventory channel objects

NOTE: Composition terms are split into this InventoryChannelComposition object and the Inventory Composition object.

The InventoryChannelComposition object provides information for deals specific to the following inventory channels: Display, Video, Audio, CTV, NativeDisplay, NativeVideo, and DigitalOutOfHome. For examples, see Inventory channel composition.

There are a few exceptions to the classification of inventory:

Inventory channel composition objects

The inventory channel that contains the inventory sold in the deal. For a list of channels, see the following objects:

NOTE: For native display channels use the DisplayChannelComposition object and for native video channels use the VideoChannelComposition object.

AudioChannelComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The AudioChannelComposition object lists the valid selection fields.

Field Required? Data Type Selection Type Description
audio Optional Object N/A An object describing the dimensions, skippability, in or out of stream, and other fields of the ads shown to consumers.
adEnvironments Optional String enum Single Selection An object describing selection preferences toward in-app or web. For details, see Inventory selection enumeration values.
deviceTypes Optional String enum Single Selection An object that describes which device types to include or exclude. For details, see Inventory selection enumeration values.
channels Optional String Single Selection The list of channels that the selling party includes or excludes from the deal.
NOTE: This is the IAB definition of a channel as a subset of a network, such as a channel for children. It's not an inventory channel, such as TV, audio, or display.
IMPORTANT: Use the channel name, not the channel ID.
networks Optional String Single Selection The list of networks with inventory that the selling party includes or excludes from the deal.
IMPORTANT: Use the network name, not the network ID.
productionQualities Optional String enum Single Selection The production qualities that the selling party includes or excludes from the deal. For details, see Inventory selection enumeration values.

CtvChannelComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The CtvChannelComposition object lists the valid selection fields.

Field Required? Data Type Selection Type Description
ctv Optional Object N/A An object describing the dimensions, skippability, in or out of stream and other fields of the ads shown to consumers.
adEnvironments Optional String enum Single Selection An object describing selection preferences toward in-app or web. For details, see Inventory selection enumeration values.
deviceTypes Optional String enum Single Selection An object that describes which device types to include or exclude. For details, see Inventory selection enumeration values.
channels Optional String Single Selection The list of channels whose inventory the selling party includes or excludes from the deal.
NOTE: This is the IAB definition of a channel as a subset of a network, such as a channel for children. This isn't an inventory channel, such as TV, audio, or display.
networks Optional String Single Selection The list of networks with inventory that the selling party includes or excludes from the deal.

DoohChannelComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The DoohChannelComposition object lists the selection fields used for DOOH devices.

Field Required? Data Type Selection Type Description
mediaType Optional Object N/A The media types of the inventory. For details, see Media composition objects.
venueTypes Optional String Multi Selection An object describing the type of venue where the device showing the ad. For details, see Venue types.

DisplayChannelComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The DisplayChannelComposition object lists the valid selection fields for ad formating on displays.

Field Required? Data Type Selection Type Description
display Optional Object N/A An object describing the format of the display ad to present.
adEnvironments Optional String enum Single Selection An object describing selection preferences toward in-app or web. For details, see Inventory selection enumeration values.
deviceTypes Optional String enum Single Selection An object that describes which device types to include or exclude. For details, see Inventory selection enumeration values.
productionQualities Optional String enum Single Selection This object describes the quality of the content that's presented alongside the ads. For details, see Production quality.

VideoChannelComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The VideoChannelComposition object lists the valid selection fields for dimensions, skippability, in or out of stream, and other fields of the ads shown to consumers.

Field Required? Data Type Selection Type Description
video Optional Object N/A An object describing the dimensions, skippability, in or out of stream, and other fields of the ads shown to consumers.
adEnvironments Optional String enum Single Selection An object describing selection preferences toward in-app or web. For details, see Inventory selection enumeration values.
deviceTypes Optional Object String enum An object that describes which device types to include or exclude. For details, see Inventory selection enumeration values.
productionQualities Optional String enum Single Selection This object describes the quality of the content that's presented alongside the ads. For details, see Production quality.

Media composition objects

Depending on your channel, you have objects for different media types. The following media types are supported for selection.

AudioComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The AudioComposition object lists the selection fields used for audio.

Field Required? Data Type Selection Type Description
feed Optional String enum Single Selection The allowed or blocked feeds for this deal.
Values are derived from the AdCOM Feed Types. Audio feed types are listed in the Inventory selection enumeration values.
liveStream Optional Object Inclusion Selection Set to true when the ad is shown alongside live content. You can apply this conditionally for base versus expanded deal terms.
podSeq Optional String enum Single Selection The allowed or blocked pods for this deal, with pods defined by their sequence since the consumer streaming session started. For details, see Inventory selection enumeration values.
slotInPod Optional String enum Single Selection The order of allowed or blocked slots in a given pod. For details, see Inventory selection enumeration values.
startDelay Optional String enum Single Selection The allowed delay time in seconds for the ads. Possible Included and Excluded values include the following:
  • Pre-Roll
  • Mid-Roll
  • Post-Roll

CtvComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The CtvComposition object lists the selection fields used for CTV.

Field Required? Data Type Selection Type Description
startdelay Optional String enum Single Selection The allowed delay time in seconds for the ads. Possible Included and Excluded values include the following:
  • Pre-Roll
  • Mid-Roll
  • Post-Roll
liveStream Optional Object Inclusion Selection Set to true when the ad is shown alongside live content. You can apply this conditionally for base versus expanded deal terms.
podSeq Optional String enum Single Selection The pod positions in stream that the selling party includes or excludes from the deal. For details, see Inventory selection enumeration values.
slotInPod Optional String enum Single Selection The slot positions in the pod that the selling party includes or excludes from the deal. For details, see Inventory selection enumeration values.

DisplayComposition object

The DisplayComposition object lists the targeting fields used for displays.

Field Required? Data Type Selection Type Description
adformats Optional Object Inclusion Selection An object that specifies the display format of the ads to include. For details, see Ad formats.

VideoComposition object

TIP: This section uses multiple layers of nested objects not listed in the following table. To implement with these objects, start by familiarizing yourself with the example in Inventory channel terms and Inventory Selection object.

The VideoComposition object lists the selection fields used for non-CTV videos.

Field Required? Data Type Selection Type Description
videoDimensions Optional Object Inclusion Selection An object that specifies the dimensions of the ads to include. Specify the height and width field as pixels.
skippability Optional String enum Single Selection The skippability of the inventory that the selling party includes from the deal.
Possible Included values are the following:
  • Skippable
  • Non-Skippable
liveStream Optional Object Inclusion Selection Set to true when the ad is shown alongside live content. You can apply this conditionally for base versus expanded deal terms.
plcmt Optional String enum Single Selection The selling party includes or excludes with a certain placement in stream. Possible Included and Excluded values include the following:
  • Instream
  • Accompanying Content
  • Interstitial
  • Standalone
startDelay Optional String enum Single Selection The allowed delay time in seconds for the ads. Possible Included and Excluded values include the following:
  • Pre-Roll
  • Mid-Roll
  • Post-Roll

Inventory selection enumeration values

The following section lists all possible enumeration values for selection fields in inventory channels, ordered by alphabetical order.

NOTE: You don't need to include quotation marks when using these values.

Standardized selection objects

Some selection fields have special objects that follow IAB standards as a unique object. To get the values of these fields, you can query for a list of standarized values using the PDP API. For examples of queries and outputs, see Standardized inventory queries.

The following fields follow standardized values:

IMPORTANT: Standardized selection objects aren't defined as enumeration values, so you must add quotation marks when specifying the ID and string pair.