AdWordsApp.​TargetedProximity

Represents an AdWords targeted proximity — some radius around a geographical point.

Methods:

MemberTypeDescription
getAddress AdWordsApp.Address Returns the address of the central point, or null if unknown.
getBidModifier double Returns the bid modifier for this targeted proximity.
getCampaign AdWordsApp.Campaign Returns the campaign to which this targeted proximity belongs.
getCampaignType String Returns the campaign type.
getEntityType String Returns the type of this entity as a String, in this case, "TargetedProximity".
getId long 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().
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getVideoCampaign AdWordsApp.VideoCampaign Returns the video campaign to which this targeted proximity belongs.
remove void Removes the targeted proximity.
setBidModifier void Sets the bid modifier for this targeted proximity.

getAddress()

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

Return values:

TypeDescription
AdWordsApp.Address The address of the central point, or null if unknown.

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:

TypeValueBid Modifier
LocationLaos1.3
Ad ScheduleSaturday 6AM-10AM0.9
PlatformMobile1.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.

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

Return values:

TypeDescription
double The criterion bid modifier.

getCampaign()

Returns the campaign to which this targeted proximity belongs.

Return values:

TypeDescription
AdWordsApp.Campaign The campaign to which this targeted proximity belongs.

getCampaignType()

Returns the campaign type. Possible return values:

SEARCH_OR_DISPLAY, VIDEO, SHOPPING

Return values:

TypeDescription
String Video campaign type.

getEntityType()

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

Return values:

TypeDescription
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:

TypeDescription
long The ID of the targeted proximity.

getLatitude()

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

Return values:

TypeDescription
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:

TypeDescription
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:

TypeDescription
double The radius around the central point to target.

getRadiusUnits()

Returns the units of TargetedProximity.getRadius().

This is either "MILES" or "KILOMETERS".

Return values:

TypeDescription
String The units of TargetedProximity.getRadius().

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:

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.

getVideoCampaign()

Returns the video campaign to which this targeted proximity belongs.

Return values:

TypeDescription
AdWordsApp.VideoCampaign The video campaign to which this targeted proximity belongs.

remove()

Removes the targeted proximity.

Returns nothing.

setBidModifier(modifier)

Sets 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:

TypeValueBid Modifier
LocationLaos1.3
Ad ScheduleSaturday 6AM-10AM0.9
PlatformMobile1.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.

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

For proximities, acceptable bid modifiers are in the range 0.1 to 10.

Returns nothing.

Arguments:

NameTypeDescription
modifier double The new bid modifier.

发送以下问题的反馈:

此网页
AdWords Scripts
AdWords Scripts
需要帮助?请访问我们的支持页面