Sets a custom date range onto the selector.
Sets a custom date range onto the selector. 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")
sets the range of one day.
Date range must be specified if the selector has conditions or ordering for a stat field. Note that only the last date range specified for the selector will take effect.
Fetches the requested budgets and returns an iterator.
Returns the campaign to which this location belongs.
Returns the campaign to which this location belongs.
Returns the country code of this location.
Returns the country code of this location.
This is the standard two-letter country code, e.g. "US"
or "BR"
.
Returns the type of this entity as a
String
.
Returns the type of this entity as a
String
.
Returns the ID of the location.
Returns the ID of the location.
Location IDs are shared across campaigns. In order to uniquely identify a location exclusion, one must specify both its campaign ID and the location ID.
Returns the name of this location.
Returns the name of this location.
Returns stats for the specified custom date range.
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.
Returns the target type of this location.
Returns the target type of this location.
The target type is a generic description of the location, such as "City"
, "Postal Code"
, or "Country"
. For a full list of target types, see the AdWords API documentation on geotargeting.
Returns the targeting status of this location.
Returns the targeting status of this location.
This can return one of three values:
"ACTIVE"
: indicates that the location can be targeted as normal. The vast majority of locations are active."PHASING_OUT"
: indicates that the location can be targeted, but that support will soon be removed. To get a list of which locations are phasing out, please see the AdWords API documentation on geotargeting."OBSOLETE"
: indicates that the location cannot be targeted.Specifies the ordering of the resulting entities.
Specifies the ordering of the resulting entities.
orderBy
parameter can have one of the following forms:
orderBy("Cost")
- orders results by Cost, in ascending order.orderBy("Ctr ASC")
- orders results by Ctr, in ascending order.orderBy("MaxCpc DESC")
- orders results by MaxCpc, in descending order.See withCondition(String) for enumeration of columns that can be used.
orderBy()
may be called multiple times. Consider the following example:
selector = selector.forDateRange("LAST_14_DAYS") .orderBy("Clicks DESC") .orderBy("CTR ASC");
The results will be ordered by Clicks in descending order. Results with equal Clicks value will be ordered by Ctr in ascending order.
If a stats column is used in the ordering, date range must be specified via forDateRange(String) or forDateRange(Object, Object).
LabelNames
column cannot be used for ordering.
Removes the location.
Removes the location.
Returns nothing.
Restricts this selector to return only budgets with the given budget IDs.
Restricts this selector to return only budgets with the given budget IDs.
var budgetIds = [12345, 23456, 34567]; selector = selector.withIds(budgetIds);
The resulting selector can be further refined by applying additional conditions to it. The ID-based condition will then be AND-ed together with all the other conditions, including any other ID-based conditions. So, for instance, the following selector:
AdWordsApp.budgets() .withIds([12345, 23456, 34567]) .withIds([34567, 45678, 56789]);will only get the budget with ID
34567
, since it would be the only budget that satisfies both ID conditions.The selector can only support up to 10,000 IDs. If more than 10,000 IDs are specified, the corresponding get() call will fail with a runtime error.
Specifies limit for the selector to use.
Specifies limit for the selector to use. For instance,
withLimit(50)
returns only the first 50 entities.
Fetches budgets. Supports filtering and sorting.
Typical usage: