Page Summary
-
An
AdUnitSizerepresents the size of an ad in an ad unit, including its environment and companions, and typically consists of a width and height. -
The
AdUnitSizeobject includes fields for the size, environment type (like browser or video player), companions, a full display string, and an indicator for audio inventory. -
Companion sizes are only valid for video player environments; including them for browser environments will result in an error.
-
If
isAudiois set to true, the size will be "1x1" and the environment type will automatically be set toVIDEO_PLAYER.
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/v202411
Field
size
The permissible creative size that can be served inside this ad unit.
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.
