To discuss and provide feedback on our products, join the official Google Ads Discord channel in the Google Advertising and Measurement Community server.

AdsApp.TargetedProximity

AI-generated Key Takeaways

Represents a radius around a geographical point for Google Ads targeting.
Allows for bid adjustments based on proximity to the specified location.
Provides methods to retrieve information like address, radius, and campaign details.
Can be used to get performance statistics for the targeted proximity.
Offers functionality to modify or remove the targeted proximity.

Represents a Google Ads targeted proximity — some radius around a geographical point.

Methods:

Member	Type	Description
getAddress()	`AdsApp.Address`	Returns the address of the central point, or `null` if unknown.
getBaseCampaign()	`AdsApp.Campaign`	Returns the base campaign to which this targeted proximity belongs.
getBidModifier()	`double`	Returns the bid modifier for this targeted proximity.
getCampaign()	`AdsApp.Campaign`	Returns the campaign to which this targeted proximity belongs or `null` if it does not belong to a search or display campaign.
getCampaignType()	`String`	Returns the campaign type.
getEntityType()	`String`	Returns the type of this entity as a `String`, in this case, `"TargetedProximity"`.
getId()	`String`	Returns the ID of the targeted proximity.
getLatitude()	`double`	Returns the latitude in degrees of the central point of this proximity.
getLongitude()	`double`	Returns the longitude in degrees of the central point of this proximity.
getRadius()	`double`	Returns the radius around the central point to target.
getRadiusUnits()	`String`	Returns the units of TargetedProximity.getRadius().
getResourceName()	`String`	Returns the resource name of the targeted proximity.
getShoppingCampaign()	`AdsApp.ShoppingCampaign`	Returns the shopping campaign to which this targeted proximity belongs or `null` if it does not belong to a shopping campaign.
getStatsFor(dateRange)	`AdsApp.Stats`	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	`AdsApp.Stats`	Returns stats for the specified custom date range.
getVideoCampaign()	`AdsApp.VideoCampaign`	Returns the video campaign to which this targeted proximity belongs or `null` if it does not belong to a video campaign.
remove()	`void`	Removes the targeted proximity.
setBidModifier(modifier)	`void`	Sets the bid modifier for this targeted proximity.

`getAddress()`

Returns the address of the central point, or null if unknown.

Return values:

Type	Description
`AdsApp.Address`	The address of the central point, or `null` if unknown.

`getBaseCampaign()`

Returns the base campaign to which this targeted proximity belongs.

Return values:

Type	Description
`AdsApp.Campaign`	The base campaign to which this targeted proximity belongs.

`getBidModifier()`

Returns the bid modifier for this targeted proximity.

The bid modifier is a multiplier applied to bids which match this targeted proximity. 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 metrics.clicks by Laotian smartphone users on Saturday mornings in the account timezone.

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

Return values:

Type	Description
`double`	The criterion bid modifier.

`getCampaign()`

Returns the campaign to which this targeted proximity belongs or null if it does not belong to a search or display campaign.

Return values:

Type	Description
`AdsApp.Campaign`	The campaign to which this targeted proximity belongs or `null` if it does not belong to a search or display campaign.

`getCampaignType()`

Returns the campaign type. Possible return values:

SEARCH_OR_DISPLAY, VIDEO, SHOPPING

Return values:

Type	Description
`String`	Video campaign type.

`getEntityType()`

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

Return values:

Type	Description
`String`	Type of this entity: `"TargetedProximity"`.

`getId()`

Returns the ID of the targeted proximity.

Proximity IDs may be shared across campaigns. In order to uniquely identify a proximity target, one must specify both its campaign ID and the proximity ID.

Return values:

Type	Description
`String`	The ID of the targeted proximity.

`getLatitude()`

Returns the latitude in degrees of the central point of this proximity.

Return values:

Type	Description
`double`	The latitude in degrees of the central point of this proximity.

`getLongitude()`

Returns the longitude in degrees of the central point of this proximity.

Return values:

Type	Description
`double`	The longitude in degrees of the central point of this proximity.

`getRadius()`

Returns the radius around the central point to target.

This just returns a number such as 40 and is intended to be used in tandem with TargetedProximity.getRadiusUnits().

Return values:

Type	Description
`double`	The radius around the central point to target.

`getRadiusUnits()`

Returns the units of TargetedProximity.getRadius().

This is either "MILES" or "KILOMETERS".

Return values:

Type	Description
`String`	The units of TargetedProximity.getRadius().

`getResourceName()`

Returns the resource name of the targeted proximity.

Return values:

Type	Description
`String`	The resource name of the targeted proximity.

`getShoppingCampaign()`

Returns the shopping campaign to which this targeted proximity belongs or null if it does not belong to a shopping campaign.

Return values:

Type	Description
`AdsApp.ShoppingCampaign`	The shopping campaign to which this targeted proximity belongs or `null` if it does not belong to a shopping campaign.

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

Arguments:

Name	Type	Description
dateRange	`String`	Date range for which the stats are requested.

Return values:

Type	Description
`AdsApp.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:

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:

Type	Description
`AdsApp.Stats`	The stats for the specified date range.

`getVideoCampaign()`

Returns the video campaign to which this targeted proximity belongs or null if it does not belong to a video campaign.

Return values:

Type	Description
`AdsApp.VideoCampaign`	The video campaign to which this targeted proximity belongs or `null` if it does not belong to a video campaign.

`remove()`

Removes the targeted proximity.

Returns nothing.

`setBidModifier(modifier)`

Sets the bid modifier for this targeted proximity.

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`

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

Returns nothing.

Arguments:

Name	Type	Description
modifier	`double`	The new bid modifier.

AdsApp.​TargetedProximity Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

Methods:

getAddress()

Return values:

getBaseCampaign()

Return values:

getBidModifier()

Return values:

getCampaign()

Return values:

getCampaignType()

Return values:

getEntityType()

Return values:

getId()

Return values:

getLatitude()

Return values:

getLongitude()

Return values:

getRadius()

Return values:

getRadiusUnits()

Return values:

getResourceName()

Return values:

getShoppingCampaign()

Return values:

getStatsFor(dateRange)

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

getVideoCampaign()

Return values:

remove()

setBidModifier(modifier)

Arguments:

AdsApp.TargetedProximity

`getAddress()`

`getBaseCampaign()`

`getBidModifier()`

`getCampaign()`

`getCampaignType()`

`getEntityType()`

`getId()`

`getLatitude()`

`getLongitude()`

`getRadius()`

`getRadiusUnits()`

`getResourceName()`

`getShoppingCampaign()`

`getStatsFor(dateRange)`

`getStatsFor(dateFrom, dateTo)`

`getVideoCampaign()`

`remove()`

`setBidModifier(modifier)`