AdWordsApp.​Budget

Represents an AdWords budget. Budgets are used for managing the amount of money spent on AdWords. Budgets may be shared among a number of campaigns; use Budget.campaigns() to find the campaigns that are using the budget. For more information on Shared Budgets, please see AdWords API article.

Methods:

MemberTypeDescription
campaigns AdWordsApp.CampaignSelector Returns the selector of all campaigns that share this budget.
getAmount double Returns the amount of the budget, in the currency of the account.
getDeliveryMethod String Returns the delivery method of the budget.
getEntityType String Returns the type of this entity as a String, in this case, "Budget".
getId long Returns the ID of the budget.
getName String Returns the name of the budget.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isExplicitlyShared boolean Returns true if the budget is explicitly shared, and false otherwise.
setAmount void Sets the budget's amount to the specified value, in the currency of the account.

campaigns()

Returns the selector of all campaigns that share this budget.

Return values:

TypeDescription
AdWordsApp.CampaignSelector Selector of all campaigns that share this budget.

getAmount()

Returns the amount of the budget, in the currency of the account.

Return values:

TypeDescription
double Amount of the budget.

getDeliveryMethod()

Returns the delivery method of the budget. Possible return values:

STANDARD, ACCELERATED

.

Return values:

TypeDescription
String Delivery method of the budget.

getEntityType()

Returns the type of this entity as a String, in this case, "Budget".

Return values:

TypeDescription
String Type of this entity: "Budget".

getId()

Returns the ID of the budget.

Return values:

TypeDescription
long The ID of the budget.

getName()

Returns the name of the budget. Every budget must have a non-empty name; all budget names in an account are distinct.

Return values:

TypeDescription
String Name of the budget.

getStatsFor(dateRange)

Returns stats for the specified date range. Supported values:

TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME.

Example:
 var stats = budget.getStatsFor("THIS_MONTH");

Arguments:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
AdWordsApp.Stats The stats for the specified date range.

getStatsFor(dateFrom, dateTo)

Returns stats for the specified custom date range. Both parameters can be either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD form. For instance, March 24th, 2013 is represented as either {year: 2013, month: 3, day: 24} or "20130324". The date range is inclusive on both ends, so forDateRange("20130324", "20130324") defines a range of a single day.

Arguments:

NameTypeDescription
dateFrom Object Start date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.
dateTo Object End date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.

Return values:

TypeDescription
AdWordsApp.Stats The stats for the specified date range.

isExplicitlyShared()

Returns true if the budget is explicitly shared, and false otherwise.
  • If true, this budget was created through the BudgetService or through the UI shared library with the purpose of sharing this budgets across one or more campaigns.
  • If false, this budget was created with the intention to be used with a single campaign, and the Budget's name will stay in the sync with the associated Campaign's name.

Return values:

TypeDescription
boolean true if the budget is explicitly shared.

setAmount(amount)

Sets the budget's amount to the specified value, in the currency of the account.

Returns nothing.

Arguments:

NameTypeDescription
amount double The amount of the budget.

Feedback geben zu...

AdWords Scripts
AdWords Scripts