AdsApp.TargetedProximitySelector

Fetches targeted proximities. Supports filtering and sorting.

Typical usage:

 var targetedProximitySelector = AdsApp.targeting()
     .targetedProximities()
     .withCondition("Impressions > 100")
     .forDateRange("LAST_MONTH")
     .orderBy("Clicks DESC");

 var targetedProximityIterator = targetedProximitySelector.get();
 while (targetedProximityIterator.hasNext()) {
   var targetedProximity = targetedProximityIterator.next();
 }

Member	Type	Description
forDateRange	`AdsApp.TargetedProximitySelector`	Sets a predefined date range onto the selector.
forDateRange	`AdsApp.TargetedProximitySelector`	Sets a custom date range onto the selector.
get	`AdsApp.TargetedProximityIterator`	Fetches the requested targeted proximities and returns an iterator.
orderBy	`AdsApp.TargetedProximitySelector`	Specifies the ordering of the resulting entities.
withCondition	`AdsApp.TargetedProximitySelector`	Adds the specified condition to the selector in order to narrow down the results.
withIds	`AdsApp.TargetedProximitySelector`	Restricts this selector to return only targeted proximities with the given targeted proximity IDs.
withLimit	`AdsApp.TargetedProximitySelector`	Specifies limit for the selector to use.

`forDateRange(dateRange)`

Sets a predefined date range onto the selector. 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:

 selector.forDateRange("THIS_WEEK_SUN_TODAY");

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.

Arguments:

Name	Type	Description
dateRange	`String`	Date range to set onto the selector.

Return values:

Type	Description
`AdsApp.TargetedProximitySelector`	The selector with date range applied.

`forDateRange(dateFrom, dateTo)`

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.

Arguments:

Name	Type	Description
dateFrom	`Object`	Start date of the date range.
dateTo	`Object`	End date of the date range.

Return values:

Type	Description
`AdsApp.TargetedProximitySelector`	The selector with date range applied.

`get()`

Fetches the requested targeted proximities and returns an iterator.

Return values:

Type	Description
`AdsApp.TargetedProximityIterator`	Iterator of the requested targeted proximities.

`orderBy(orderBy)`

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 TargetedProximitySelector.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 TargetedProximitySelector.forDateRange(String) or TargetedProximitySelector.forDateRange(Object, Object).

LabelNames column cannot be used for ordering.

Arguments:

Name	Type	Description
orderBy	`String`	Ordering to apply.

Return values:

Type	Description
`AdsApp.TargetedProximitySelector`	The selector with ordering applied.

`withCondition(condition)`

Adds the specified condition to the selector in order to narrow down the results.

Multiple conditions may be added to the same selector:

 selector = selector.forDateRange("LAST_MONTH")
     .withCondition("Clicks > 5")
     .withCondition("Impressions > 100");

All specified conditions are AND-ed together. The above example will retrieve entities that observed over 100 impressions AND more than 5 clicks.

The parameter to be passed into this method must be of the following form:

 "COLUMN_NAME OPERATOR VALUE"

Operators

The operator that can be used in a condition depends on the type of column.

For Integer and Long columns (e.g. Impressions, Clicks):
< <= > >= = !=
For Double columns (e.g. Ctr):
< >

For String columns (e.g. Name):
= != STARTS_WITH STARTS_WITH_IGNORE_CASE CONTAINS CONTAINS_IGNORE_CASE DOES_NOT_CONTAIN DOES_NOT_CONTAIN_IGNORE_CASE

For Enumeration columns (ones that can only take one value from a predefined list, such as Status):
= != IN [] NOT_IN []

For StringSet columns (e.g. LabelNames):
CONTAINS_ALL [] CONTAINS_ANY [] CONTAINS_NONE []

Conditions using IN, NOT_IN, CONTAINS_ALL, CONTAINS_ANY and CONTAINS_NONE operators look as follows:

 withCondition("ColumnName IN [Value1, Value2]")

Operators are case-sensitive: starts_with won't work.

Columns

All column names are case-sensitive, and so are all values of enumerated columns (such as Status).

Column	Type	Example
*Stats*
AverageCpc	Double	`withCondition("AverageCpc < 1.45")`
AverageCpm	Double	`withCondition("AverageCpm > 0.48")`
AverageCpv	Double	`withCondition("AverageCpv < 0.23")`
AveragePageviews	Double	`withCondition("AveragePageviews > 0")`
BounceRate	Double	`withCondition("BounceRate < 0.5")`
Clicks	Long	`withCondition("Clicks >= 21")`
ConversionRate	Double	`withCondition("ConversionRate > 0.1")`
Conversions	Long	`withCondition("Conversions <= 4")`
Cost	Double	`withCondition("Cost > 4.48")`. The value is in the currency of the account.
Ctr	Double	`withCondition("Ctr > 0.01")`. Note that Ctr is returned in `0..1` range, so 5% Ctr is represented as 0.05.
Impressions	Long	`withCondition("Impressions != 0")`

If a stats column is used in the condition, date range must be specified via TargetedProximitySelector.forDateRange(String) or TargetedProximitySelector.forDateRange(Object, Object).

Arguments:

Name	Type	Description
condition	`String`	Condition to add to the selector.

Return values:

Type	Description
`AdsApp.TargetedProximitySelector`	The selector with the condition applied.

`withIds(ids)`

Restricts this selector to return only targeted proximities with the given targeted proximity IDs.

All targeted proximities are uniquely identified by the combination of their campaign ID and targeted proximity ID. The IDs for this selector are thus represented as two-element arrays, with the first element being the campaign ID and the second being the targeted proximity ID:

 var targetedProximityIds = [
   [12345, 987987],
   [23456, 876876],
   [34567, 765765],
 ];
 selector = selector.withIds(targetedProximityIds);

In cases where the campaign ID is already known, the IDs for this selector can then be just an array of targeted proximity IDs. Any provided campaign ID and targeted proximity ID combination will override the embedded campaign ID. For instance, the following will select the targeted proximities with the given targeted proximity IDs in the given campaign:

 var ids = [12345, 23456, 34567];
 var proximities = campaign.targeting().targetedProximities().withIds(ids);

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:

 var ids1 = [
   [12345, 987987],
   [23456, 876876],
   [34567, 765765],
 ];
 var ids2 = [
   [34567, 765765],
   [45678, 654654],
   [56789, 543543],
 ];
 AdsApp.targeting().targetedProximities()
    .withIds(ids1)
    .withIds(ids2);

will only get the targeted proximity with ID [34567, 765765], since it would be the only targeted proximity that satisfies both ID conditions.

Arguments:

Name	Type	Description
ids	`long[][]`	Array of targeted proximity IDs.

Return values:

Type	Description
`AdsApp.TargetedProximitySelector`	The selector restricted to the given IDs.

`withLimit(limit)`

Specifies limit for the selector to use. For instance, withLimit(50) returns only the first 50 entities.

Arguments:

Name	Type	Description
limit	`int`	How many entities to return.

Return values:

Type	Description
`AdsApp.TargetedProximitySelector`	The selector with limit applied.

AdsApp.​TargetedProximitySelector

Methods:

forDateRange(dateRange)

Arguments:

Return values:

forDateRange(dateFrom, dateTo)

Arguments:

Return values:

get()

Return values:

orderBy(orderBy)

Arguments:

Return values:

withCondition(condition)

Operators

Columns

Arguments:

Return values:

withIds(ids)

Arguments:

Return values:

withLimit(limit)

Arguments:

Return values:

AdsApp.TargetedProximitySelector

`forDateRange(dateRange)`

`forDateRange(dateFrom, dateTo)`

`get()`

`orderBy(orderBy)`

`withCondition(condition)`

`withIds(ids)`

`withLimit(limit)`