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

Enum BudgetOrderField

java.lang.Object

java.lang.Enum<BudgetOrderField>

com.google.api.ads.adwords.lib.selectorfields.v201802.cm.BudgetOrderField

All Implemented Interfaces:

EntityField, Serializable, Comparable<BudgetOrderField>

public enum BudgetOrderField
extends Enum<BudgetOrderField>
implements EntityField

A Enum to facilitate the selection of fields for BudgetOrder.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BillingAccountId This must be passed as a string with dashes, e.g.
BillingAccountName Enables user to specify meaningful name for a billing account to aid in reconciling monthly invoices.
BudgetOrderName Enables user to specify meaningful name for referencing this budget order.
EndDateTime EndDateTime must be on or before "20361231 235959 America/Los_Angeles" or must set the same instant as "20371230 235959 America/Los_Angeles" to indicate infinite end date.
Id
LastRequest Contains fields that provide information on the last set of values that were passed in through the parent BudgetOrder for mutate.add and mutate.set.
PoNumber Enables user to enter a value that helps them reference this budget order in their monthly invoices.
PrimaryBillingId A 12 digit billing ID assigned to the user by Google.
SecondaryBillingId For certain users, a secondary billing ID will be required on mutate.add.
SpendingLimit The spending limit in micros.
StartDateTime StartDateTime cannot be in the past, it must be on or before "20361231 235959 America/Los_Angeles".
TotalAdjustments The adjustments amount in micros.

Method Summary

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

BillingAccountId

public static final BudgetOrderField BillingAccountId

This must be passed as a string with dashes, e.g. "1234-5678-9012-3456".

BillingAccountName

public static final BudgetOrderField BillingAccountName

Enables user to specify meaningful name for a billing account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices.

BudgetOrderName

public static final BudgetOrderField BudgetOrderName

Enables user to specify meaningful name for referencing this budget order. A default name will be provided if none is specified. This name will be printed in the monthly invoices.

EndDateTime

public static final BudgetOrderField EndDateTime

EndDateTime must be on or before "20361231 235959 America/Los_Angeles" or must set the same instant as "20371230 235959 America/Los_Angeles" to indicate infinite end date. StartDateTime and EndDateTime must use the same time zone.

Id

public static final BudgetOrderField Id

LastRequest

public static final BudgetOrderField LastRequest

Contains fields that provide information on the last set of values that were passed in through the parent BudgetOrder for mutate.add and mutate.set.

PoNumber

public static final BudgetOrderField PoNumber

Enables user to enter a value that helps them reference this budget order in their monthly invoices. This number will be printed in the monthly invoices.

PrimaryBillingId

public static final BudgetOrderField PrimaryBillingId

A 12 digit billing ID assigned to the user by Google. This must be passed in as a string with dashes, e.g. "1234-5678-9012".

This field is required in an ADD operation if billingAccountId is not specified.

Note:Starting with v201708, this field is required in any ADD operation that sets or changes the billing account of a client account.

SecondaryBillingId

public static final BudgetOrderField SecondaryBillingId

For certain users, a secondary billing ID will be required on mutate.add. If this requirement was not communicated to the user, the user may ignore this parameter. If specified, this must be passed in as a string with dashes, e.g. "1234-5678-9012".

SpendingLimit

public static final BudgetOrderField SpendingLimit

The spending limit in micros. To specify an unlimited budget, set spendingLimit to -1, otherwise spendingLimit must be greater than 0. Note that for get requests, the spending limit includes any adjustments that have been applied to the budget order. For mutate, the spending limit represents the maximum allowed spend prior to considering any adjustments. When making mutate requests, make sure to account for any adjustments that may be reported in the get value of the spending limit.

StartDateTime

public static final BudgetOrderField StartDateTime

StartDateTime cannot be in the past, it must be on or before "20361231 235959 America/Los_Angeles". StartDateTime and EndDateTime must use the same time zone.

TotalAdjustments

public static final BudgetOrderField TotalAdjustments

The adjustments amount in micros. Adjustments from Google come in the form of credits or debits to your budget order. This amount is the net sum of adjustments since the creation of the budget order. You can use the adjustments amount to compute your current base spendingLimit by subtracting your adjustments from the value returned from spendingLimit in get requests.

Method Detail

values

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

Returns:

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

valueOf

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