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

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

All Implemented Interfaces:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AdGroupId` ID of the ad group that contains the criterion with which this bid landscape is associated.
`Bid` The bid amount used to estimate this landscape point's data.
`BidModifier` The bid modifier value of this point.
`CampaignId`
`Category` Recommended category for the website domain.
`CategoryRank` The position of this category in the recommended set of categories.
`Coverage` Coverage is the number of docs that match a label / number of docs that match the immediate parent label.
`CriterionId` ID of the criterion associated with this landscape.
`DomainName` The domain for the website.
`EndDate` Last day on which this landscape is based.
`HasChild` Used to determine whether a category has sub-categories associated with it.
`IsoLanguage` The language for the website.
`LandscapeCurrent` Only applies to landscapes with `landscapeType == DEFAULT`.
`LandscapeType`
`LocalClicks` Estimated number of clicks at this bid.
`LocalCost` Estimated cost at this bid.
`LocalImpressions` Estimated number of impressions at this bid.
`PromotedImpressions` Estimated number of promoted impressions.
`RecommendedCpc` The recommended cost per click for the category.
`RequiredBudget` Required daily budget to achieve the predicted stats at this bid.
`StartDate` First day on which this landscape is based.
`TotalLocalClicks` Estimated total clicks for all devices in mobile bid modifier landscape.
`TotalLocalCost` Estimated total cost for all devices in mobile bid modifier landscape.
`TotalLocalImpressions` Estimated total impressions for all devices in mobile bid modifier landscape.
`TotalLocalPromotedImpressions` Estimated total promoted impressions for all devices in mobile bid modifier landscape.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isFilterable()` If the field is filterable.
`static DataField`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DataField[]`	`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 DataField AdGroupId
```
    ID of the ad group that contains the criterion with which this bid landscape is associated. Only available for ad group bid landscapes and ad group criterion bid landscapes.
  - Bid
```
public static final DataField Bid
```
    The bid amount used to estimate this landscape point's data. Only available for ad group bid landscapes and ad group criterion bid landscapes.
  - BidModifier
```
public static final DataField BidModifier
```
    The bid modifier value of this point. Only available for campaign criterion bid landscapes (versions >= v201603).
  - CampaignId
```
public static final DataField CampaignId
```
  - Category
```
public static final DataField Category
```
    Recommended category for the website domain.
  - CategoryRank
```
public static final DataField CategoryRank
```
    The position of this category in the recommended set of categories.
  - Coverage
```
public static final DataField Coverage
```
    Coverage is the number of docs that match a label / number of docs that match the immediate parent label.
    Example : united states/ca/sfo matches 500 docs and united states/ca matches 1000 docs. The coverage will be 50%.
  - CriterionId
```
public static final DataField CriterionId
```
    ID of the criterion associated with this landscape.
  - DomainName
```
public static final DataField DomainName
```
    The domain for the website. Since many different domains can have the same categories, the domain and the language are used to uniquely identify the categories.
    The domain can be specified in the DynamicSearchAdsSetting required for dynamic search ads.
  - EndDate
```
public static final DataField EndDate
```
    Last day on which this landscape is based.
  - HasChild
```
public static final DataField HasChild
```
    Used to determine whether a category has sub-categories associated with it.
  - IsoLanguage
```
public static final DataField IsoLanguage
```
    The language for the website. Since many different domains can have the same categories, the domain and the language are used to uniquely identify the categories.
    The language can be specified in the DynamicSearchAdsSetting required for dynamic search ads.
  - LandscapeCurrent
```
public static final DataField LandscapeCurrent
```
    Only applies to landscapes with landscapeType == DEFAULT. If true, then this bid landscape contains the set of ad group criteria that currently do not have criterion-level bid overrides. If false, then this bid landscape was derived from an earlier snapshot of ad group criteria, so it may contain criteria to which bid overrides were recently added, and may not contain criteria from which bid overrides were recently removed. For other landscapeTypes null is returned.
  - LandscapeType
```
public static final DataField LandscapeType
```
  - LocalClicks
```
public static final DataField LocalClicks
```
    Estimated number of clicks at this bid. For mobile bid modifier landscapes, this is the estimated number of clicks for mobile only.
  - LocalCost
```
public static final DataField LocalCost
```
    Estimated cost at this bid. For mobile bid modifier landscapes, this is the estimated cost for mobile only.
  - LocalImpressions
```
public static final DataField LocalImpressions
```
    Estimated number of impressions at this bid. For mobile bid modifier landscapes, this is the estimated number of impressions for mobile only.
  - PromotedImpressions
```
public static final DataField PromotedImpressions
```
    Estimated number of promoted impressions.
  - RecommendedCpc
```
public static final DataField RecommendedCpc
```
    The recommended cost per click for the category.
  - RequiredBudget
```
public static final DataField RequiredBudget
```
    Required daily budget to achieve the predicted stats at this bid. Only available for campaign criterion bid landscapes (versions >= v201603).
  - StartDate
```
public static final DataField StartDate
```
    First day on which this landscape is based. Typically, it could be up to a week ago.
  - TotalLocalClicks
```
public static final DataField TotalLocalClicks
```
    Estimated total clicks for all devices in mobile bid modifier landscape. Only available for campaign criterion bid landscapes (versions >= v201603).
  - TotalLocalCost
```
public static final DataField TotalLocalCost
```
    Estimated total cost for all devices in mobile bid modifier landscape. Only available for campaign criterion bid landscapes (versions >= v201603).
  - TotalLocalImpressions
```
public static final DataField TotalLocalImpressions
```
    Estimated total impressions for all devices in mobile bid modifier landscape. Only available for campaign criterion bid landscapes (versions >= v201603).
  - TotalLocalPromotedImpressions
```
public static final DataField TotalLocalPromotedImpressions
```
    Estimated total promoted impressions for all devices in mobile bid modifier landscape. Only available for campaign criterion bid landscapes (versions >= v201603).
- Method Detail
  - values
```
public static DataField[] 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 (DataField c : DataField.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DataField 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 DataField

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

Bid

BidModifier

CampaignId

Category

CategoryRank

Coverage

CriterionId

DomainName

EndDate

HasChild

IsoLanguage

LandscapeCurrent

LandscapeType

LocalClicks

LocalCost

LocalImpressions

PromotedImpressions

RecommendedCpc

RequiredBudget

StartDate

TotalLocalClicks

TotalLocalCost

TotalLocalImpressions

TotalLocalPromotedImpressions

Method Detail

values

valueOf

isFilterable