Web Service: InventoryService
Port InventoryServiceInterfacePort Port typeSource code
- createAdUnitsDetailSource code
- getAdUnitSizesByStatementDetailSource code
- getAdUnitsByStatementDetailSource code
- performAdUnitActionDetailSource code
- updateAdUnitsDetailSource code
Operations
- createAdUnitsDescription:Creates new {@link AdUnit} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:createAdUnitsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type createAdUnitsCreates new {@link AdUnit} objects.
- adUnits - optional, unbounded; type AdUnitAn {@code AdUnit} represents a chunk of identified inventory for the publisher. It contains all the settings that need to be associated with inventory in order to serve ads to it. An {@code AdUnit} can also be the parent of other ad units in the inventory hierarchy.
- id - optional; type stringUniquely identifies the {@code AdUnit}. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
- parentId - optional; type stringThe ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.
- hasChildren - optional; type booleanThis field is set to {@code true} if the ad unit has any children. This attribute is read-only and is populated by Google.
- parentPath - optional, unbounded; type AdUnitParentThe path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.The summary of a parent {@link AdUnit}.
- id - optional; type stringThe ID of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- name - optional; type stringThe name of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
- id - optional; type string
- name - optional; type stringThe name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
- description - optional; type stringA description of the ad unit. This value is optional and its maximum length is 65,535 characters.
- targetWindow - optional; type AdUnit.TargetWindow - type string with restriction - enum { 'TOP', 'BLANK' }The value to use for the HTML link's {@code target} attribute. This value is optional and will be interpreted as {@link TargetWindow#TOP} if left blank.
- status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }The status of this ad unit. It defaults to {@link InventoryStatus#ACTIVE}. This value cannot be updated directly using {@link InventoryService#updateAdUnit}. It can only be modified by performing actions via {@link InventoryService#performAdUnitAction}.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its {@code adUnitCode} cannot be changed.
- adUnitSizes - optional, unbounded; type AdUnitSizeThe permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the {@code sizes} attribute.An {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSize... is recursiveThe companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
- size - optional; type Size
- isInterstitial - optional; type booleanWhether this is an interstitial ad unit.
- isNative - optional; type booleanWhether this is a native ad unit.
- isFluid - optional; type booleanWhether this is a fluid ad unit.
- explicitlyTargeted - optional; type booleanIf this field is set to {@code true}, then the {@code AdUnit} will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.
- adSenseSettings - optional; type AdSenseSettingsContains the AdSense configuration for an {@link AdUnit}.
- adSenseEnabled - optional; type booleanSpecifies whether or not the {@link AdUnit} is enabled for serving ads from the AdSense content network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adSenseEnabled}, the attribute is defaulted to {@code true}.
- borderColor - optional; type stringSpecifies the Hexadecimal border color, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderColor}, the attribute is defaulted to {@code FFFFFF}.
- titleColor - optional; type stringSpecifies the Hexadecimal title color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code titleColor}, the attribute is defaulted to {@code 0000FF}.
- backgroundColor - optional; type stringSpecifies the Hexadecimal background color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code backgroundColor}, the attribute is defaulted to {@code FFFFFF}.
- textColor - optional; type stringSpecifies the Hexadecimal color of the text of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code textColor}, the attribute is defaulted to {@code 000000}.
- urlColor - optional; type stringSpecifies the Hexadecimal color of the URL of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code urlColor}, the attribute is defaulted to {@code 008000} .
- adType - optional; type AdSenseSettings.AdType - type string with restriction - enum { 'TEXT', 'IMAGE', 'TEXT_AND_IMAGE' }Specifies what kind of ad can be served by this {@link AdUnit} from the AdSense Content Network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adType}, the attribute is defaulted to {@link AdType#TEXT_AND_IMAGE}.
- borderStyle - optional; type AdSenseSettings.BorderStyle - type string with restriction - enum { 'DEFAULT', 'NOT_ROUNDED', 'SLIGHTLY_ROUNDED', 'VERY_ROUNDED' }Specifies the border-style of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderStyle}, the attribute is defaulted to {@link BorderStyle#DEFAULT}.
- fontFamily - optional; type AdSenseSettings.FontFamily - type string with restriction - enum { 'DEFAULT', 'ARIAL', 'TAHOMA', 'GEORGIA', 'TIMES', 'VERDANA' }Specifies the font family of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontFamily}, the attribute is defaulted to {@link FontFamily#DEFAULT}.
- fontSize - optional; type AdSenseSettings.FontSize - type string with restriction - enum { 'DEFAULT', 'SMALL', 'MEDIUM', 'LARGE' }Specifies the font size of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontSize}, the attribute is defaulted to {@link FontSize#DEFAULT}.
AdSense specific settings. To overwrite this, set the {@link #adSenseSettingsSource} to {@link PropertySourceType#DIRECTLY_SPECIFIED} when setting the value of this field. - adSenseEnabled - optional; type boolean
- adSenseSettingsSource - optional; type ValueSourceType - type string with restriction - enum { 'PARENT', 'DIRECTLY_SPECIFIED', 'UNKNOWN' }Specifies the source of {@link #adSenseSettings} value. To revert an overridden value to its default, set this field to {@link PropertySourceType#PARENT}.
- appliedLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapThe set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- effectiveLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapContains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- appliedLabels - optional, unbounded; type AppliedLabelThe set of labels applied directly to this ad unit.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelContains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on directly.
- lastModifiedDateTime - optional; type DateTimeThe date and time this ad unit was last modified.Represents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
- date - optional; type Date
- smartSizeMode - optional; type SmartSizeMode - type string with restriction - enum { 'UNKNOWN', 'NONE', 'SMART_BANNER', 'DYNAMIC_SIZE' }The smart size mode for this ad unit. This attribute is optional and defaults to {@link SmartSizeMode#NONE} for fixed sizes.
- refreshRate - optional; type intThe interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.
- externalSetTopBoxChannelId - optional; type stringSpecifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if {@link #isSetTopBoxEnabled} is {@code true}. This attribute is read-only.
- isSetTopBoxEnabled - optional; type booleanFlag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
- applicationId - optional; type longThe {@link MobileApplication#applicationId} for the CTV application that this ad unit is within. This attribute is optional.
- id - optional; type string
Output:createAdUnitsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type createAdUnitsResponse- rval - optional, unbounded; type AdUnitAn {@code AdUnit} represents a chunk of identified inventory for the publisher. It contains all the settings that need to be associated with inventory in order to serve ads to it. An {@code AdUnit} can also be the parent of other ad units in the inventory hierarchy.
- id - optional; type stringUniquely identifies the {@code AdUnit}. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
- parentId - optional; type stringThe ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.
- hasChildren - optional; type booleanThis field is set to {@code true} if the ad unit has any children. This attribute is read-only and is populated by Google.
- parentPath - optional, unbounded; type AdUnitParentThe path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.The summary of a parent {@link AdUnit}.
- id - optional; type stringThe ID of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- name - optional; type stringThe name of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
- id - optional; type string
- name - optional; type stringThe name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
- description - optional; type stringA description of the ad unit. This value is optional and its maximum length is 65,535 characters.
- targetWindow - optional; type AdUnit.TargetWindow - type string with restriction - enum { 'TOP', 'BLANK' }The value to use for the HTML link's {@code target} attribute. This value is optional and will be interpreted as {@link TargetWindow#TOP} if left blank.
- status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }The status of this ad unit. It defaults to {@link InventoryStatus#ACTIVE}. This value cannot be updated directly using {@link InventoryService#updateAdUnit}. It can only be modified by performing actions via {@link InventoryService#performAdUnitAction}.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its {@code adUnitCode} cannot be changed.
- adUnitSizes - optional, unbounded; type AdUnitSizeThe permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the {@code sizes} attribute.An {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSize... is recursiveThe companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
- size - optional; type Size
- isInterstitial - optional; type booleanWhether this is an interstitial ad unit.
- isNative - optional; type booleanWhether this is a native ad unit.
- isFluid - optional; type booleanWhether this is a fluid ad unit.
- explicitlyTargeted - optional; type booleanIf this field is set to {@code true}, then the {@code AdUnit} will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.
- adSenseSettings - optional; type AdSenseSettingsContains the AdSense configuration for an {@link AdUnit}.
- adSenseEnabled - optional; type booleanSpecifies whether or not the {@link AdUnit} is enabled for serving ads from the AdSense content network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adSenseEnabled}, the attribute is defaulted to {@code true}.
- borderColor - optional; type stringSpecifies the Hexadecimal border color, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderColor}, the attribute is defaulted to {@code FFFFFF}.
- titleColor - optional; type stringSpecifies the Hexadecimal title color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code titleColor}, the attribute is defaulted to {@code 0000FF}.
- backgroundColor - optional; type stringSpecifies the Hexadecimal background color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code backgroundColor}, the attribute is defaulted to {@code FFFFFF}.
- textColor - optional; type stringSpecifies the Hexadecimal color of the text of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code textColor}, the attribute is defaulted to {@code 000000}.
- urlColor - optional; type stringSpecifies the Hexadecimal color of the URL of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code urlColor}, the attribute is defaulted to {@code 008000} .
- adType - optional; type AdSenseSettings.AdType - type string with restriction - enum { 'TEXT', 'IMAGE', 'TEXT_AND_IMAGE' }Specifies what kind of ad can be served by this {@link AdUnit} from the AdSense Content Network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adType}, the attribute is defaulted to {@link AdType#TEXT_AND_IMAGE}.
- borderStyle - optional; type AdSenseSettings.BorderStyle - type string with restriction - enum { 'DEFAULT', 'NOT_ROUNDED', 'SLIGHTLY_ROUNDED', 'VERY_ROUNDED' }Specifies the border-style of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderStyle}, the attribute is defaulted to {@link BorderStyle#DEFAULT}.
- fontFamily - optional; type AdSenseSettings.FontFamily - type string with restriction - enum { 'DEFAULT', 'ARIAL', 'TAHOMA', 'GEORGIA', 'TIMES', 'VERDANA' }Specifies the font family of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontFamily}, the attribute is defaulted to {@link FontFamily#DEFAULT}.
- fontSize - optional; type AdSenseSettings.FontSize - type string with restriction - enum { 'DEFAULT', 'SMALL', 'MEDIUM', 'LARGE' }Specifies the font size of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontSize}, the attribute is defaulted to {@link FontSize#DEFAULT}.
AdSense specific settings. To overwrite this, set the {@link #adSenseSettingsSource} to {@link PropertySourceType#DIRECTLY_SPECIFIED} when setting the value of this field. - adSenseEnabled - optional; type boolean
- adSenseSettingsSource - optional; type ValueSourceType - type string with restriction - enum { 'PARENT', 'DIRECTLY_SPECIFIED', 'UNKNOWN' }Specifies the source of {@link #adSenseSettings} value. To revert an overridden value to its default, set this field to {@link PropertySourceType#PARENT}.
- appliedLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapThe set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- effectiveLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapContains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- appliedLabels - optional, unbounded; type AppliedLabelThe set of labels applied directly to this ad unit.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelContains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on directly.
- lastModifiedDateTime - optional; type DateTimeThe date and time this ad unit was last modified.Represents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
- date - optional; type Date
- smartSizeMode - optional; type SmartSizeMode - type string with restriction - enum { 'UNKNOWN', 'NONE', 'SMART_BANNER', 'DYNAMIC_SIZE' }The smart size mode for this ad unit. This attribute is optional and defaults to {@link SmartSizeMode#NONE} for fixed sizes.
- refreshRate - optional; type intThe interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.
- externalSetTopBoxChannelId - optional; type stringSpecifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if {@link #isSetTopBoxEnabled} is {@code true}. This attribute is read-only.
- isSetTopBoxEnabled - optional; type booleanFlag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
- applicationId - optional; type longThe {@link MobileApplication#applicationId} for the CTV application that this ad unit is within. This attribute is optional.
- id - optional; type string
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - adUnits - optional, unbounded; type AdUnit
- getAdUnitSizesByStatementDescription:Returns a set of all relevant {@link AdUnitSize} objects.
The given {@link Statement} is currently ignored but may be honored in future versions.
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getAdUnitSizesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getAdUnitSizesByStatementReturns a set of all relevant {@link AdUnitSize} objects.The given {@link Statement} is currently ignored but may be honored in future versions.
- filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:getAdUnitSizesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getAdUnitSizesByStatementResponse- rval - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSize... is recursiveThe companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
- size - optional; type Size
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - filterStatement - optional; type Statement
- getAdUnitsByStatementDescription:Gets a {@link AdUnitPage} of {@link AdUnit} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
PQL Property Object Property {@code adUnitCode} {@link AdUnit#adUnitCode} {@code id} {@link AdUnit#id} {@code name} {@link AdUnit#name} {@code parentId} {@link AdUnit#parentId} {@code status} {@link AdUnit#status} {@code lastModifiedDateTime} {@link AdUnit#lastModifiedDateTime} Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getAdUnitsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getAdUnitsByStatementGets a {@link AdUnitPage} of {@link AdUnit} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:PQL Property Object Property {@code adUnitCode} {@link AdUnit#adUnitCode} {@code id} {@link AdUnit#id} {@code name} {@link AdUnit#name} {@code parentId} {@link AdUnit#parentId} {@code status} {@link AdUnit#status} {@code lastModifiedDateTime} {@link AdUnit#lastModifiedDateTime} - filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:getAdUnitsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getAdUnitsByStatementResponse- rval - optional; type AdUnitPageCaptures a page of {@link AdUnit} objects.
- totalResultSetSize - optional; type intThe size of the total result set to which this page belongs.
- startIndex - optional; type intThe absolute index in the total result set on which this page begins.
- results - optional, unbounded; type AdUnitAn {@code AdUnit} represents a chunk of identified inventory for the publisher. It contains all the settings that need to be associated with inventory in order to serve ads to it. An {@code AdUnit} can also be the parent of other ad units in the inventory hierarchy.
- id - optional; type stringUniquely identifies the {@code AdUnit}. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
- parentId - optional; type stringThe ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.
- hasChildren - optional; type booleanThis field is set to {@code true} if the ad unit has any children. This attribute is read-only and is populated by Google.
- parentPath - optional, unbounded; type AdUnitParentThe path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.The summary of a parent {@link AdUnit}.
- id - optional; type stringThe ID of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- name - optional; type stringThe name of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
- id - optional; type string
- name - optional; type stringThe name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
- description - optional; type stringA description of the ad unit. This value is optional and its maximum length is 65,535 characters.
- targetWindow - optional; type AdUnit.TargetWindow - type string with restriction - enum { 'TOP', 'BLANK' }The value to use for the HTML link's {@code target} attribute. This value is optional and will be interpreted as {@link TargetWindow#TOP} if left blank.
- status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }The status of this ad unit. It defaults to {@link InventoryStatus#ACTIVE}. This value cannot be updated directly using {@link InventoryService#updateAdUnit}. It can only be modified by performing actions via {@link InventoryService#performAdUnitAction}.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its {@code adUnitCode} cannot be changed.
- adUnitSizes - optional, unbounded; type AdUnitSizeThe permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the {@code sizes} attribute.An {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSize... is recursiveThe companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
- size - optional; type Size
- isInterstitial - optional; type booleanWhether this is an interstitial ad unit.
- isNative - optional; type booleanWhether this is a native ad unit.
- isFluid - optional; type booleanWhether this is a fluid ad unit.
- explicitlyTargeted - optional; type booleanIf this field is set to {@code true}, then the {@code AdUnit} will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.
- adSenseSettings - optional; type AdSenseSettingsContains the AdSense configuration for an {@link AdUnit}.
- adSenseEnabled - optional; type booleanSpecifies whether or not the {@link AdUnit} is enabled for serving ads from the AdSense content network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adSenseEnabled}, the attribute is defaulted to {@code true}.
- borderColor - optional; type stringSpecifies the Hexadecimal border color, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderColor}, the attribute is defaulted to {@code FFFFFF}.
- titleColor - optional; type stringSpecifies the Hexadecimal title color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code titleColor}, the attribute is defaulted to {@code 0000FF}.
- backgroundColor - optional; type stringSpecifies the Hexadecimal background color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code backgroundColor}, the attribute is defaulted to {@code FFFFFF}.
- textColor - optional; type stringSpecifies the Hexadecimal color of the text of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code textColor}, the attribute is defaulted to {@code 000000}.
- urlColor - optional; type stringSpecifies the Hexadecimal color of the URL of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code urlColor}, the attribute is defaulted to {@code 008000} .
- adType - optional; type AdSenseSettings.AdType - type string with restriction - enum { 'TEXT', 'IMAGE', 'TEXT_AND_IMAGE' }Specifies what kind of ad can be served by this {@link AdUnit} from the AdSense Content Network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adType}, the attribute is defaulted to {@link AdType#TEXT_AND_IMAGE}.
- borderStyle - optional; type AdSenseSettings.BorderStyle - type string with restriction - enum { 'DEFAULT', 'NOT_ROUNDED', 'SLIGHTLY_ROUNDED', 'VERY_ROUNDED' }Specifies the border-style of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderStyle}, the attribute is defaulted to {@link BorderStyle#DEFAULT}.
- fontFamily - optional; type AdSenseSettings.FontFamily - type string with restriction - enum { 'DEFAULT', 'ARIAL', 'TAHOMA', 'GEORGIA', 'TIMES', 'VERDANA' }Specifies the font family of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontFamily}, the attribute is defaulted to {@link FontFamily#DEFAULT}.
- fontSize - optional; type AdSenseSettings.FontSize - type string with restriction - enum { 'DEFAULT', 'SMALL', 'MEDIUM', 'LARGE' }Specifies the font size of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontSize}, the attribute is defaulted to {@link FontSize#DEFAULT}.
AdSense specific settings. To overwrite this, set the {@link #adSenseSettingsSource} to {@link PropertySourceType#DIRECTLY_SPECIFIED} when setting the value of this field. - adSenseEnabled - optional; type boolean
- adSenseSettingsSource - optional; type ValueSourceType - type string with restriction - enum { 'PARENT', 'DIRECTLY_SPECIFIED', 'UNKNOWN' }Specifies the source of {@link #adSenseSettings} value. To revert an overridden value to its default, set this field to {@link PropertySourceType#PARENT}.
- appliedLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapThe set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- effectiveLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapContains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- appliedLabels - optional, unbounded; type AppliedLabelThe set of labels applied directly to this ad unit.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelContains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on directly.
- lastModifiedDateTime - optional; type DateTimeThe date and time this ad unit was last modified.Represents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
- date - optional; type Date
- smartSizeMode - optional; type SmartSizeMode - type string with restriction - enum { 'UNKNOWN', 'NONE', 'SMART_BANNER', 'DYNAMIC_SIZE' }The smart size mode for this ad unit. This attribute is optional and defaults to {@link SmartSizeMode#NONE} for fixed sizes.
- refreshRate - optional; type intThe interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.
- externalSetTopBoxChannelId - optional; type stringSpecifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if {@link #isSetTopBoxEnabled} is {@code true}. This attribute is read-only.
- isSetTopBoxEnabled - optional; type booleanFlag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
- applicationId - optional; type longThe {@link MobileApplication#applicationId} for the CTV application that this ad unit is within. This attribute is optional.
The collection of ad units contained within this page. - id - optional; type string
- totalResultSetSize - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - filterStatement - optional; type Statement
- performAdUnitActionDescription:Performs actions on {@link AdUnit} objects that match the given {@link Statement#query}.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:performAdUnitActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type performAdUnitActionPerforms actions on {@link AdUnit} objects that match the given {@link Statement#query}.
- adUnitAction - optional; type AdUnitActionRepresents the actions that can be performed on {@link AdUnit} objects.
- filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:performAdUnitActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type performAdUnitActionResponse- rval - optional; type UpdateResultRepresents the result of performing an action on objects.
- numChanges - optional; type intThe number of objects that were changed as a result of performing the action.
- numChanges - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - adUnitAction - optional; type AdUnitAction
- updateAdUnitsDescription:Updates the specified {@link AdUnit} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:updateAdUnitsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type updateAdUnitsUpdates the specified {@link AdUnit} objects.
- adUnits - optional, unbounded; type AdUnitAn {@code AdUnit} represents a chunk of identified inventory for the publisher. It contains all the settings that need to be associated with inventory in order to serve ads to it. An {@code AdUnit} can also be the parent of other ad units in the inventory hierarchy.
- id - optional; type stringUniquely identifies the {@code AdUnit}. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
- parentId - optional; type stringThe ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.
- hasChildren - optional; type booleanThis field is set to {@code true} if the ad unit has any children. This attribute is read-only and is populated by Google.
- parentPath - optional, unbounded; type AdUnitParentThe path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.The summary of a parent {@link AdUnit}.
- id - optional; type stringThe ID of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- name - optional; type stringThe name of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
- id - optional; type string
- name - optional; type stringThe name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
- description - optional; type stringA description of the ad unit. This value is optional and its maximum length is 65,535 characters.
- targetWindow - optional; type AdUnit.TargetWindow - type string with restriction - enum { 'TOP', 'BLANK' }The value to use for the HTML link's {@code target} attribute. This value is optional and will be interpreted as {@link TargetWindow#TOP} if left blank.
- status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }The status of this ad unit. It defaults to {@link InventoryStatus#ACTIVE}. This value cannot be updated directly using {@link InventoryService#updateAdUnit}. It can only be modified by performing actions via {@link InventoryService#performAdUnitAction}.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its {@code adUnitCode} cannot be changed.
- adUnitSizes - optional, unbounded; type AdUnitSizeThe permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the {@code sizes} attribute.An {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSize... is recursiveThe companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
- size - optional; type Size
- isInterstitial - optional; type booleanWhether this is an interstitial ad unit.
- isNative - optional; type booleanWhether this is a native ad unit.
- isFluid - optional; type booleanWhether this is a fluid ad unit.
- explicitlyTargeted - optional; type booleanIf this field is set to {@code true}, then the {@code AdUnit} will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.
- adSenseSettings - optional; type AdSenseSettingsContains the AdSense configuration for an {@link AdUnit}.
- adSenseEnabled - optional; type booleanSpecifies whether or not the {@link AdUnit} is enabled for serving ads from the AdSense content network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adSenseEnabled}, the attribute is defaulted to {@code true}.
- borderColor - optional; type stringSpecifies the Hexadecimal border color, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderColor}, the attribute is defaulted to {@code FFFFFF}.
- titleColor - optional; type stringSpecifies the Hexadecimal title color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code titleColor}, the attribute is defaulted to {@code 0000FF}.
- backgroundColor - optional; type stringSpecifies the Hexadecimal background color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code backgroundColor}, the attribute is defaulted to {@code FFFFFF}.
- textColor - optional; type stringSpecifies the Hexadecimal color of the text of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code textColor}, the attribute is defaulted to {@code 000000}.
- urlColor - optional; type stringSpecifies the Hexadecimal color of the URL of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code urlColor}, the attribute is defaulted to {@code 008000} .
- adType - optional; type AdSenseSettings.AdType - type string with restriction - enum { 'TEXT', 'IMAGE', 'TEXT_AND_IMAGE' }Specifies what kind of ad can be served by this {@link AdUnit} from the AdSense Content Network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adType}, the attribute is defaulted to {@link AdType#TEXT_AND_IMAGE}.
- borderStyle - optional; type AdSenseSettings.BorderStyle - type string with restriction - enum { 'DEFAULT', 'NOT_ROUNDED', 'SLIGHTLY_ROUNDED', 'VERY_ROUNDED' }Specifies the border-style of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderStyle}, the attribute is defaulted to {@link BorderStyle#DEFAULT}.
- fontFamily - optional; type AdSenseSettings.FontFamily - type string with restriction - enum { 'DEFAULT', 'ARIAL', 'TAHOMA', 'GEORGIA', 'TIMES', 'VERDANA' }Specifies the font family of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontFamily}, the attribute is defaulted to {@link FontFamily#DEFAULT}.
- fontSize - optional; type AdSenseSettings.FontSize - type string with restriction - enum { 'DEFAULT', 'SMALL', 'MEDIUM', 'LARGE' }Specifies the font size of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontSize}, the attribute is defaulted to {@link FontSize#DEFAULT}.
AdSense specific settings. To overwrite this, set the {@link #adSenseSettingsSource} to {@link PropertySourceType#DIRECTLY_SPECIFIED} when setting the value of this field. - adSenseEnabled - optional; type boolean
- adSenseSettingsSource - optional; type ValueSourceType - type string with restriction - enum { 'PARENT', 'DIRECTLY_SPECIFIED', 'UNKNOWN' }Specifies the source of {@link #adSenseSettings} value. To revert an overridden value to its default, set this field to {@link PropertySourceType#PARENT}.
- appliedLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapThe set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- effectiveLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapContains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- appliedLabels - optional, unbounded; type AppliedLabelThe set of labels applied directly to this ad unit.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelContains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on directly.
- lastModifiedDateTime - optional; type DateTimeThe date and time this ad unit was last modified.Represents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
- date - optional; type Date
- smartSizeMode - optional; type SmartSizeMode - type string with restriction - enum { 'UNKNOWN', 'NONE', 'SMART_BANNER', 'DYNAMIC_SIZE' }The smart size mode for this ad unit. This attribute is optional and defaults to {@link SmartSizeMode#NONE} for fixed sizes.
- refreshRate - optional; type intThe interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.
- externalSetTopBoxChannelId - optional; type stringSpecifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if {@link #isSetTopBoxEnabled} is {@code true}. This attribute is read-only.
- isSetTopBoxEnabled - optional; type booleanFlag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
- applicationId - optional; type longThe {@link MobileApplication#applicationId} for the CTV application that this ad unit is within. This attribute is optional.
- id - optional; type string
Output:updateAdUnitsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type updateAdUnitsResponse- rval - optional, unbounded; type AdUnitAn {@code AdUnit} represents a chunk of identified inventory for the publisher. It contains all the settings that need to be associated with inventory in order to serve ads to it. An {@code AdUnit} can also be the parent of other ad units in the inventory hierarchy.
- id - optional; type stringUniquely identifies the {@code AdUnit}. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
- parentId - optional; type stringThe ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.
- hasChildren - optional; type booleanThis field is set to {@code true} if the ad unit has any children. This attribute is read-only and is populated by Google.
- parentPath - optional, unbounded; type AdUnitParentThe path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.The summary of a parent {@link AdUnit}.
- id - optional; type stringThe ID of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- name - optional; type stringThe name of the parent {@code AdUnit}. This value is readonly and is populated by Google.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
- id - optional; type string
- name - optional; type stringThe name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
- description - optional; type stringA description of the ad unit. This value is optional and its maximum length is 65,535 characters.
- targetWindow - optional; type AdUnit.TargetWindow - type string with restriction - enum { 'TOP', 'BLANK' }The value to use for the HTML link's {@code target} attribute. This value is optional and will be interpreted as {@link TargetWindow#TOP} if left blank.
- status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }The status of this ad unit. It defaults to {@link InventoryStatus#ACTIVE}. This value cannot be updated directly using {@link InventoryService#updateAdUnit}. It can only be modified by performing actions via {@link InventoryService#performAdUnitAction}.
- adUnitCode - optional; type stringA string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its {@code adUnitCode} cannot be changed.
- adUnitSizes - optional, unbounded; type AdUnitSizeThe permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the {@code sizes} attribute.An {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSizeAn {@code 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).
- size - optional; type SizeThe permissible creative size that can be served inside this ad unit.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
- companions - optional, unbounded; type AdUnitSize... is recursiveThe companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error. - size - optional; type Size
- fullDisplayString - optional; type stringThe full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
- isAudio - optional; type booleanWhether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
- size - optional; type Size
- isInterstitial - optional; type booleanWhether this is an interstitial ad unit.
- isNative - optional; type booleanWhether this is a native ad unit.
- isFluid - optional; type booleanWhether this is a fluid ad unit.
- explicitlyTargeted - optional; type booleanIf this field is set to {@code true}, then the {@code AdUnit} will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.
- adSenseSettings - optional; type AdSenseSettingsContains the AdSense configuration for an {@link AdUnit}.
- adSenseEnabled - optional; type booleanSpecifies whether or not the {@link AdUnit} is enabled for serving ads from the AdSense content network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adSenseEnabled}, the attribute is defaulted to {@code true}.
- borderColor - optional; type stringSpecifies the Hexadecimal border color, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderColor}, the attribute is defaulted to {@code FFFFFF}.
- titleColor - optional; type stringSpecifies the Hexadecimal title color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code titleColor}, the attribute is defaulted to {@code 0000FF}.
- backgroundColor - optional; type stringSpecifies the Hexadecimal background color of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code backgroundColor}, the attribute is defaulted to {@code FFFFFF}.
- textColor - optional; type stringSpecifies the Hexadecimal color of the text of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code textColor}, the attribute is defaulted to {@code 000000}.
- urlColor - optional; type stringSpecifies the Hexadecimal color of the URL of an ad, from {@code 000000} to {@code FFFFFF}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code urlColor}, the attribute is defaulted to {@code 008000} .
- adType - optional; type AdSenseSettings.AdType - type string with restriction - enum { 'TEXT', 'IMAGE', 'TEXT_AND_IMAGE' }Specifies what kind of ad can be served by this {@link AdUnit} from the AdSense Content Network. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code adType}, the attribute is defaulted to {@link AdType#TEXT_AND_IMAGE}.
- borderStyle - optional; type AdSenseSettings.BorderStyle - type string with restriction - enum { 'DEFAULT', 'NOT_ROUNDED', 'SLIGHTLY_ROUNDED', 'VERY_ROUNDED' }Specifies the border-style of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code borderStyle}, the attribute is defaulted to {@link BorderStyle#DEFAULT}.
- fontFamily - optional; type AdSenseSettings.FontFamily - type string with restriction - enum { 'DEFAULT', 'ARIAL', 'TAHOMA', 'GEORGIA', 'TIMES', 'VERDANA' }Specifies the font family of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontFamily}, the attribute is defaulted to {@link FontFamily#DEFAULT}.
- fontSize - optional; type AdSenseSettings.FontSize - type string with restriction - enum { 'DEFAULT', 'SMALL', 'MEDIUM', 'LARGE' }Specifies the font size of the {@link AdUnit}. This attribute is optional and defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set {@code fontSize}, the attribute is defaulted to {@link FontSize#DEFAULT}.
AdSense specific settings. To overwrite this, set the {@link #adSenseSettingsSource} to {@link PropertySourceType#DIRECTLY_SPECIFIED} when setting the value of this field. - adSenseEnabled - optional; type boolean
- adSenseSettingsSource - optional; type ValueSourceType - type string with restriction - enum { 'PARENT', 'DIRECTLY_SPECIFIED', 'UNKNOWN' }Specifies the source of {@link #adSenseSettings} value. To revert an overridden value to its default, set this field to {@link PropertySourceType#PARENT}.
- appliedLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapThe set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- effectiveLabelFrequencyCaps - optional, unbounded; type LabelFrequencyCapContains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.A {@code LabelFrequencyCap} assigns a frequency cap to a label. The frequency cap will limit the cumulative number of impressions of any ad units with this label that may be shown to a particular user over a time unit.
- frequencyCap - optional; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The frequency cap to be applied with this label. - maxImpressions - optional; type int
- labelId - optional; type longID of the label being capped on the {@link AdUnit}.
- frequencyCap - optional; type FrequencyCap
- appliedLabels - optional, unbounded; type AppliedLabelThe set of labels applied directly to this ad unit.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelContains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
- labelId - optional; type long
- effectiveTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that this ad unit is on directly.
- lastModifiedDateTime - optional; type DateTimeThe date and time this ad unit was last modified.Represents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
- date - optional; type Date
- smartSizeMode - optional; type SmartSizeMode - type string with restriction - enum { 'UNKNOWN', 'NONE', 'SMART_BANNER', 'DYNAMIC_SIZE' }The smart size mode for this ad unit. This attribute is optional and defaults to {@link SmartSizeMode#NONE} for fixed sizes.
- refreshRate - optional; type intThe interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.
- externalSetTopBoxChannelId - optional; type stringSpecifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if {@link #isSetTopBoxEnabled} is {@code true}. This attribute is read-only.
- isSetTopBoxEnabled - optional; type booleanFlag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
- applicationId - optional; type longThe {@link MobileApplication#applicationId} for the CTV application that this ad unit is within. This attribute is optional.
- id - optional; type string
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - adUnits - optional, unbounded; type AdUnit
Port type InventoryServiceInterfaceSource code
WSDL source code
About wsdl-viewer.xsl
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.
The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT