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

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

All Implemented Interfaces:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AdServingOptimizationStatus` Ad serving optimization status.
`AdvertisingChannelSubType` Optional refinement of advertisingChannelType.
`AdvertisingChannelType` The primary serving target for ads within this campaign.
`Amount` Amount of budget in the local currency for the account.
`BaseCampaignId` ID of the base campaign of the draft or trial campaign.
`BiddingStrategyId` Id of the bidding strategy to be associated with the campaign, ad group or ad group criteria.
`BiddingStrategyName` Name of the bidding strategy.
`BiddingStrategyType` The type of the bidding strategy to be attached.
`BudgetId` A Budget is created using the BudgetService ADD operation and is assigned a BudgetId.
`BudgetName` Name of the Budget.
`BudgetReferenceCount` Number of campaigns actively using this budget.
`BudgetStatus`
`CampaignGroupId` Id of the campaign group this campaign belongs to.
`CampaignTrialType` Indicates if this campaign is a normal campaign, a draft campaign, or a trial campaign.
`DeliveryMethod` Delivery method for the Budget which determines the rate at which the Budget is spent.
`Eligible` If the campaign is eligible to enter conversion optimizer.
`EndDate` Date the campaign ends.
`EnhancedCpcEnabled` The enhanced CPC bidding option for the campaign, which enables bids to be enhanced based on conversion optimizer data.
`FrequencyCapMaxImpressions` Maximum number of impressions allowed during the time range by this cap.
`Id` ID of this campaign.
`IsBudgetExplicitlyShared` If true, this budget was created with the purpose of sharing this budget across one or more campaigns.
`Labels` Labels that are attached to the campaign.
`Level` The level on which the cap is to be applied (creative/adgroup).
`Name` Name of this campaign.
`RejectionReasons` Reason why a campaign would be rejected for conversion optimizer.
`SelectiveOptimization` Selective optimization setting for this campaign, which includes a set of conversion types to optimize this campaign towards.
`ServingStatus` Serving status.
`Settings` List of settings for the campaign.
`StartDate` Date the campaign begins.
`Status` Status of this campaign.
`TargetContentNetwork` Ads will be served on specified placements in the Google Display Network.
`TargetCpa` Average cost per acquisition (CPA) target.
`TargetCpaMaxCpcBidCeiling` Maximum cpc bid limit that applies to all keywords managed by the strategy.
`TargetCpaMaxCpcBidFloor` Minimum cpc bid limit that applies to all keywords managed by the strategy.
`TargetGoogleSearch` Ads will be served with Google.com search results.
`TargetPartnerSearchNetwork` Ads will be served on the Google Partner Network.
`TargetRoas` The target return on average spend (ROAS).
`TargetRoasBidCeiling` Maximum bid limit that applies to all keywords managed by the strategy.
`TargetRoasBidFloor` Minimum bid limit that applies to all keywords managed by the strategy.
`TargetSearchNetwork` Ads will be served on partner sites in the Google Search Network (requires `GOOGLE_SEARCH`).
`TargetSpendBidCeiling` The largest max CPC bid that can be set by the TargetSpend bidder.
`TargetSpendEnhancedCpcEnabled` The enhanced CPC bidding option for the campaign, which enables CPC bids to be enhanced based on conversion optimizer data.
`TargetSpendSpendTarget` A spend target under which to maximize clicks.
`TimeUnit` Unit of time the cap is defined at.
`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.
`VanityPharmaDisplayUrlMode` The display mode for vanity pharma URLs.
`VanityPharmaText` The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isFilterable()` If the field is filterable.
`static CampaignField`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CampaignField[]`	`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
  - AdServingOptimizationStatus
```
public static final CampaignField AdServingOptimizationStatus
```
    Ad serving optimization status.
  - AdvertisingChannelSubType
```
public static final CampaignField AdvertisingChannelSubType
```
    Optional refinement of advertisingChannelType. Must be a valid sub-type of the parent channel type. May only be set for new campaigns and cannot be changed once set.
  - AdvertisingChannelType
```
public static final CampaignField AdvertisingChannelType
```
    The primary serving target for ads within this campaign. The targeting options can be refined in NetworkSetting. May only be set for new campaigns. This field is required and should not be null when it is contained within Operators : ADD
  - Amount
```
public static final CampaignField Amount
```
    Amount of budget in the local currency for the account.
  - BaseCampaignId
```
public static final CampaignField BaseCampaignId
```
    ID of the base campaign of the draft or trial campaign. For base campaigns, this is equal to the campaign ID. This field is only returned on get requests.
  - BiddingStrategyId
```
public static final CampaignField 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 CampaignField BiddingStrategyName
```
    Name of the bidding strategy. This is applicable only for flexible bidding strategies.
  - BiddingStrategyType
```
public static final CampaignField 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.
  - BudgetId
```
public static final CampaignField BudgetId
```
    A Budget is created using the BudgetService ADD operation and is assigned a BudgetId. The BudgetId is used when modifying the Budget with BudgetService, or associating the Budget to a Campaign with CampaignService. A BudgetId can be shared across different campaigns--the system will then allocate the Budget among the Campaigns to get the optimum result.
  - BudgetName
```
public static final CampaignField BudgetName
```
    Name of the Budget. When creating a Budget through BudgetService, every explicitly shared Budget must have a non-null non-empty name. In addition, all explicitly shared Budget names owned by an account must be distinct. Budgets that are not explicitly shared derive their name from the attached Campaign's name.
  - BudgetReferenceCount
```
public static final CampaignField BudgetReferenceCount
```
    Number of campaigns actively using this budget. This field is only populated for Get operations.
  - BudgetStatus
```
public static final CampaignField BudgetStatus
```
  - CampaignGroupId
```
public static final CampaignField CampaignGroupId
```
    Id of the campaign group this campaign belongs to.
  - CampaignTrialType
```
public static final CampaignField CampaignTrialType
```
    Indicates if this campaign is a normal campaign, a draft campaign, or a trial campaign.
  - DeliveryMethod
```
public static final CampaignField DeliveryMethod
```
    Delivery method for the Budget which determines the rate at which the Budget is spent. Defaults to STANDARD and can be changed through BudgetService ADD or SET operations.
  - Eligible
```
public static final CampaignField Eligible
```
    If the campaign is eligible to enter conversion optimizer.
  - EndDate
```
public static final CampaignField EndDate
```
    Date the campaign ends. On add, defaults to 20371230, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 20371230. The date's format should be YYYYMMDD.
  - EnhancedCpcEnabled
```
public static final CampaignField 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.
  - FrequencyCapMaxImpressions
```
public static final CampaignField FrequencyCapMaxImpressions
```
    Maximum number of impressions allowed during the time range by this cap. To remove the frequency cap on a campaign, set this field to 0.
  - Id
```
public static final CampaignField Id
```
    ID of this campaign.
  - IsBudgetExplicitlyShared
```
public static final CampaignField IsBudgetExplicitlyShared
```
    If true, this budget was created with the purpose of sharing this budget across one or more campaigns.
    If false, this budget was created with the intention to be dedicatedly used with a single campaign, and the Budget's name and status will stay in the sync with the associated Campaign's name and status. Attempting to share this budget with a second Campaign will result in an error.
  - Labels
```
public static final CampaignField Labels
```
    Labels that are attached to the campaign. To associate an existing Label to an existing Campaign, use CampaignService#mutateLabel with the ADD operator. To remove an associated Label from the Campaign, use CampaignService#mutateLabel with the 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.
  - Level
```
public static final CampaignField Level
```
    The level on which the cap is to be applied (creative/adgroup). Cap is applied to all the entities of this level in the campaign.
  - Name
```
public static final CampaignField Name
```
    Name of this campaign. This field is required and should not be null for ADD operations. For SET and REMOVE operations, this can be used to address the campaign by name when the campaign is ENABLED or PAUSED. Removed campaigns cannot be addressed by name. If you wish to rename a campaign, you must provide the ID.
  - RejectionReasons
```
public static final CampaignField RejectionReasons
```
    Reason why a campaign would be rejected for conversion optimizer.
  - SelectiveOptimization
```
public static final CampaignField SelectiveOptimization
```
    Selective optimization setting for this campaign, which includes a set of conversion types to optimize this campaign towards.
  - ServingStatus
```
public static final CampaignField ServingStatus
```
    Serving status.
  - Settings
```
public static final CampaignField Settings
```
    List of settings for the campaign.
  - StartDate
```
public static final CampaignField StartDate
```
    Date the campaign begins. On add, defaults to the current day in the parent account's local timezone. The date's format should be YYYYMMDD.
  - Status
```
public static final CampaignField Status
```
    Status of this campaign. On add, defaults to ENABLED.
  - TargetContentNetwork
```
public static final CampaignField TargetContentNetwork
```
    Ads will be served on specified placements in the Google Display Network. Placements are specified using Placement criteria.
  - TargetCpa
```
public static final CampaignField 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.
  - TargetCpaMaxCpcBidCeiling
```
public static final CampaignField TargetCpaMaxCpcBidCeiling
```
    Maximum cpc bid limit that applies to all keywords managed by the strategy.
  - TargetCpaMaxCpcBidFloor
```
public static final CampaignField TargetCpaMaxCpcBidFloor
```
    Minimum cpc bid limit that applies to all keywords managed by the strategy.
  - TargetGoogleSearch
```
public static final CampaignField TargetGoogleSearch
```
    Ads will be served with Google.com search results.
  - TargetPartnerSearchNetwork
```
public static final CampaignField TargetPartnerSearchNetwork
```
    Ads will be served on the Google Partner Network. This is available to only some specific Google partner accounts.
  - TargetRoas
```
public static final CampaignField TargetRoas
```
    The target return on average spend (ROAS).
  - TargetRoasBidCeiling
```
public static final CampaignField TargetRoasBidCeiling
```
    Maximum bid limit that applies to all keywords managed by the strategy.
  - TargetRoasBidFloor
```
public static final CampaignField TargetRoasBidFloor
```
    Minimum bid limit that applies to all keywords managed by the strategy.
  - TargetSearchNetwork
```
public static final CampaignField TargetSearchNetwork
```
    Ads will be served on partner sites in the Google Search Network (requires GOOGLE_SEARCH).
  - TargetSpendBidCeiling
```
public static final CampaignField TargetSpendBidCeiling
```
    The largest max CPC bid that can be set by the TargetSpend bidder.
  - TargetSpendEnhancedCpcEnabled
```
public static final CampaignField 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.
  - TargetSpendSpendTarget
```
public static final CampaignField TargetSpendSpendTarget
```
    A spend target under which to maximize clicks. The TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target.
  - TimeUnit
```
public static final CampaignField TimeUnit
```
    Unit of time the cap is defined at. Only the Day, Week and Month time units are supported.
  - TrackingUrlTemplate
```
public static final CampaignField TrackingUrlTemplate
```
    URL template for constructing a tracking URL.
    On update, empty string ("") indicates to clear the field.
  - UrlCustomParameters
```
public static final CampaignField UrlCustomParameters
```
    A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.
  - VanityPharmaDisplayUrlMode
```
public static final CampaignField VanityPharmaDisplayUrlMode
```
    The display mode for vanity pharma URLs.
  - VanityPharmaText
```
public static final CampaignField VanityPharmaText
```
    The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.
- Method Detail
  - values
```
public static CampaignField[] 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 (CampaignField c : CampaignField.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CampaignField 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 CampaignField

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

AdServingOptimizationStatus

AdvertisingChannelSubType

AdvertisingChannelType

Amount

BaseCampaignId

BiddingStrategyId

BiddingStrategyName

BiddingStrategyType

BudgetId

BudgetName

BudgetReferenceCount

BudgetStatus

CampaignGroupId

CampaignTrialType

DeliveryMethod

Eligible

EndDate

EnhancedCpcEnabled

FrequencyCapMaxImpressions

Id

IsBudgetExplicitlyShared

Labels

Level

Name

RejectionReasons

SelectiveOptimization

ServingStatus

Settings

StartDate

Status

TargetContentNetwork

TargetCpa

TargetCpaMaxCpcBidCeiling

TargetCpaMaxCpcBidFloor

TargetGoogleSearch

TargetPartnerSearchNetwork

TargetRoas

TargetRoasBidCeiling

TargetRoasBidFloor

TargetSearchNetwork

TargetSpendBidCeiling

TargetSpendEnhancedCpcEnabled

TargetSpendSpendTarget

TimeUnit

TrackingUrlTemplate

UrlCustomParameters

VanityPharmaDisplayUrlMode

VanityPharmaText

Method Detail

values

valueOf

isFilterable