AdField (Google Ads APIs Client Library for Java parent 4.9.0 API)

java.lang.Object
- java.lang.Enum<AdField>
- - com.google.api.ads.adwords.lib.selectorfields.v201809.cm.AdField

All Implemented Interfaces:

EntityField, Serializable, Comparable<AdField>
```
public enum AdField
extends Enum<AdField>
implements EntityField
```
A Enum to facilitate the selection of fields for Ad.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AccentColor` Accent color.
`AdType` Type of ad.
`AllowFlexibleColor` Advertiser?s consent to allow flexible color.
`BusinessName` The business name.
`CallToActionText` Call to action text.
`CreativeFinalAppUrls` A list of final app URLs that will be used on mobile if the user has the specific app installed.
`CreativeFinalMobileUrls` A list of possible final mobile URLs after all cross domain redirects.
`CreativeFinalUrls` A list of possible final URLs after all cross domain redirects.
`CreativeFinalUrlSuffix` URL template for appending params to Final URL.
`CreativeTrackingUrlTemplate` URL template for constructing a tracking URL.
`CreativeUrlCustomParameters` A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.
`Description` The descriptive text of the ad.
`Description1` The first description line.
`Description2` The second description line.
`DisplayUrl` Visible URL.
`DurationMillis` The duration of the associated audio, in milliseconds.
`ExpandedDynamicSearchCreativeDescription2` The second description line of the ad.
`ExpandedTextAdDescription2` The second description line of the ad.
`ExpandedTextAdHeadlinePart3` Third part of the headline.
`FormatSetting` Specifies which format the ad will be served in.
`HeadlinePart1` First part of the headline.
`HeadlinePart2` Second part of the headline.
`Id` ID of this ad.
`LongHeadline` Long format of the headline of the ad.
`MainColor` Main color.
`MultiAssetResponsiveDisplayAdAccentColor` Accent color, represented as a hexadecimal string (e.g.
`MultiAssetResponsiveDisplayAdAllowFlexibleColor` Allow flexible color.
`MultiAssetResponsiveDisplayAdBusinessName` The Advertiser/brand name.
`MultiAssetResponsiveDisplayAdCallToActionText` Call to action text.
`MultiAssetResponsiveDisplayAdDescriptions` The descriptive text of the ad.
`MultiAssetResponsiveDisplayAdDynamicSettingsPricePrefix` Prefix before price.
`MultiAssetResponsiveDisplayAdDynamicSettingsPromoText` Promotion text used for dynamic formats of multi-asset responsive display ads.
`MultiAssetResponsiveDisplayAdFormatSetting` Specifies which format the ad will be served in.
`MultiAssetResponsiveDisplayAdHeadlines` Short format of the headline of the ad.
`MultiAssetResponsiveDisplayAdLandscapeLogoImages` Landscape logo image which is used for serving dynamic MultiAssetResponsiveDisplayAd.
`MultiAssetResponsiveDisplayAdLogoImages` Logo image to be used in the ad.
`MultiAssetResponsiveDisplayAdLongHeadline` Long format of the headline of the ad.
`MultiAssetResponsiveDisplayAdMainColor` Main color, represented as a hexadecimal string (e.g.
`MultiAssetResponsiveDisplayAdMarketingImages` Marketing image to be used in the ad.
`MultiAssetResponsiveDisplayAdSquareMarketingImages` Square marketing image to be used in the ad.
`MultiAssetResponsiveDisplayAdYouTubeVideos` The YouTube videos of the ad.
`Name` Name of the ad.
`Path1` Text that appears in the ad with the displayed URL.
`Path2` In addition to `#path1`, more text that appears with the displayed URL.
`ReadyToPlayOnTheWeb` Indicates whether the audio is ready to play on the web.
`ResponsiveSearchAdDescriptions` Descriptions.
`ResponsiveSearchAdHeadlines` Headlines.
`ResponsiveSearchAdPath1` Text that appears in the ad with the displayed URL.
`ResponsiveSearchAdPath2` In addition to `#path1`, more text that appears with the displayed URL.
`ShortHeadline` Short format of the headline of the ad.
`StreamingUrl` The streaming URL of the audio.
`Type` Type of the creative.
`UniversalAppAdDescriptions` When the Ad serves, the descriptions will be selected from this list.
`UniversalAppAdHeadlines` When the Ad serves, the headlines will be selected from this list.
`UniversalAppAdHtml5MediaBundles` HTML5 MediaBundles to attach to the ad.
`UniversalAppAdImages` Marketing images to attach to the ad.
`UniversalAppAdMandatoryAdText` Ad text that must be displayed when the ad is served.
`UniversalAppAdYouTubeVideos` YouTube videos to attach to the ad
`Url` Destination URL.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isFilterable()` If the field is filterable.
`static AdField`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AdField[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.api.ads.adwords.lib.selectorfields.EntityField
name

- Enum Constant Detail
  - AccentColor
```
public static final AdField AccentColor
```
    Accent color. In hexadecimal, e.g. #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.
  - AdType
```
public static final AdField AdType
```
    Type of ad.
  - AllowFlexibleColor
```
public static final AdField AllowFlexibleColor
```
    Advertiser?s consent to allow flexible color. When true, we may serve the ad with different color when necessary. When false, we will serve the ad with advertiser color or neutral color. Must be true if mainColor and accentColor are not set. The default value is true.
  - BusinessName
```
public static final AdField BusinessName
```
    The business name. Maximum display width is 25. This field is required and should not be null when it is contained within Operators : ADD.
  - CallToActionText
```
public static final AdField CallToActionText
```
    Call to action text. Valid texts: https://support.google.com/adwords/answer/7005917
  - CreativeFinalAppUrls
```
public static final AdField CreativeFinalAppUrls
```
    A list of final app URLs that will be used on mobile if the user has the specific app installed.
    This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
  - CreativeFinalMobileUrls
```
public static final AdField CreativeFinalMobileUrls
```
    A list of possible final mobile URLs after all cross domain redirects.
    This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
  - CreativeFinalUrlSuffix
```
public static final AdField CreativeFinalUrlSuffix
```
    URL template for appending params to Final URL.
    On update, empty string ("") indicates to clear the field.
  - CreativeFinalUrls
```
public static final AdField CreativeFinalUrls
```
    A list of possible final URLs after all cross domain redirects.
    This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
  - CreativeTrackingUrlTemplate
```
public static final AdField CreativeTrackingUrlTemplate
```
    URL template for constructing a tracking URL.
    This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
  - CreativeUrlCustomParameters
```
public static final AdField CreativeUrlCustomParameters
```
    A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.
    This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
  - Description
```
public static final AdField Description
```
    The descriptive text of the ad.
  - Description1
```
public static final AdField Description1
```
    The first description line.
  - Description2
```
public static final AdField Description2
```
    The second description line.
  - DisplayUrl
```
public static final AdField DisplayUrl
```
    Visible URL.
  - DurationMillis
```
public static final AdField DurationMillis
```
    The duration of the associated audio, in milliseconds.
  - ExpandedDynamicSearchCreativeDescription2
```
public static final AdField ExpandedDynamicSearchCreativeDescription2
```
    The second description line of the ad.
  - ExpandedTextAdDescription2
```
public static final AdField ExpandedTextAdDescription2
```
    The second description line of the ad.
  - ExpandedTextAdHeadlinePart3
```
public static final AdField ExpandedTextAdHeadlinePart3
```
    Third part of the headline.
  - FormatSetting
```
public static final AdField FormatSetting
```
    Specifies which format the ad will be served in. The default value is ALL_FORMATS.
  - HeadlinePart1
```
public static final AdField HeadlinePart1
```
    First part of the headline.
  - HeadlinePart2
```
public static final AdField HeadlinePart2
```
    Second part of the headline.
  - Id
```
public static final AdField Id
```
    ID of this ad. This field is ignored when creating ads using AdGroupAdService.
  - LongHeadline
```
public static final AdField LongHeadline
```
    Long format of the headline of the ad. Maximum display width is 90.
  - MainColor
```
public static final AdField MainColor
```
    Main color. In hexadecimal, e.g. #ffffff for white. If one of mainColor and accentColor is set, the other is required as well.
  - MultiAssetResponsiveDisplayAdAccentColor
```
public static final AdField MultiAssetResponsiveDisplayAdAccentColor
```
    Accent color, represented as a hexadecimal string (e.g. #ffffff for white). If one of mainColor and accentColor is set, the other is required as well.
  - MultiAssetResponsiveDisplayAdAllowFlexibleColor
```
public static final AdField MultiAssetResponsiveDisplayAdAllowFlexibleColor
```
    Allow flexible color. If set to true, the ad will show on text and native ad placements even when publisher settings may override your custom color selections. This field must be set to true if both mainColor and accentColor are not set. The default value is true.
  - MultiAssetResponsiveDisplayAdBusinessName
```
public static final AdField MultiAssetResponsiveDisplayAdBusinessName
```
    The Advertiser/brand name. Maximum display width is 25.
  - MultiAssetResponsiveDisplayAdCallToActionText
```
public static final AdField MultiAssetResponsiveDisplayAdCallToActionText
```
    Call to action text.
  - MultiAssetResponsiveDisplayAdDescriptions
```
public static final AdField MultiAssetResponsiveDisplayAdDescriptions
```
    The descriptive text of the ad. Maximum display width is 90. One description is required. Support up to 5 descriptions.
  - MultiAssetResponsiveDisplayAdDynamicSettingsPricePrefix
```
public static final AdField MultiAssetResponsiveDisplayAdDynamicSettingsPricePrefix
```
    Prefix before price. Maximum display width is 10. For example, "as low as". For more details, check the help page https://developers.google.com/adwords/api/docs/guides/dynamic-remarketing
  - MultiAssetResponsiveDisplayAdDynamicSettingsPromoText
```
public static final AdField MultiAssetResponsiveDisplayAdDynamicSettingsPromoText
```
    Promotion text used for dynamic formats of multi-asset responsive display ads. Maximum display width is 25. For example, "Free two-day shipping". For more details, check the help page https://developers.google.com/adwords/api/docs/guides/dynamic-remarketing
  - MultiAssetResponsiveDisplayAdFormatSetting
```
public static final AdField MultiAssetResponsiveDisplayAdFormatSetting
```
    Specifies which format the ad will be served in. The default value is ALL_FORMATS.
  - MultiAssetResponsiveDisplayAdHeadlines
```
public static final AdField MultiAssetResponsiveDisplayAdHeadlines
```
    Short format of the headline of the ad. Maximum display width is 30. One short headline is required. Support up to 5 short headlines.
  - MultiAssetResponsiveDisplayAdLandscapeLogoImages
```
public static final AdField MultiAssetResponsiveDisplayAdLandscapeLogoImages
```
    Landscape logo image which is used for serving dynamic MultiAssetResponsiveDisplayAd. This ad format does not allow the creation of an image using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Optional. Support up to 5 with logoImages.
  - MultiAssetResponsiveDisplayAdLogoImages
```
public static final AdField MultiAssetResponsiveDisplayAdLogoImages
```
    Logo image to be used in the ad. This ad format does not allow the creation of an image using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Optional. Support up to 5 with landscapeLogoImages.
  - MultiAssetResponsiveDisplayAdLongHeadline
```
public static final AdField MultiAssetResponsiveDisplayAdLongHeadline
```
    Long format of the headline of the ad. Maximum display width is 90.
  - MultiAssetResponsiveDisplayAdMainColor
```
public static final AdField MultiAssetResponsiveDisplayAdMainColor
```
    Main color, represented as a hexadecimal string (e.g. #ffffff for white). If one of mainColor and accentColor is set, the other is required as well.
  - MultiAssetResponsiveDisplayAdMarketingImages
```
public static final AdField MultiAssetResponsiveDisplayAdMarketingImages
```
    Marketing image to be used in the ad. This ad format does not allow the creation of an imageAsset using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). One marketingImage is required. Support up to 15 with squareMarketingImages.
  - MultiAssetResponsiveDisplayAdSquareMarketingImages
```
public static final AdField MultiAssetResponsiveDisplayAdSquareMarketingImages
```
    Square marketing image to be used in the ad. This image may be used when a square aspect ratio is more appropriate than the aspect ratio of the #marketingImage image. This ad format does not allow the creation of an imageAsset using the ImageAsset.imageData field. An imageAsset must first be created using the AssetService, and ImageAsset.assetId must be populated in this field. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 the aspect ratio must be 1:1 (+-1%). One squareMarketingImage is required. Support up to 15 with marketingImages.
  - MultiAssetResponsiveDisplayAdYouTubeVideos
```
public static final AdField MultiAssetResponsiveDisplayAdYouTubeVideos
```
    The YouTube videos of the ad. Optional. Support up to 5 youtube videos. Asset.assetId must be populated in this field.
  - Name
```
public static final AdField Name
```
    Name of the ad.
  - Path1
```
public static final AdField Path1
```
    Text that appears in the ad with the displayed URL.
  - Path2
```
public static final AdField Path2
```
    In addition to #path1, more text that appears with the displayed URL.
  - ReadyToPlayOnTheWeb
```
public static final AdField ReadyToPlayOnTheWeb
```
    Indicates whether the audio is ready to play on the web.
  - ResponsiveSearchAdDescriptions
```
public static final AdField ResponsiveSearchAdDescriptions
```
    Descriptions. When the Ad serves, the descriptions will be selected from this list.
  - ResponsiveSearchAdHeadlines
```
public static final AdField ResponsiveSearchAdHeadlines
```
    Headlines. When the Ad serves, the headlines will be selected from this list.
  - ResponsiveSearchAdPath1
```
public static final AdField ResponsiveSearchAdPath1
```
    Text that appears in the ad with the displayed URL.
  - ResponsiveSearchAdPath2
```
public static final AdField ResponsiveSearchAdPath2
```
    In addition to #path1, more text that appears with the displayed URL.
  - ShortHeadline
```
public static final AdField ShortHeadline
```
    Short format of the headline of the ad. Maximum display width is 25.
  - StreamingUrl
```
public static final AdField StreamingUrl
```
    The streaming URL of the audio.
  - Type
```
public static final AdField Type
```
    Type of the creative.
  - UniversalAppAdDescriptions
```
public static final AdField UniversalAppAdDescriptions
```
    When the Ad serves, the descriptions will be selected from this list.
  - UniversalAppAdHeadlines
```
public static final AdField UniversalAppAdHeadlines
```
    When the Ad serves, the headlines will be selected from this list.
  - UniversalAppAdHtml5MediaBundles
```
public static final AdField UniversalAppAdHtml5MediaBundles
```
    HTML5 MediaBundles to attach to the ad.
  - UniversalAppAdImages
```
public static final AdField UniversalAppAdImages
```
    Marketing images to attach to the ad.
  - UniversalAppAdMandatoryAdText
```
public static final AdField UniversalAppAdMandatoryAdText
```
    Ad text that must be displayed when the ad is served.
  - UniversalAppAdYouTubeVideos
```
public static final AdField UniversalAppAdYouTubeVideos
```
    YouTube videos to attach to the ad
  - Url
```
public static final AdField Url
```
    Destination URL.
    Do not set this field if you are using upgraded URLs, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
- Method Detail
  - values
```
public static AdField[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AdField c : AdField.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AdField valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isFilterable
```
public boolean isFilterable()
```
    Description copied from interface: EntityField
    
    If the field is filterable.
    
    Specified by:
    
    isFilterable in interface EntityField
    
    Returns:
    
    true for a filterable field, false otherwise.

Enum AdField

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.api.ads.adwords.lib.selectorfields.EntityField

Enum Constant Detail

AccentColor

AdType

AllowFlexibleColor

BusinessName

CallToActionText

CreativeFinalAppUrls

CreativeFinalMobileUrls

CreativeFinalUrlSuffix

CreativeFinalUrls

CreativeTrackingUrlTemplate

CreativeUrlCustomParameters

Description

Description1

Description2

DisplayUrl

DurationMillis

ExpandedDynamicSearchCreativeDescription2

ExpandedTextAdDescription2

ExpandedTextAdHeadlinePart3

FormatSetting

HeadlinePart1

HeadlinePart2

Id

LongHeadline

MainColor

MultiAssetResponsiveDisplayAdAccentColor

MultiAssetResponsiveDisplayAdAllowFlexibleColor

MultiAssetResponsiveDisplayAdBusinessName

MultiAssetResponsiveDisplayAdCallToActionText

MultiAssetResponsiveDisplayAdDescriptions

MultiAssetResponsiveDisplayAdDynamicSettingsPricePrefix

MultiAssetResponsiveDisplayAdDynamicSettingsPromoText

MultiAssetResponsiveDisplayAdFormatSetting

MultiAssetResponsiveDisplayAdHeadlines

MultiAssetResponsiveDisplayAdLandscapeLogoImages

MultiAssetResponsiveDisplayAdLogoImages

MultiAssetResponsiveDisplayAdLongHeadline

MultiAssetResponsiveDisplayAdMainColor

MultiAssetResponsiveDisplayAdMarketingImages

MultiAssetResponsiveDisplayAdSquareMarketingImages

MultiAssetResponsiveDisplayAdYouTubeVideos

Name

Path1

Path2

ReadyToPlayOnTheWeb

ResponsiveSearchAdDescriptions

ResponsiveSearchAdHeadlines

ResponsiveSearchAdPath1

ResponsiveSearchAdPath2

ShortHeadline

StreamingUrl

Type

UniversalAppAdDescriptions

UniversalAppAdHeadlines

UniversalAppAdHtml5MediaBundles

UniversalAppAdImages

UniversalAppAdMandatoryAdText

UniversalAppAdYouTubeVideos

Url

Method Detail

values

valueOf

isFilterable