AdGroupAdField (Google Ads APIs Java Client Libraries Parent 1.38.0 API)

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

All Implemented Interfaces:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AdGroupAdDisapprovalReasons` List of disapproval reasons.
`AdGroupAdTrademarkDisapproved` True if and only if this ad is not serving because it does not meet trademark policy.
`AdGroupCreativeApprovalStatus` Approval status.
`AdGroupId` The id of the adgroup containing this ad.
`AdvertisingId` The Advertising Digital Identification code for this media, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
`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.
`CallOnlyAdPhoneNumber` Phone number string for the ad.
`CallOnlyAdPhoneNumberVerificationUrl` Url to be used for phone number verification.
`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.
`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.
`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.
`ExpandingDirections` Allowed expanding directions.
`ExperimentDataStatus` Status of the experiment row
`ExperimentDeltaStatus` Status of this AdGroupAd in the experiment.
`ExperimentId`
`FileSize` The size of the media file in bytes.
`Headline` The headline of the ad
`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.
`MediaId` ID of this media object.
`MimeType` The mime type of the media.
`MobileAdBusinessName` The business name of the mobile ad.
`MobileAdCountryCode` The country code for the phone number in the click-to-call mobile ad.
`MobileAdDescription` The description line.
`MobileAdHeadline` The headline of the ad.
`MobileAdMarkupLanguages` The list of markup languages to use for the mobile ad.
`MobileAdMobileCarriers` The list of mobile carriers to use for the mobile ad.
`MobileAdPhoneNumber` The click-to-call phone number.
`MobileImageAdMarkupLanguages` The list of markup languages to use for the mobile ad.
`MobileImageAdMobileCarriers` The list of mobile carriers to use for the mobile ad.
`Name` Name of the ad.
`PromotionLine` Promotional line for this ad.
`ReadyToPlayOnTheWeb` Indicates whether the audio is ready to play on the web.
`ReferenceId` Media reference ID key.
`RichMediaAdCertifiedVendorFormatId` Certified Vendor Format ID.
`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.
`SourceUrl` The URL of where the original media was downloaded from (or a file name).
`Status` The status of the ad.
`StreamingUrl` The streaming URL of the audio.
`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.
`Url` Destination URL.
`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.

Method Summary

Methods
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.

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
  - AdGroupAdDisapprovalReasons
```
public static final AdGroupAdField AdGroupAdDisapprovalReasons
```
    List of disapproval reasons.
  - AdGroupAdTrademarkDisapproved
```
public static final AdGroupAdField AdGroupAdTrademarkDisapproved
```
    True if and only if this ad is not serving because it does not meet trademark policy. This field is only useful when approvalStatus is an approved status.
  - AdGroupCreativeApprovalStatus
```
public static final AdGroupAdField AdGroupCreativeApprovalStatus
```
    Approval status.
  - AdGroupId
```
public static final AdGroupAdField AdGroupId
```
    The id of the adgroup containing this ad.
  - AdvertisingId
```
public static final AdGroupAdField AdvertisingId
```
    The Advertising Digital Identification code for this media, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
  - CallOnlyAdBusinessName
```
public static final AdGroupAdField CallOnlyAdBusinessName
```
    Business name of the ad.
  - CallOnlyAdCallTracked
```
public static final AdGroupAdField CallOnlyAdCallTracked
```
    If set to true, enable call tracking for the creative. Enabling call tracking also enables call conversions.
  - CallOnlyAdConversionTypeId
```
public static final AdGroupAdField CallOnlyAdConversionTypeId
```
    Conversion type to attribute a call conversion to. If not set, then a default conversion type id is used. Only in effect if callTracked is also set to true otherwise this field is ignored.
  - CallOnlyAdCountryCode
```
public static final AdGroupAdField CallOnlyAdCountryCode
```
    Two letter country code for the ad. Examples: 'US', 'GB'.
  - CallOnlyAdDescription1
```
public static final AdGroupAdField CallOnlyAdDescription1
```
    First line of ad text.
  - CallOnlyAdDescription2
```
public static final AdGroupAdField CallOnlyAdDescription2
```
    Second line of ad text.
  - CallOnlyAdPhoneNumber
```
public static final AdGroupAdField CallOnlyAdPhoneNumber
```
    Phone number string for the ad. Examples: '(800) 356-9377', "16502531234", "+442001234567"
  - CallOnlyAdPhoneNumberVerificationUrl
```
public static final AdGroupAdField CallOnlyAdPhoneNumberVerificationUrl
```
    Url to be used for phone number verification.
  - CreationTime
```
public static final AdGroupAdField CreationTime
```
    Media creation date in the format YYYY-MM-DD HH:MM:SS+TZ. This is not updatable and not specifiable.
  - CreativeFinalAppUrls
```
public static final AdGroupAdField 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 AdGroupAdField 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
  - CreativeFinalUrls
```
public static final AdGroupAdField 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 AdGroupAdField 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 AdGroupAdField 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
  - Description1
```
public static final AdGroupAdField Description1
```
    The first description line
  - Description2
```
public static final AdGroupAdField Description2
```
    The second description line
  - DevicePreference
```
public static final AdGroupAdField DevicePreference
```
    The device preference for the ad.
  - Dimensions
```
public static final AdGroupAdField Dimensions
```
    Various dimension sizes for the media. Only applies to image media (and video media for video thumbnails).
  - DisplayUrl
```
public static final AdGroupAdField DisplayUrl
```
    Visible URL.
  - DurationMillis
```
public static final AdGroupAdField DurationMillis
```
    The duration of the associated audio, in milliseconds.
  - ExpandingDirections
```
public static final AdGroupAdField ExpandingDirections
```
    Allowed expanding directions. These directions are used to match publishers' ad slots. For example, if a slot allows expansion toward the right, only ads with EXPANDING_RIGHT specified will show up there.
  - ExperimentDataStatus
```
public static final AdGroupAdField ExperimentDataStatus
```
    Status of the experiment row
  - ExperimentDeltaStatus
```
public static final AdGroupAdField ExperimentDeltaStatus
```
    Status of this AdGroupAd in the experiment. It must be specified while adding experiment data, which could come as a SET as well
  - ExperimentId
```
public static final AdGroupAdField ExperimentId
```
  - FileSize
```
public static final AdGroupAdField FileSize
```
    The size of the media file in bytes.
  - Headline
```
public static final AdGroupAdField Headline
```
    The headline of the ad
  - Height
```
public static final AdGroupAdField Height
```
    Height of the dimension
  - Id
```
public static final AdGroupAdField Id
```
    ID of this ad. This field is ignored when creating ads using AdGroupAdService.
  - ImageCreativeName
```
public static final AdGroupAdField ImageCreativeName
```
    The name label for this ad.
  - IndustryStandardCommercialIdentifier
```
public static final AdGroupAdField IndustryStandardCommercialIdentifier
```
    The Industry Standard Commercial Identifier code for this media, used mainly for television commercials.
  - IsCookieTargeted
```
public static final AdGroupAdField IsCookieTargeted
```
    Defines whether or not the ad is cookie targeted. (i.e. user list targeting, or the network's equivalent).
  - IsTagged
```
public static final AdGroupAdField IsTagged
```
    Defines whether or not the ad contains a tracking pixel of any kind.
  - IsUserInterestTargeted
```
public static final AdGroupAdField IsUserInterestTargeted
```
    Defines whether or not the ad is targeting user interest.
  - Labels
```
public static final AdGroupAdField Labels
```
    Labels that are attached to the AdGroupAd. To associate an existing 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 Labels, use one of Predicate.Operator#CONTAINS_ALL, Predicate.Operator#CONTAINS_ANY, Predicate.Operator#CONTAINS_NONE operators with a list of Label ids.
  - MediaId
```
public static final AdGroupAdField MediaId
```
    ID of this media object.
  - MimeType
```
public static final AdGroupAdField MimeType
```
    The mime type of the media.
  - MobileAdBusinessName
```
public static final AdGroupAdField MobileAdBusinessName
```
    The business name of the mobile ad. Must not exceed 20 characters (except for ads targeted to Japan, which must not exceed 10 Japanese characters).
  - MobileAdCountryCode
```
public static final AdGroupAdField MobileAdCountryCode
```
    The country code for the phone number in the click-to-call mobile ad. The click-to-call ad will display only in this country. This field will be used to verify the phone number format and validate the targeted mobile carriers.
  - MobileAdDescription
```
public static final AdGroupAdField MobileAdDescription
```
    The description line.
  - MobileAdHeadline
```
public static final AdGroupAdField MobileAdHeadline
```
    The headline of the ad.
  - MobileAdMarkupLanguages
```
public static final AdGroupAdField MobileAdMarkupLanguages
```
    The list of markup languages to use for the mobile ad.
  - MobileAdMobileCarriers
```
public static final AdGroupAdField MobileAdMobileCarriers
```
    The list of mobile carriers to use for the mobile ad. Each string must be of the form 'CarrierName@CountryCode'. To specify that all available carriers are to be used, use the reserved keyword 'ALLCARRIERS'. See available mobile carriers.
  - MobileAdPhoneNumber
```
public static final AdGroupAdField MobileAdPhoneNumber
```
    The click-to-call phone number. Must not exceed 20 characters.
  - MobileImageAdMarkupLanguages
```
public static final AdGroupAdField MobileImageAdMarkupLanguages
```
    The list of markup languages to use for the mobile ad.
  - MobileImageAdMobileCarriers
```
public static final AdGroupAdField MobileImageAdMobileCarriers
```
    The list of mobile carriers to use for the mobile ad. Each string must be of the form 'CarrierName@CountryCode'. To specify that all available carriers are to be used, use the reserved keyword 'ALLCARRIERS'. See available mobile carriers.
  - Name
```
public static final AdGroupAdField Name
```
    Name of the ad.
  - PromotionLine
```
public static final AdGroupAdField PromotionLine
```
    Promotional line for this ad. This text will be displayed in addition to the products.
  - ReadyToPlayOnTheWeb
```
public static final AdGroupAdField ReadyToPlayOnTheWeb
```
    Indicates whether the audio is ready to play on the web.
  - ReferenceId
```
public static final AdGroupAdField ReferenceId
```
    Media reference ID key.
  - RichMediaAdCertifiedVendorFormatId
```
public static final AdGroupAdField RichMediaAdCertifiedVendorFormatId
```
    Certified Vendor Format ID.
  - RichMediaAdDuration
```
public static final AdGroupAdField RichMediaAdDuration
```
    Duration for the ad (in milliseconds). Default is 0.
  - RichMediaAdImpressionBeaconUrl
```
public static final AdGroupAdField RichMediaAdImpressionBeaconUrl
```
    Impression beacon URL for the ad.
  - RichMediaAdName
```
public static final AdGroupAdField RichMediaAdName
```
    Name of the rich media ad.
  - RichMediaAdSnippet
```
public static final AdGroupAdField RichMediaAdSnippet
```
    Snippet for this ad. Required for standard third-party ads.
  - RichMediaAdSourceUrl
```
public static final AdGroupAdField RichMediaAdSourceUrl
```
    SourceUrl pointing to the third party snippet. For third party in-stream video ads, this stores the VAST URL. For DFA ads, it stores the InRed URL.
  - RichMediaAdType
```
public static final AdGroupAdField RichMediaAdType
```
    Type of this rich media ad, the default is Standard.
  - SourceUrl
```
public static final AdGroupAdField SourceUrl
```
    The URL of where the original media was downloaded from (or a file name).
  - Status
```
public static final AdGroupAdField Status
```
    The status of the ad.
  - StreamingUrl
```
public static final AdGroupAdField StreamingUrl
```
    The streaming URL of the audio.
  - TemplateAdDuration
```
public static final AdGroupAdField TemplateAdDuration
```
    Duration of this ad (if it contains playable media).
  - TemplateAdName
```
public static final AdGroupAdField TemplateAdName
```
    Name of this ad.
  - TemplateAdUnionId
```
public static final AdGroupAdField TemplateAdUnionId
```
    Group ID of all template ads, which should be created together. Template ads in the same union reference the same data but have different dimensions. Single ads do not have a union ID. If a template ad specifies an ad union with only one ad, no union will be created.
  - TemplateElementFieldName
```
public static final AdGroupAdField TemplateElementFieldName
```
    The name of this field.
  - TemplateElementFieldText
```
public static final AdGroupAdField TemplateElementFieldText
```
    Text value for text field types. Null if not text field. The field is a text field if type is ADDRESS, ENUM, TEXT, URL, or VISIBLE_URL.
  - TemplateElementFieldType
```
public static final AdGroupAdField TemplateElementFieldType
```
    The type of this field.
  - TemplateId
```
public static final AdGroupAdField TemplateId
```
    ID of the template to use.
  - TemplateOriginAdId
```
public static final AdGroupAdField TemplateOriginAdId
```
    For copies, the ad id of the ad this was or should be copied from.
  - Type
```
public static final AdGroupAdField Type
```
    Type of the creative.
  - UniqueName
```
public static final AdGroupAdField UniqueName
```
    Unique name for this element.
  - Url
```
public static final AdGroupAdField 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
  - Urls
```
public static final AdGroupAdField Urls
```
    URLs pointing to the resized media for the given sizes. Only applies to image media.
  - VideoTypes
```
public static final AdGroupAdField VideoTypes
```
    Video Types of the ad. (RealMedia, Quick Time etc.)
  - Width
```
public static final AdGroupAdField Width
```
    Width of the dimension
  - YouTubeVideoIdString
```
public static final AdGroupAdField YouTubeVideoIdString
```
    For YouTube-hosted videos, the YouTube video ID (as seen in YouTube URLs) may also be filled in.
- Method Detail
  - values
```
public static AdGroupAdField[] 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 (AdGroupAdField c : AdGroupAdField.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AdGroupAdField 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 AdGroupAdField

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

AdGroupAdDisapprovalReasons

AdGroupAdTrademarkDisapproved

AdGroupCreativeApprovalStatus

AdGroupId

AdvertisingId

CallOnlyAdBusinessName

CallOnlyAdCallTracked

CallOnlyAdConversionTypeId

CallOnlyAdCountryCode

CallOnlyAdDescription1

CallOnlyAdDescription2

CallOnlyAdPhoneNumber

CallOnlyAdPhoneNumberVerificationUrl

CreationTime

CreativeFinalAppUrls

CreativeFinalMobileUrls

CreativeFinalUrls

CreativeTrackingUrlTemplate

CreativeUrlCustomParameters

Description1

Description2

DevicePreference

Dimensions

DisplayUrl

DurationMillis

ExpandingDirections

ExperimentDataStatus

ExperimentDeltaStatus

ExperimentId

FileSize

Headline

Height

Id

ImageCreativeName

IndustryStandardCommercialIdentifier

IsCookieTargeted

IsTagged

IsUserInterestTargeted

Labels

MediaId

MimeType

MobileAdBusinessName

MobileAdCountryCode

MobileAdDescription

MobileAdHeadline

MobileAdMarkupLanguages

MobileAdMobileCarriers

MobileAdPhoneNumber

MobileImageAdMarkupLanguages

MobileImageAdMobileCarriers

Name

PromotionLine

ReadyToPlayOnTheWeb

ReferenceId

RichMediaAdCertifiedVendorFormatId

RichMediaAdDuration

RichMediaAdImpressionBeaconUrl

RichMediaAdName

RichMediaAdSnippet

RichMediaAdSourceUrl

RichMediaAdType

SourceUrl

Status

StreamingUrl

TemplateAdDuration

TemplateAdName

TemplateAdUnionId

TemplateElementFieldName

TemplateElementFieldText

TemplateElementFieldType

TemplateId

TemplateOriginAdId

Type