AdsApp.​TargetedLocation

Page Summary

outlined_flag

• A TargetedLocation represents a Google Ads targeted location used to show ads in specific geographic areas, which can range from entire countries to city levels.

• You can retrieve the bid modifier, campaign it belongs to, country code, ID, name, resource name, target type, and targeting status for a TargetedLocation.

• Stats for a TargetedLocation can be obtained for predefined date ranges or custom date ranges.

• A TargetedLocation can be removed.

• The bid modifier for a TargetedLocation can be set within a range of 0.1 to 10.

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.

For more information on locations, see the API documentation on geotargeting .

See also ExcludedLocation .

Methods:

getBidModifier()

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:

For more information about bid modifiers, please see the Google Ads Help Center article .

Return values:

getCampaign()

Return values:

getCampaignType()

SEARCH_OR_DISPLAY, VIDEO, SHOPPING

Return values:

getCountryCode()

This is the standard two-letter country code, e.g. "US" or "BR" .

Return values:

getEntityType()

Return values:

getId()

Location IDs are shared across campaigns. In order to uniquely identify a location target, one must specify both its campaign ID and the location ID.

Return values:

getName()

Return values:

getResourceName()

Return values:

getShoppingCampaign()

Return values:

getStatsFor(dateRange)

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 
  
 = 
  
 targetedLocation 
 . 
 getStatsFor 
 ( 
 "THIS_MONTH" 
 ); 

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

getTargetType()

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 Geo targets .

Return values:

getTargetingStatus()

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, see Geo targets .
• "OBSOLETE" : indicates that the location cannot be targeted.

Return values:

getVideoCampaign()

Return values:

remove()

Returns nothing.

setBidModifier(modifier)

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:

For more information about bid modifiers, please see the Google Ads Help Center article . For locations, acceptable bid modifiers are in the range 0.1 to 10 .

Returns nothing.

Arguments: