AdGroupField (Google Ads APIs Client Library for Java parent 3.12.0 API)

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

All Implemented Interfaces:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AdGroupType`
`AdRotationMode`
`BaseAdGroupId` ID of the base adgroup from which this draft/trial adgroup was created.
`BaseCampaignId` ID of the base campaign from which this draft/trial adgroup was created.
`BiddingStrategyId` Id of the bidding strategy to be associated with the campaign, ad group or ad group criteria.
`BiddingStrategyName` Name of the bidding strategy.
`BiddingStrategySource` Indicates where the bidding strategy is associated i.e.
`BiddingStrategyType` The type of the bidding strategy to be attached.
`CampaignId` ID of the campaign with which this ad group is associated.
`CampaignName` Name of the campaign with which this ad group is associated.
`ContentBidCriterionTypeGroup` Allows advertisers to specify a criteria dimension on which to place absolute bids.
`CpcBid` Max CPC (cost per click) bid.
`CpmBid` Max CPM (cost per thousand impressions) bid.
`EnhancedCpcEnabled` The enhanced CPC bidding option for the campaign, which enables bids to be enhanced based on conversion optimizer data.
`Id` ID of this ad group.
`Labels` Labels that are attached to the `AdGroup`.
`Name` Name of this ad group (at most 255 UTF-8 full-width characters).
`Settings` List of settings for the AdGroup.
`Status` Status of this ad group.
`TargetCpa` Average cost per acquisition (CPA) target.
`TargetCpaBid` Target cost per acquisition (CPA).
`TargetCpaBidSource` The level (ad group, ad group strategy, or campaign strategy) at which the bid was set.
`TargetRoasOverride` The target return on average spend (ROAS).
`TargetSpendEnhancedCpcEnabled` The enhanced CPC bidding option for the campaign, which enables CPC bids to be enhanced based on conversion optimizer data.
`TrackingUrlTemplate` URL template for constructing a tracking URL.
`UrlCustomParameters` A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isFilterable()` If the field is filterable.
`static AdGroupField`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AdGroupField[]`	`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
  - AdGroupType
```
public static final AdGroupField AdGroupType
```
  - AdRotationMode
```
public static final AdGroupField AdRotationMode
```
  - BaseAdGroupId
```
public static final AdGroupField BaseAdGroupId
```
    ID of the base adgroup from which this draft/trial adgroup was created. For base adgroups this is equal to the adgroup ID. If the adgroup was created in the draft or trial and has no corresponding base adgroup, this field is null. This field is readonly and only returned on get requests.
  - BaseCampaignId
```
public static final AdGroupField BaseCampaignId
```
    ID of the base campaign from which this draft/trial adgroup was created. This field is only returned on get requests.
  - BiddingStrategyId
```
public static final AdGroupField BiddingStrategyId
```
    Id of the bidding strategy to be associated with the campaign, ad group or ad group criteria. A bidding strategy is created using the BiddingStrategyService ADD operation and is assigned a BiddingStrategyId. The BiddingStrategyId can be shared across campaigns, ad groups and ad group criteria.
    Starting with v201705, this field cannot be set at the ad group or ad group criterion level.
  - BiddingStrategyName
```
public static final AdGroupField BiddingStrategyName
```
    Name of the bidding strategy. This is applicable only for flexible bidding strategies.
  - BiddingStrategySource
```
public static final AdGroupField BiddingStrategySource
```
    Indicates where the bidding strategy is associated i.e. campaign, ad group or ad group criterion.
  - BiddingStrategyType
```
public static final AdGroupField BiddingStrategyType
```
    The type of the bidding strategy to be attached.
    For details on portfolio vs. standard availability, see the bidding guide.
    Starting with v201705, this field cannot be set at the ad group or ad group criterion level to any value other than BiddingStrategyType.NONE.
  - CampaignId
```
public static final AdGroupField CampaignId
```
    ID of the campaign with which this ad group is associated.
  - CampaignName
```
public static final AdGroupField CampaignName
```
    Name of the campaign with which this ad group is associated.
  - ContentBidCriterionTypeGroup
```
public static final AdGroupField ContentBidCriterionTypeGroup
```
    Allows advertisers to specify a criteria dimension on which to place absolute bids. This is only applicable for campaigns that target only the content network and not search.
  - CpcBid
```
public static final AdGroupField CpcBid
```
    Max CPC (cost per click) bid. At the ad group level, this represents the default bid applicable for
    - keyword targeting on search network.
    - keywords & placements for content targeting.
    At the ad group criteria level, this is the max cpc bid.
  - CpmBid
```
public static final AdGroupField CpmBid
```
    Max CPM (cost per thousand impressions) bid.
  - EnhancedCpcEnabled
```
public static final AdGroupField EnhancedCpcEnabled
```
    The enhanced CPC bidding option for the campaign, which enables bids to be enhanced based on conversion optimizer data. For more information about enhanced CPC, see the AdWords Help Center.
  - Id
```
public static final AdGroupField Id
```
    ID of this ad group.
  - Labels
```
public static final AdGroupField Labels
```
    Labels that are attached to the AdGroup. To associate an existing Label to an existing AdGroup, use AdGroupService#mutateLabel with ADD operator. To remove an associated Label from the AdGroup, use AdGroupService#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.
  - Name
```
public static final AdGroupField Name
```
    Name of this ad group (at most 255 UTF-8 full-width characters). This field is required and should not be null for ADD operations from v201309 version.
  - Settings
```
public static final AdGroupField Settings
```
    List of settings for the AdGroup.
  - Status
```
public static final AdGroupField Status
```
    Status of this ad group.
  - TargetCpa
```
public static final AdGroupField TargetCpa
```
    Average cost per acquisition (CPA) target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
  - TargetCpaBid
```
public static final AdGroupField TargetCpaBid
```
    Target cost per acquisition (CPA). This is applicable only at the ad group level.
    If an ad group-level target is not set and the strategy type is TARGET_CPA, the strategy level target will be used. To set the strategy-level target, set the TargetCpaBiddingScheme#targetCpa on the strategy's BiddingStrategyConfiguration#biddingScheme.
  - TargetCpaBidSource
```
public static final AdGroupField TargetCpaBidSource
```
    The level (ad group, ad group strategy, or campaign strategy) at which the bid was set. This is applicable only at the ad group level.
  - TargetRoasOverride
```
public static final AdGroupField TargetRoasOverride
```
    The target return on average spend (ROAS). This target can only be set on ad groups. If this ad group's effective bidding strategy is a standard TARGET_ROAS strategy attached to the campaign, then the target overrides the target roas specified in the campaign's bidding strategy. Otherwise, this value is ignored.
  - TargetSpendEnhancedCpcEnabled
```
public static final AdGroupField TargetSpendEnhancedCpcEnabled
```
    The enhanced CPC bidding option for the campaign, which enables CPC bids to be enhanced based on conversion optimizer data. For more information about enhanced CPC, see the AdWords Help Center.
    This attribute can only be set on a standard bidding strategy. Attempting to set this attribute on a portfolio bidding strategy will result in an error.
  - TrackingUrlTemplate
```
public static final AdGroupField TrackingUrlTemplate
```
    URL template for constructing a tracking URL.
    On update, empty string ("") indicates to clear the field.
  - UrlCustomParameters
```
public static final AdGroupField UrlCustomParameters
```
    A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.
- Method Detail
  - values
```
public static AdGroupField[] 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 (AdGroupField c : AdGroupField.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AdGroupField 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 AdGroupField

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

AdGroupType

AdRotationMode

BaseAdGroupId

BaseCampaignId

BiddingStrategyId

BiddingStrategyName

BiddingStrategySource

BiddingStrategyType

CampaignId

CampaignName

ContentBidCriterionTypeGroup

CpcBid

CpmBid

EnhancedCpcEnabled

Id

Labels

Name

Settings

Status

TargetCpa

TargetCpaBid

TargetCpaBidSource

TargetRoasOverride

TargetSpendEnhancedCpcEnabled

TrackingUrlTemplate

UrlCustomParameters

Method Detail

values

valueOf

isFilterable