Audio.battr

Creative attributes the seller blocks for this audio slot, from AdCOM List: Creative Attributes. With no list, every attribute is allowed.

Currentinteger arrayOptionalSince 2.4

Field facts

Path: imp.audio.battr
Object: Audio
Type: integer array
Requirement: Optional
Added: OpenRTB 2.4
Values: AdCOM list Creative Attributes
Spec section: 3.2.8

How it is used

Most values in the list describe visual behavior, so few apply to an audio creative. Attribute 13, user interactive, can describe audio ads that ask the listener to respond. Values 500 and above are vendor-specific and need prior agreement with buyers.

Allowed values

Value	Meaning
`1`	Audio Ad (Autoplay): The ad plays sound without any user action.
`2`	Audio Ad (User Initiated): The ad plays sound only after the user acts, for example by clicking or tapping.
`3`	Expandable (Automatic): The ad expands beyond its initial size on its own, without user interaction.
`4`	Expandable (User Initiated - Click): The ad expands when the user clicks or taps it.
`5`	Expandable (User Initiated - Rollover): The ad expands when the user moves the pointer over it.
`6`	In-Banner Video Ad (Autoplay): A display unit that contains video which starts playing by itself.
`7`	In-Banner Video Ad (User Initiated): A display unit that contains video which plays only after the user starts it.
`8`	Pop (e.g., Over, Under, or Upon Exit): The ad opens a new window or layer over or under the page, or when the user leaves.
`9`	Provocative or Suggestive Imagery: The ad contains provocative or suggestive imagery that a publisher may consider inappropriate.
`10`	Shaky, Flashing, Flickering, Extreme Animation, Smileys: The ad uses shaking, flashing, flickering or other extreme animation.
`11`	Surveys: The ad asks the user to answer a survey or questionnaire.
`12`	Text Only: The ad is text only, with no images or video.
`13`	User Interactive (e.g., Embedded Games): The ad is interactive, for example an embedded game or a configurator.
`14`	Windows Dialog or Alert Style: The ad imitates an operating system dialog or alert box, a pattern often used to mislead users.
`15`	Has Audio On/Off Button: The ad has its own control for turning sound on and off.
`16`	Ad Provides Skip Button: The creative renders its own skip button, as VPAID pre-roll units sometimes do, separate from any skip control in the player.
`17`	Adobe Flash: The ad uses Adobe Flash, which current browsers no longer run; blocklists still carry it.
`18`	Responsive, sizeless or fluid: The creative resizes itself to fit the space it is given instead of using fixed dimensions.
`19`	Contains advertiser QR code: The creative shows a QR code from the advertiser, useful on CTV and DOOH screens, where viewers cannot click.
`20`	Supports alpha channel transparency: The creative has transparent regions meant to be composited over content, which overlay formats often require.
`21`	Static visual: The creative has no visible motion, even when it is delivered as a video file.
`22`	Limited motion (cinemagraph): The creative is mostly still, with small looping movement in part of the frame.
`23`	Full-motion video: The creative has continuous, scene-level motion like ordinary video.
`500+`	Vendor-specific codes: Vendor-specific attributes defined by an exchange and agreed with its buyers.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "imp": [
    {
      "audio": {
        "battr": [
          13
        ]
      }
    }
  ]
}

Version history

Added in OpenRTB 2.4, and present in the latest snapshot. The table shows how each version's spec text types the field.

Versions	Type in the spec	Required	Deprecated
2.4	integer array	No	No
2.5	integer array	No	No
2.6-202210 to 2.6-202606	integer array	No	No

Related fields

Other Audio fields

For a walkthrough of the whole object, read Audio object guide.