AdWordsApp.​TargetedLocation

Represents an AdWords targeted location.

Targeted locations are used to only show your ads in specific geographic areas. For instance,
a broadly-targeted campaign might have location targets for an entire country, whereas a
more specifically-targeted campaign might break down its location targets at the city level.

getBidModifier()

Returns the bid modifier for this targeted location.

The bid modifier is a multiplier applied to bids which match this
targeted location. So, for instance, a bid modifier of 1.1 increases the bid to
110% of its original value, and changes a bid of $5.00 to a bid of $5.50.

The bid modifiers for all matching criteria are multiplied together to calculate the
actual bid modification. A campaign with the following bid modifiers:

Type

Value

Bid Modifier

Location

Laos

1.3

Ad Schedule

Saturday 6AM-10AM

0.9

Platform

Mobile

1.1

would have a combined bid modifier of 1.3 * 0.9 * 1.1 = 1.287, so a bid of $10 would
get increased to $12.87 for clicks by Laotian smartphone users on Saturday mornings in the
account timezone.

Arguments:

Return values:

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:

Name

Type

Description

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:

getTargetingStatus()

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.

getVideoCampaign()

Return values:

remove()

Removes the targeted location.

Returns nothing.

setBidModifier(modifier)

Sets the bid modifier for this targeted location.

The bid modifier is a multiplier applied to bids which match this
targeted location. So, for instance, a bid modifier of 1.1 increases the bid to
110% of its original value, and changes a bid of $5.00 to a bid of $5.50.

The bid modifiers for all matching criteria are multiplied together to calculate the
actual bid modification. A campaign with the following bid modifiers:

Type

Value

Bid Modifier

Location

Laos

1.3

Ad Schedule

Saturday 6AM-10AM

0.9

Platform

Mobile

1.1

would have a combined bid modifier of 1.3 * 0.9 * 1.1 = 1.287, so a bid of $10 would
get increased to $12.87 for clicks by Laotian smartphone users on Saturday mornings in the
account timezone.