type AdUnitSize (v202502)

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

  • It typically consists of a simple width and height, though it can also represent an aspect ratio.

  • An AdUnitSize can have companions, but only if the environment type is VIDEO_PLAYER.

  • The fullDisplayString field provides a string representation of the size, including companions if present.

  • The isAudio field indicates if the inventory size is audio, setting size to "1x1" and environment to VIDEO_PLAYER if true.
Service
InventoryService SuggestedAdUnitService
Dependencies
AdUnit AdUnitSize getAdUnitSizesByStatement()
▼
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.