type AdUnitSize (v202502)

  • An AdUnitSize represents the size of an ad, its environment, and companions.

  • It primarily uses a simple size with width and height, but can also represent an aspect ratio.

  • Fields like size, environmentType, companions, fullDisplayString, and isAudio provide details about the ad unit size.

  • Companions are specifically valid for video players and not for web browsers.

  • Audio inventory sizes have a fixed 1x1 size and are treated as video players.
Service
InventoryService SuggestedAdUnitService
Dependencies
AdUnitSize SuggestedAdUnit
▼
AdUnitSize

An AdUnitSize represents the size of an ad in an ad unit. This also represents the environment and companions of a particular ad in an ad unit. In most cases, it is a simple size with just a width and a height (sometimes representing an aspect ratio).

Namespace
https://www.google.com/apis/ads/publisher/v202502

Field

size

Size

The permissible creative size that can be served inside this ad unit.

environmentType

EnvironmentType

The environment type of the ad unit size. The default value is EnvironmentType.BROWSER.

Enumerations
BROWSER
A regular web browser.
VIDEO_PLAYER
Video players.

companions

AdUnitSize[]

The companions for this ad unit size. Companions are only valid if the environment is EnvironmentType.VIDEO_PLAYER. If the environment is EnvironmentType.BROWSER including companions results in an error.

fullDisplayString

xsd:string

The full (including companion sizes, if applicable) display string of the size, e.g. "300x250" or "300x250v (180x150)"

isAudio

xsd:boolean

Whether the inventory size is audio. If set to true, Size will be set to "1x1" and EnvironmentType will be set to EnvironmentType.VIDEO_PLAYER regardless of user input.