public enum AdGroupAdField extends Enum<AdGroupAdField> implements EntityField
Enum
to facilitate the selection of fields for AdGroupAd
.Enum Constant and Description |
---|
AccentColor
Accent color.
|
AdGroupId
The id of the adgroup containing this ad.
|
AdStrengthInfo
The strength information of the Ad.
|
AdType
Type of ad.
|
AdvertisingId
The Advertising Digital Identification code for this media, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
|
AllowFlexibleColor
Advertiser?s consent to allow flexible color.
|
Automated
Indicates if this ad was added by AdWords.
|
BaseAdGroupId
ID of the base ad group from which this draft/trial ad was created.
|
BaseCampaignId
ID of the base campaign from which this draft/trial ad was created.
|
BusinessName
The business name.
|
CallOnlyAdBusinessName
Business name of the ad.
|
CallOnlyAdCallTracked
If set to true, enable call tracking for the creative.
|
CallOnlyAdConversionTypeId
Conversion type to attribute a call conversion to.
|
CallOnlyAdCountryCode
Two letter country code for the ad.
|
CallOnlyAdDescription1
First line of ad text.
|
CallOnlyAdDescription2
Second line of ad text.
|
CallOnlyAdDisableCallConversion
By default, call conversions are enabled when callTracked is on.
|
CallOnlyAdPhoneNumber
Phone number string for the ad.
|
CallOnlyAdPhoneNumberVerificationUrl
Url to be used for phone number verification.
|
CallToActionText
Call to action text.
|
CombinedApprovalStatus
Approval status that combines review state and status.
|
CreationTime
Media creation date in the format YYYY-MM-DD HH:MM:SS+TZ.
|
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.
|
DevicePreference
The device preference for the ad.
|
Dimensions
Various dimension sizes for the media.
|
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.
|
ExpandingDirections
Allowed expanding directions.
|
FileSize
The size of the media file in bytes.
|
FormatSetting
Specifies which format the ad will be served in.
|
GmailHeaderImage
Header image.
|
GmailMarketingImage
Marketing image.
|
GmailTeaserBusinessName
Business name of the advertiser.
|
GmailTeaserDescription
Description of the teaser.
|
GmailTeaserHeadline
Headline of the teaser.
|
GmailTeaserLogoImage
Required.
|
Headline
The headline of the ad.
|
HeadlinePart1
First part of the headline.
|
HeadlinePart2
Second part of the headline.
|
Height
Height of the dimension
|
Id
ID of this ad.
|
ImageCreativeName
The name label for this ad.
|
IndustryStandardCommercialIdentifier
The Industry Standard Commercial Identifier code for this media, used mainly for television commercials.
|
IsCookieTargeted
Defines whether or not the ad is cookie targeted.
|
IsTagged
Defines whether or not the ad contains a tracking pixel of any kind.
|
IsUserInterestTargeted
Defines whether or not the ad is targeting user interest.
|
Labels
Labels that are attached to the AdGroupAd.
|
LandscapeLogoImage
Landscape logo image.
|
LogoImage
Logo image to be used in the ad.
|
LongHeadline
Long format of the headline of the ad.
|
MainColor
Main color.
|
MarketingImage
Marketing image to be used in the ad.
|
MarketingImageCallToActionText
Text of the display-call-to-action.
|
MarketingImageCallToActionTextColor
Text color of the display-call-to-action.
|
MarketingImageDescription
Description of the marketing image.
|
MarketingImageHeadline
Headline of the marketing image.
|
MediaId
ID of this media object.
|
MimeType
The mime type of the media.
|
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. |
PolicySummary
Summary of policy findings for this ad.
|
PricePrefix
Prefix before price.
|
ProductImages
Product images.
|
ProductVideoList
Product Videos.
|
PromoText
Promotion text used for dynamic formats of responsive ads.
|
ReadyToPlayOnTheWeb
Indicates whether the audio is ready to play on the web.
|
ReferenceId
Media reference ID key.
|
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. |
RichMediaAdCertifiedVendorFormatId
|
RichMediaAdDuration
Duration for the ad (in milliseconds).
|
RichMediaAdImpressionBeaconUrl
Impression beacon URL for the ad.
|
RichMediaAdName
Name of the rich media ad.
|
RichMediaAdSnippet
Snippet for this ad.
|
RichMediaAdSourceUrl
SourceUrl pointing to the third party snippet.
|
RichMediaAdType
Type of this rich media ad, the default is Standard.
|
ShortHeadline
Short format of the headline of the ad.
|
SourceUrl
The URL of where the original media was downloaded from (or a file name).
|
SquareMarketingImage
Square marketing image to be used in the ad.
|
Status
The status of the ad.
|
StreamingUrl
The streaming URL of the audio.
|
SystemManagedEntitySource
The source of this system-managed ad.
|
TemplateAdDuration
Duration of this ad (if it contains playable media).
|
TemplateAdName
Name of this ad.
|
TemplateAdUnionId
Group ID of all template ads, which should be created together.
|
TemplateElementFieldName
The name of this field.
|
TemplateElementFieldText
Text value for text field types.
|
TemplateElementFieldType
The type of this field.
|
TemplateId
ID of the template to use.
|
TemplateOriginAdId
For copies, the ad id of the ad this was or should be copied from.
|
Type
Type of the creative.
|
UniqueName
Unique name for this element.
|
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.
|
UrlData
Additional urls for the ad that are tagged with a unique identifier.
|
Urls
URLs pointing to the resized media for the given sizes.
|
VideoTypes
Video Types of the ad.
|
Width
Width of the dimension
|
YouTubeVideoIdString
For YouTube-hosted videos, the YouTube video ID (as seen in YouTube URLs) may also be filled in.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isFilterable()
If the field is filterable.
|
static AdGroupAdField |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static AdGroupAdField[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
name
public static final AdGroupAdField AccentColor
public static final AdGroupAdField AdGroupId
public static final AdGroupAdField AdStrengthInfo
public static final AdGroupAdField AdType
public static final AdGroupAdField AdvertisingId
public static final AdGroupAdField AllowFlexibleColor
public static final AdGroupAdField Automated
public static final AdGroupAdField BaseAdGroupId
public static final AdGroupAdField BaseCampaignId
public static final AdGroupAdField BusinessName
null
when it is contained within Operator
s : ADD.public static final AdGroupAdField CallOnlyAdBusinessName
public static final AdGroupAdField CallOnlyAdCallTracked
public static final AdGroupAdField CallOnlyAdConversionTypeId
public static final AdGroupAdField CallOnlyAdCountryCode
public static final AdGroupAdField CallOnlyAdDescription1
public static final AdGroupAdField CallOnlyAdDescription2
public static final AdGroupAdField CallOnlyAdDisableCallConversion
public static final AdGroupAdField CallOnlyAdPhoneNumber
public static final AdGroupAdField CallOnlyAdPhoneNumberVerificationUrl
public static final AdGroupAdField CallToActionText
public static final AdGroupAdField CombinedApprovalStatus
public static final AdGroupAdField CreationTime
public static final AdGroupAdField CreativeFinalAppUrls
This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
public static final AdGroupAdField CreativeFinalMobileUrls
This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
public static final AdGroupAdField CreativeFinalUrlSuffix
On update, empty string ("") indicates to clear the field.
public static final AdGroupAdField CreativeFinalUrls
This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
public static final AdGroupAdField CreativeTrackingUrlTemplate
This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
public static final AdGroupAdField CreativeUrlCustomParameters
This field is used for upgraded urls only, as described at: https://developers.google.com/adwords/api/docs/guides/upgraded-urls
public static final AdGroupAdField Description
public static final AdGroupAdField Description1
public static final AdGroupAdField Description2
public static final AdGroupAdField DevicePreference
public static final AdGroupAdField Dimensions
public static final AdGroupAdField DisplayUrl
public static final AdGroupAdField DurationMillis
public static final AdGroupAdField ExpandedDynamicSearchCreativeDescription2
public static final AdGroupAdField ExpandedTextAdDescription2
public static final AdGroupAdField ExpandedTextAdHeadlinePart3
public static final AdGroupAdField ExpandingDirections
public static final AdGroupAdField FileSize
public static final AdGroupAdField FormatSetting
public static final AdGroupAdField GmailHeaderImage
"GmailAd"
.
Valid image types are GIF, JPEG, and PNG.
The minimum size is 300x100 and the aspect ratio must be in 3:1 to 5:1 (+-1%).public static final AdGroupAdField GmailMarketingImage
"GmailAd"
.Valid image types are GIF, JPEG, and PNG.
The minimum size is 600x314 and the aspect ratio must be 600:314 (+-1%).
For square marketing image, the minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%).
Either productVideos or marketingImage must be specified.public static final AdGroupAdField GmailTeaserBusinessName
public static final AdGroupAdField GmailTeaserDescription
public static final AdGroupAdField GmailTeaserHeadline
public static final AdGroupAdField GmailTeaserLogoImage
"GmailTeaser"
.
Valid image types are GIF, JPEG, and PNG.
The minimum size is 144x144 and the aspect ratio must be 1:1 (+-1%).
Required.public static final AdGroupAdField Headline
public static final AdGroupAdField HeadlinePart1
public static final AdGroupAdField HeadlinePart2
public static final AdGroupAdField Height
public static final AdGroupAdField Id
AdGroupAdService
.public static final AdGroupAdField ImageCreativeName
null
.public static final AdGroupAdField IndustryStandardCommercialIdentifier
public static final AdGroupAdField IsCookieTargeted
public static final AdGroupAdField IsTagged
public static final AdGroupAdField IsUserInterestTargeted
public static final AdGroupAdField Labels
Label
to an existing AdGroupAd
, use AdGroupAdService#mutateLabel
with ADD operator.
To remove an associated Label
from the AdGroupAd
, use AdGroupAdService#mutateLabel
with REMOVE operator.
To filter on Label
s, use one of Predicate.Operator#CONTAINS_ALL
, Predicate.Operator#CONTAINS_ANY
, Predicate.Operator#CONTAINS_NONE
operators with a list of Label
ids.public static final AdGroupAdField LandscapeLogoImage
"DynamicSettings"
.
Valid image types are GIF, JPEG, and PNG.
The minimum size is 512x128 the aspect ratio must be 512:128 (+-1%).public static final AdGroupAdField LogoImage
"ResponsiveDisplayAd"
.
Valid image types are GIF, JPEG, and PNG.
The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).public static final AdGroupAdField LongHeadline
public static final AdGroupAdField MainColor
public static final AdGroupAdField MarketingImage
"ResponsiveDisplayAd"
.
Valid image types are GIF, JPEG, and PNG.
The minimum size is 600x314 and the aspect ratio must be 600:314 (+-1%).public static final AdGroupAdField MarketingImageCallToActionText
public static final AdGroupAdField MarketingImageCallToActionTextColor
public static final AdGroupAdField MarketingImageDescription
public static final AdGroupAdField MarketingImageHeadline
public static final AdGroupAdField MediaId
public static final AdGroupAdField MimeType
public static final AdGroupAdField MultiAssetResponsiveDisplayAdAccentColor
public static final AdGroupAdField MultiAssetResponsiveDisplayAdAllowFlexibleColor
public static final AdGroupAdField MultiAssetResponsiveDisplayAdBusinessName
public static final AdGroupAdField MultiAssetResponsiveDisplayAdCallToActionText
public static final AdGroupAdField MultiAssetResponsiveDisplayAdDescriptions
public static final AdGroupAdField MultiAssetResponsiveDisplayAdDynamicSettingsPricePrefix
public static final AdGroupAdField MultiAssetResponsiveDisplayAdDynamicSettingsPromoText
public static final AdGroupAdField MultiAssetResponsiveDisplayAdFormatSetting
public static final AdGroupAdField MultiAssetResponsiveDisplayAdHeadlines
public static final AdGroupAdField MultiAssetResponsiveDisplayAdLandscapeLogoImages
public static final AdGroupAdField MultiAssetResponsiveDisplayAdLogoImages
public static final AdGroupAdField MultiAssetResponsiveDisplayAdLongHeadline
public static final AdGroupAdField MultiAssetResponsiveDisplayAdMainColor
public static final AdGroupAdField MultiAssetResponsiveDisplayAdMarketingImages
public static final AdGroupAdField MultiAssetResponsiveDisplayAdSquareMarketingImages
#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.public static final AdGroupAdField MultiAssetResponsiveDisplayAdYouTubeVideos
public static final AdGroupAdField Name
public static final AdGroupAdField Path1
public static final AdGroupAdField Path2
#path1
, more text that appears with the displayed URL.public static final AdGroupAdField PolicySummary
public static final AdGroupAdField PricePrefix
public static final AdGroupAdField ProductImages
public static final AdGroupAdField ProductVideoList
public static final AdGroupAdField PromoText
public static final AdGroupAdField ReadyToPlayOnTheWeb
public static final AdGroupAdField ReferenceId
public static final AdGroupAdField ResponsiveSearchAdDescriptions
public static final AdGroupAdField ResponsiveSearchAdHeadlines
public static final AdGroupAdField ResponsiveSearchAdPath1
public static final AdGroupAdField ResponsiveSearchAdPath2
#path1
, more text that appears with the displayed URL.public static final AdGroupAdField RichMediaAdCertifiedVendorFormatId
public static final AdGroupAdField RichMediaAdDuration
public static final AdGroupAdField RichMediaAdImpressionBeaconUrl
public static final AdGroupAdField RichMediaAdName
null
.public static final AdGroupAdField RichMediaAdSnippet
The length of the string should be between 1 and 3072, inclusive.
public static final AdGroupAdField RichMediaAdSourceUrl
public static final AdGroupAdField RichMediaAdType
public static final AdGroupAdField ShortHeadline
public static final AdGroupAdField SourceUrl
public static final AdGroupAdField SquareMarketingImage
#marketingImage
image.
This ad format does not allow the creation of an image using the Image.data field.
An image must first be created using the MediaService, and Image.mediaId must be populated when creating a "ResponsiveDisplayAd"
.
Valid image types are GIF, JPEG, and PNG.
The minimum size is 300x300 the aspect ratio must be 1:1 (+-1%).public static final AdGroupAdField Status
null
when it is contained within Operator
s : SET.public static final AdGroupAdField StreamingUrl
public static final AdGroupAdField SystemManagedEntitySource
public static final AdGroupAdField TemplateAdDuration
public static final AdGroupAdField TemplateAdName
null
.public static final AdGroupAdField TemplateAdUnionId
public static final AdGroupAdField TemplateElementFieldName
public static final AdGroupAdField TemplateElementFieldText
public static final AdGroupAdField TemplateElementFieldType
public static final AdGroupAdField TemplateId
public static final AdGroupAdField TemplateOriginAdId
public static final AdGroupAdField Type
public static final AdGroupAdField UniqueName
public static final AdGroupAdField UniversalAppAdDescriptions
public static final AdGroupAdField UniversalAppAdHeadlines
public static final AdGroupAdField UniversalAppAdHtml5MediaBundles
public static final AdGroupAdField UniversalAppAdImages
public static final AdGroupAdField UniversalAppAdMandatoryAdText
public static final AdGroupAdField UniversalAppAdYouTubeVideos
public static final AdGroupAdField 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
public static final AdGroupAdField UrlData
public static final AdGroupAdField Urls
public static final AdGroupAdField VideoTypes
public static final AdGroupAdField Width
public static final AdGroupAdField YouTubeVideoIdString
public static AdGroupAdField[] values()
for (AdGroupAdField c : AdGroupAdField.values()) System.out.println(c);
public static AdGroupAdField valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic boolean isFilterable()
EntityField
isFilterable
in interface EntityField
Copyright © 2020. All Rights Reserved.