AI-generated Key Takeaways
-
An
AdUnitSizerepresents the size, environment, and companions of an ad within an ad unit, typically a simple size with width and height. -
Key fields for
AdUnitSizeincludesize,environmentType,companions,fullDisplayString, andisAudio. -
The
environmentTypespecifies whether the ad unit size is for a browser or a video player, with browser being the default. -
Companions are valid for video player environments but not for browser environments.
-
Setting
isAudioto true forces the size to "1x1" and the environment type to video 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/v202505
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.
