com.google.api.ads.adwords.lib.selectorfields.v201710.cm

Enum BudgetField

java.lang.Object

java.lang.Enum<BudgetField>

com.google.api.ads.adwords.lib.selectorfields.v201710.cm.BudgetField

All Implemented Interfaces:

EntityField, Serializable, Comparable<BudgetField>

public enum BudgetField
extends Enum<BudgetField>
implements EntityField

A Enum to facilitate the selection of fields for Budget.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Amount Amount of budget in the local currency for the account.
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
DeliveryMethod Delivery method for the Budget which determines the rate at which the Budget is spent.
IsBudgetExplicitlyShared If true, this budget was created with the purpose of sharing this budget across one or more campaigns.

Method Summary

Modifier and Type	Method and Description
boolean	isFilterable() If the field is filterable.
static BudgetField	valueOf(String name) Returns the enum constant of this type with the specified name.
static BudgetField[]	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

Amount

public static final BudgetField Amount

Amount of budget in the local currency for the account.

BudgetId

public static final BudgetField 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 BudgetField 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 BudgetField BudgetReferenceCount

Number of campaigns actively using this budget. This field is only populated for Get operations.

BudgetStatus

public static final BudgetField BudgetStatus

DeliveryMethod

public static final BudgetField 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.

IsBudgetExplicitlyShared

public static final BudgetField 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.

Method Detail

values

public static BudgetField[] 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 (BudgetField c : BudgetField.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BudgetField 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.