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

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

All Implemented Interfaces:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AdGroupId` The ad group this criterion is in.
`AgeRangeType`
`AppId` A string that uniquely identifies a mobile application to AdWords API.
`AppPaymentModelType`
`ApprovalStatus` Approval status.
`BaseAdGroupId` ID of the base ad group from which this draft/trial ad group criterion was created.
`BaseCampaignId` ID of the base campaign from which this draft/trial ad group criterion 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.
`BidModifier` Bid modifier of the criterion which is used when the criterion is not in an absolute bidding dimension.
`CaseValue` Dimension value with which this product partition is refining its parent.
`ChannelId` The YouTube uploader channel id or the channel code of a YouTube content channel.
`ChannelName` The public name for a YouTube user channel.
`CpcBid` Max CPC (cost per click) bid.
`CpcBidSource` The level (ad group or criterion) at which the bid was set.
`CpmBid` Max CPM (cost per thousand impressions) bid.
`CpmBidSource` The level (ad group or criterion) at which the bid was set.
`CriteriaCoverage` Keywordless criteria coverage - Computed percentage of website coverage based on the website target, negative website targets and negative keywords in the ad group and campaign.
`CriteriaSamples` Keywordless criteria samples - List of sample urls that matches with the website target.
`CriteriaType`
`CriterionUse`
`DestinationUrl` Destination URL override when Ad is triggered by this criterion.
`DisapprovalReasons` List of disapproval reasons.
`DisplayName` Title of this mobile application.
`EnhancedCpcEnabled` The enhanced CPC bidding option for the campaign, which enables bids to be enhanced based on conversion optimizer data.
`FinalAppUrls` A list of final app URLs that will be used on mobile if the user has the specific app installed.
`FinalMobileUrls` A list of possible final mobile URLs after all cross domain redirects.
`FinalUrls` A list of possible final URLs after all cross domain redirects.
`FirstPageCpc` First page Cpc for this criterion.
`FirstPositionCpc` An estimate of the cpc bid needed for your ad to regularly appear in the top position above the search results on google.com when a query matches the keywords exactly.
`GenderType`
`Id` ID of this criterion.
`IncomeRangeType`
`KeywordMatchType` Match type of this keyword.
`KeywordText` Text of this keyword (at most 80 characters and ten words).
`Labels` Labels that are attached to the AdGroupCriterion.
`MobileAppCategoryId` ID of this mobile app category.
`Parameter` The webpage criterion parameter.
`ParentCriterionId` ID of the parent product partition subdivision.
`ParentType`
`PartitionType` Type of the product partition.
`Path` The category to target or exclude.
`PlacementUrl` Url of the placement.
`QualityScore` The keyword quality score ranges from 1 (lowest) to 10 (highest).
`Status` Current user-set state of criterion.
`SystemServingStatus` Serving status.
`TargetSpendEnhancedCpcEnabled` The enhanced CPC bidding option for the campaign, which enables CPC bids to be enhanced based on conversion optimizer data.
`TopOfPageCpc` An estimate of the cpc bid needed for your ad to appear above the first page of Google search results when a query matches the keywords exactly.
`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.
`UserInterestId` Id of this user interest.
`UserInterestName` Name of this user interest.
`UserInterestParentId` Parent Id of this user interest.
`UserListEligibleForDisplay` Determines whether a user list is eligible for targeting in the display network.
`UserListEligibleForSearch` Determines whether a user list is eligible for targeting in the google.com (search) network.
`UserListId` Id of this user list.
`UserListMembershipStatus`
`UserListName`
`VerticalId` Id of this vertical.
`VerticalParentId` Id of the parent of this vertical.
`VideoId` YouTube video id as it appears on the YouTube watch page.
`VideoName` Name of the video.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isFilterable()` If the field is filterable.
`static AdGroupCriterionField`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AdGroupCriterionField[]`	`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
  - AdGroupId
```
public static final AdGroupCriterionField AdGroupId
```
    The ad group this criterion is in.
  - AgeRangeType
```
public static final AdGroupCriterionField AgeRangeType
```
  - AppId
```
public static final AdGroupCriterionField AppId
```
    A string that uniquely identifies a mobile application to AdWords API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). A well formed app id for AdWords API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android.
  - AppPaymentModelType
```
public static final AdGroupCriterionField AppPaymentModelType
```
  - ApprovalStatus
```
public static final AdGroupCriterionField ApprovalStatus
```
    Approval status.
  - BaseAdGroupId
```
public static final AdGroupCriterionField BaseAdGroupId
```
    ID of the base ad group from which this draft/trial ad group criterion was created. For base ad groups this is equal to the ad group ID. If the ad group was created in the draft or trial and has no corresponding base ad group, this field is null. This field is only returned on get requests.
  - BaseCampaignId
```
public static final AdGroupCriterionField BaseCampaignId
```
    ID of the base campaign from which this draft/trial ad group criterion was created. This field is only returned on get requests.
  - BidModifier
```
public static final AdGroupCriterionField BidModifier
```
    Bid modifier of the criterion which is used when the criterion is not in an absolute bidding dimension.
  - BiddingStrategyId
```
public static final AdGroupCriterionField 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 AdGroupCriterionField BiddingStrategyName
```
    Name of the bidding strategy. This is applicable only for flexible bidding strategies.
  - BiddingStrategySource
```
public static final AdGroupCriterionField BiddingStrategySource
```
    Indicates where the bidding strategy is associated i.e. campaign, ad group or ad group criterion.
  - BiddingStrategyType
```
public static final AdGroupCriterionField 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.
  - CaseValue
```
public static final AdGroupCriterionField CaseValue
```
    Dimension value with which this product partition is refining its parent. Undefined for the root partition.
  - ChannelId
```
public static final AdGroupCriterionField ChannelId
```
    The YouTube uploader channel id or the channel code of a YouTube content channel.
    The uploader channel id can be obtained from the YouTube id-based URL. For example, in https://www.youtube.com/channel/UCEN58iXQg82TXgsDCjWqIkg the channel id is UCEN58iXQg82TXgsDCjWqIkg
    For more information see: https://support.google.com/youtube/answer/6180214
  - ChannelName
```
public static final AdGroupCriterionField ChannelName
```
    The public name for a YouTube user channel.
  - CpcBid
```
public static final AdGroupCriterionField 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.
  - CpcBidSource
```
public static final AdGroupCriterionField CpcBidSource
```
    The level (ad group or criterion) at which the bid was set. This is applicable only at the criteria level.
  - CpmBid
```
public static final AdGroupCriterionField CpmBid
```
    Max CPM (cost per thousand impressions) bid.
  - CpmBidSource
```
public static final AdGroupCriterionField CpmBidSource
```
    The level (ad group or criterion) at which the bid was set. This is applicable only at the criteria level.
  - CriteriaCoverage
```
public static final AdGroupCriterionField CriteriaCoverage
```
    Keywordless criteria coverage - Computed percentage of website coverage based on the website target, negative website targets and negative keywords in the ad group and campaign.
  - CriteriaSamples
```
public static final AdGroupCriterionField CriteriaSamples
```
    Keywordless criteria samples - List of sample urls that matches with the website target.
  - CriteriaType
```
public static final AdGroupCriterionField CriteriaType
```
  - CriterionUse
```
public static final AdGroupCriterionField CriterionUse
```
  - DestinationUrl
```
public static final AdGroupCriterionField DestinationUrl
```
    Destination URL override when Ad is triggered by this criterion.
    Some sample valid URLs are: "http://www.website.com", "http://www.domain.com/somepath".
    Set to the empty string ("") to clear the destination URL.
  - DisapprovalReasons
```
public static final AdGroupCriterionField DisapprovalReasons
```
    List of disapproval reasons.
  - DisplayName
```
public static final AdGroupCriterionField DisplayName
```
    Title of this mobile application.
  - EnhancedCpcEnabled
```
public static final AdGroupCriterionField 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.
  - FinalAppUrls
```
public static final AdGroupCriterionField FinalAppUrls
```
    A list of final app URLs that will be used on mobile if the user has the specific app installed.
  - FinalMobileUrls
```
public static final AdGroupCriterionField FinalMobileUrls
```
    A list of possible final mobile URLs after all cross domain redirects.
  - FinalUrls
```
public static final AdGroupCriterionField FinalUrls
```
    A list of possible final URLs after all cross domain redirects.
  - FirstPageCpc
```
public static final AdGroupCriterionField FirstPageCpc
```
    First page Cpc for this criterion.
  - FirstPositionCpc
```
public static final AdGroupCriterionField FirstPositionCpc
```
    An estimate of the cpc bid needed for your ad to regularly appear in the top position above the search results on google.com when a query matches the keywords exactly. Note that meeting this estimate is not a guarantee of ad position, which may depend on other factors.
  - GenderType
```
public static final AdGroupCriterionField GenderType
```
  - Id
```
public static final AdGroupCriterionField Id
```
    ID of this criterion.
  - IncomeRangeType
```
public static final AdGroupCriterionField IncomeRangeType
```
  - KeywordMatchType
```
public static final AdGroupCriterionField KeywordMatchType
```
    Match type of this keyword.
  - KeywordText
```
public static final AdGroupCriterionField KeywordText
```
    Text of this keyword (at most 80 characters and ten words).
  - Labels
```
public static final AdGroupCriterionField Labels
```
    Labels that are attached to the AdGroupCriterion. To associate an existing Label to an existing AdGroupCriterion, use AdGroupCriterionService#mutateLabel with ADD operator. To remove an associated Label from the AdGroupCriterion, use AdGroupCriterionService#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.
  - MobileAppCategoryId
```
public static final AdGroupCriterionField MobileAppCategoryId
```
    ID of this mobile app category. A complete list of the available mobile app categories is available here.
  - Parameter
```
public static final AdGroupCriterionField Parameter
```
    The webpage criterion parameter.
  - ParentCriterionId
```
public static final AdGroupCriterionField ParentCriterionId
```
    ID of the parent product partition subdivision. Undefined for the root partition.
  - ParentType
```
public static final AdGroupCriterionField ParentType
```
  - PartitionType
```
public static final AdGroupCriterionField PartitionType
```
    Type of the product partition.
  - Path
```
public static final AdGroupCriterionField Path
```
    The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. A complete list of available vertical categories is available here This field is required and must not be empty.
  - PlacementUrl
```
public static final AdGroupCriterionField PlacementUrl
```
    Url of the placement.
    For example, "http://www.domain.com".
  - QualityScore
```
public static final AdGroupCriterionField QualityScore
```
    The keyword quality score ranges from 1 (lowest) to 10 (highest).
    If there aren't enough impressions or clicks to determine an appropriate quality score value, the QualityInfo object is not returned. For reports, this field will return null (designated by "--").
  - Status
```
public static final AdGroupCriterionField Status
```
    Current user-set state of criterion. UserStatus may not be set to REMOVED and is not supported for ProductPartition criterion. On add, defaults to ENABLED if unspecified.
  - SystemServingStatus
```
public static final AdGroupCriterionField SystemServingStatus
```
    Serving status.
  - TargetSpendEnhancedCpcEnabled
```
public static final AdGroupCriterionField 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.
  - TopOfPageCpc
```
public static final AdGroupCriterionField TopOfPageCpc
```
    An estimate of the cpc bid needed for your ad to appear above the first page of Google search results when a query matches the keywords exactly. Note that meeting this estimate is not a guarantee of ad position, which may depend on other factors.
  - TrackingUrlTemplate
```
public static final AdGroupCriterionField TrackingUrlTemplate
```
    URL template for constructing a tracking URL.
    On update, empty string ("") indicates to clear the field.
  - UrlCustomParameters
```
public static final AdGroupCriterionField UrlCustomParameters
```
    A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.
  - UserInterestId
```
public static final AdGroupCriterionField UserInterestId
```
    Id of this user interest. This is a required field.
  - UserInterestName
```
public static final AdGroupCriterionField UserInterestName
```
    Name of this user interest.
  - UserInterestParentId
```
public static final AdGroupCriterionField UserInterestParentId
```
    Parent Id of this user interest.
  - UserListEligibleForDisplay
```
public static final AdGroupCriterionField UserListEligibleForDisplay
```
    Determines whether a user list is eligible for targeting in the display network.
  - UserListEligibleForSearch
```
public static final AdGroupCriterionField UserListEligibleForSearch
```
    Determines whether a user list is eligible for targeting in the google.com (search) network.
  - UserListId
```
public static final AdGroupCriterionField UserListId
```
    Id of this user list. This is a required field.
  - UserListMembershipStatus
```
public static final AdGroupCriterionField UserListMembershipStatus
```
  - UserListName
```
public static final AdGroupCriterionField UserListName
```
  - VerticalId
```
public static final AdGroupCriterionField VerticalId
```
    Id of this vertical.
  - VerticalParentId
```
public static final AdGroupCriterionField VerticalParentId
```
    Id of the parent of this vertical.
  - VideoId
```
public static final AdGroupCriterionField VideoId
```
    YouTube video id as it appears on the YouTube watch page.
  - VideoName
```
public static final AdGroupCriterionField VideoName
```
    Name of the video.
- Method Detail
  - values
```
public static AdGroupCriterionField[] 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 (AdGroupCriterionField c : AdGroupCriterionField.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AdGroupCriterionField 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 AdGroupCriterionField

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

AdGroupId

AgeRangeType

AppId

AppPaymentModelType

ApprovalStatus

BaseAdGroupId

BaseCampaignId

BidModifier

BiddingStrategyId

BiddingStrategyName

BiddingStrategySource

BiddingStrategyType

CaseValue

ChannelId

ChannelName

CpcBid

CpcBidSource

CpmBid

CpmBidSource

CriteriaCoverage

CriteriaSamples

CriteriaType

CriterionUse

DestinationUrl

DisapprovalReasons

DisplayName

EnhancedCpcEnabled

FinalAppUrls

FinalMobileUrls

FinalUrls

FirstPageCpc

FirstPositionCpc

GenderType

Id

IncomeRangeType

KeywordMatchType

KeywordText

Labels

MobileAppCategoryId

Parameter

ParentCriterionId

ParentType

PartitionType

Path

PlacementUrl

QualityScore

Status

SystemServingStatus

TargetSpendEnhancedCpcEnabled

TopOfPageCpc

TrackingUrlTemplate

UrlCustomParameters

UserInterestId

UserInterestName

UserInterestParentId

UserListEligibleForDisplay

UserListEligibleForSearch

UserListId

UserListMembershipStatus

UserListName

VerticalId

VerticalParentId

VideoId

VideoName

Method Detail

values

valueOf

isFilterable