Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.BudgetOrder Class Reference

A budget order links an account-wide budget with a BillingAccount. More...

Classes

class  Fields
 List of all supported fields for the BudgetOrder class. More...
 
class  FilterableFields
 List of all supported filterable fields for the BudgetOrder class. More...
 
class  SelectableFields
 List of all supported selectable fields for the BudgetOrder class. More...
 

Properties

string billingAccountId [get, set]
 This must be passed as a string with dashes, e.g. "1234-5678-9012-3456". This field can be selected using the value "BillingAccountId".This field can be filtered on. More...
 
long id [get, set]
 This field can be selected using the value "Id".This field can be filtered on. This field is required and should not be More...
 
bool idSpecified [get, set]
 
string billingAccountName [get, set]
 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. This field can be selected using the value "BillingAccountName".This field can be filtered on. The length of this string should be between 0 and 80, inclusive, (trimmed). More...
 
string poNumber [get, set]
 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. This field can be selected using the value "PoNumber".This field can be filtered on. The length of this string should be between 0 and 80, inclusive, (trimmed). More...
 
string budgetOrderName [get, set]
 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. This field can be selected using the value "BudgetOrderName".This field can be filtered on. The length of this string should be between 0 and 150, inclusive, (trimmed). More...
 
string primaryBillingId [get, set]
 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". More...
 
string secondaryBillingId [get, set]
 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". This field can be selected using the value "SecondaryBillingId".This field can be filtered on. The length of this string should be between 0 and 14, inclusive, (trimmed). More...
 
Money spendingLimit [get, set]
 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. This field can be selected using the value "SpendingLimit".This field can be filtered on. This field is required and should not be More...
 
Money totalAdjustments [get, set]
 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. This field can be selected using the value "TotalAdjustments".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
string startDateTime [get, set]
 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. This field can be selected using the value "StartDateTime".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE. This field is required and should not be More...
 
string endDateTime [get, set]
 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. This field can be selected using the value "EndDateTime".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE. This field is required and should not be More...
 
BudgetOrderRequest lastRequest [get, set]
 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. This field can be selected using the value "LastRequest". This field is read only and will be ignored when sent to the API. More...
 

Detailed Description

A budget order links an account-wide budget with a BillingAccount.

Property Documentation

string Google.Api.Ads.AdWords.v201809.BudgetOrder.billingAccountId
getset

This must be passed as a string with dashes, e.g. "1234-5678-9012-3456". This field can be selected using the value "BillingAccountId".This field can be filtered on.

string Google.Api.Ads.AdWords.v201809.BudgetOrder.billingAccountName
getset

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. This field can be selected using the value "BillingAccountName".This field can be filtered on. The length of this string should be between 0 and 80, inclusive, (trimmed).

string Google.Api.Ads.AdWords.v201809.BudgetOrder.budgetOrderName
getset

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. This field can be selected using the value "BudgetOrderName".This field can be filtered on. The length of this string should be between 0 and 150, inclusive, (trimmed).

string Google.Api.Ads.AdWords.v201809.BudgetOrder.endDateTime
getset

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. This field can be selected using the value "EndDateTime".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE. This field is required and should not be

null when it is contained within Operators : ADD.

long Google.Api.Ads.AdWords.v201809.BudgetOrder.id
getset

This field can be selected using the value "Id".This field can be filtered on. This field is required and should not be

null when it is contained within Operators : SET, REMOVE.

bool Google.Api.Ads.AdWords.v201809.BudgetOrder.idSpecified
getset

true, if a value is specified for id, false otherwise.

BudgetOrderRequest Google.Api.Ads.AdWords.v201809.BudgetOrder.lastRequest
getset

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. This field can be selected using the value "LastRequest". This field is read only and will be ignored when sent to the API.

string Google.Api.Ads.AdWords.v201809.BudgetOrder.poNumber
getset

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. This field can be selected using the value "PoNumber".This field can be filtered on. The length of this string should be between 0 and 80, inclusive, (trimmed).

string Google.Api.Ads.AdWords.v201809.BudgetOrder.primaryBillingId
getset

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. This field can be selected using the value "PrimaryBillingId".This field can be filtered on. The length of this string should be between 0 and 14, inclusive, (trimmed).

string Google.Api.Ads.AdWords.v201809.BudgetOrder.secondaryBillingId
getset

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". This field can be selected using the value "SecondaryBillingId".This field can be filtered on. The length of this string should be between 0 and 14, inclusive, (trimmed).

Money Google.Api.Ads.AdWords.v201809.BudgetOrder.spendingLimit
getset

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. This field can be selected using the value "SpendingLimit".This field can be filtered on. This field is required and should not be

null when it is contained within Operators : ADD.

string Google.Api.Ads.AdWords.v201809.BudgetOrder.startDateTime
getset

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. This field can be selected using the value "StartDateTime".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE. This field is required and should not be

null when it is contained within Operators : ADD.

Money Google.Api.Ads.AdWords.v201809.BudgetOrder.totalAdjustments
getset

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. This field can be selected using the value "TotalAdjustments".This field can be filtered on. This field is read only and will be ignored when sent to the API.


The documentation for this class was generated from the following file: