AdsApp.​PriceSelector

Fetches prices. Supports filtering and sorting.

Typical usage: 

var priceSelector = AdsApp.extensions()
    .prices()
    .withCondition("asset.id IN [1, 2, 3]")
    .orderBy("asset.id DESC");

var priceIterator = priceSelector.get();
while (priceIterator.hasNext()) {
  var price = priceIterator.next();
}
 Related:

Methods:

MemberTypeDescription
forDateRange AdsApp.PriceSelector Sets a predefined date range onto the selector.
forDateRange AdsApp.PriceSelector Sets a custom date range onto the selector.
get AdsApp.PriceIterator Fetches the requested prices and returns an iterator.
orderBy AdsApp.PriceSelector Specifies the ordering of the resulting entities.
withCondition AdsApp.PriceSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdsApp.PriceSelector Restricts this selector to return only prices with the given price IDs.
withLimit AdsApp.PriceSelector Specifies limit for the selector to use.
withOnlyLegacy AdsApp.PriceSelector Fetches legacy prices.
withOnlyUpgraded AdsApp.PriceSelector Fetches upgraded prices.
withResourceNames AdsApp.PriceSelector Restricts this selector to return only prices with the given Google Ads API resource names.

forDateRange(dateRange)

Sets a predefined date range onto the selector. Supported values:

TODAY, YESTERDAY, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN, THIS_WEEK_MON_TODAY, THIS_WEEK_SUN_TODAY, LAST_MONTH, THIS_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:

NameTypeDescription
dateRange String Date range to set onto the selector.

Return values:

TypeDescription
AdsApp.PriceSelector 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:

NameTypeDescription
dateFrom Object Start date of the date range.
dateTo Object End date of the date range.

Return values:

TypeDescription
AdsApp.PriceSelector The selector with date range applied.

get()

Fetches the requested prices and returns an iterator.

Return values:

TypeDescription
AdsApp.PriceIterator Iterator of the requested prices.

orderBy(orderBy)

Specifies the ordering of the resulting entities. orderBy parameter can have one of the following forms:
  • orderBy("metrics.cost_micros") - orders results by metrics.cost_micros, in ascending order.
  • orderBy("metrics.ctr ASC") - orders results by metrics.ctr, in ascending order.
  • orderBy("ad_group_criterion.cpc_bid_micros DESC") - orders results by ad_group_criterion.cpc_bid_micros, in descending order.

See PriceSelector.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("metrics.clicks DESC")
    .orderBy("metrics.ctr ASC");

The results will be ordered by metrics.clicks in descending order. Results with equal metrics.clicks value will be ordered by metrics.ctr in ascending order.

LabelNames column cannot be used for ordering.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdsApp.PriceSelector 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("metrics.clicks > 5")
    .withCondition("metrics.impressions > 100");
 All specified conditions are AND-ed together. The above example will retrieve entities that observed over 100 metrics.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. metrics.clicks and metrics.impressions): 
    <  <=  >  >=  =  !=
  • For Double columns (e.g. metrics.ctr): 
    <  >
  • For String columns (e.g. campaign.name): 
    =  !=  (NOT) (LIKE | CONTAINS | REGEXP_MATCH)
  • 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. campaign.labels): 
    CONTAINS ALL ()  CONTAINS ANY ()  CONTAINS NONE ()
Conditions using IN, NOT IN, CONTAINS ALL, CONTAINS ANY and CONTAINS NONE operators look as follows: 
withCondition("resource.column_name IN (Value1, Value2)")

Columns

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

Column Type Example
Stats
asset.id Long withCondition("asset.id = 12345")
asset.name String withCondition("asset.name = 'my asset'")
asset.price_asset.type Enumeration: BRANDS, EVENTS, LOCATIONS, NEIGHBORHOODS, PRODUCT_CATEGORIES, PRODUCT_TIERS, SERVICES, SERVICE_CATEGORIES, SERVICE_TIERS withCondition("asset.price_asset.type IN (BRANDS, EVENTS)")
asset.price_asset.price_qualifier Enumeration: FROM, UP_TO, AVERAGE withCondition("asset.price_asset.price_qualifier != AVERAGE")
asset.price_asset.language_code String withCondition("asset.price_asset.language_code = 'USD'")

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdsApp.PriceSelector The selector with the condition applied.

withIds(ids)

Restricts this selector to return only prices with the given price IDs. 
var priceIds = ['12345', '23456', '34567'];
selector = selector.withIds(priceIds);

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: 

AdsApp.extensions().prices()
   .withIds(['12345', '23456', '34567'])
   .withIds(['34567', '45678', '56789']);
 will only get the price with ID 34567, since it would be the only price that satisfies both ID conditions.

The selector can only support up to 10,000 IDs. If more than 10,000 IDs are specified, the corresponding get() call will fail with a runtime error.

Arguments:

NameTypeDescription
ids Object[] Array of price IDs.

Return values:

TypeDescription
AdsApp.PriceSelector 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:

NameTypeDescription
limit int How many entities to return.

Return values:

TypeDescription
AdsApp.PriceSelector The selector with limit applied.

withOnlyLegacy()

Fetches legacy prices.

Return values:

TypeDescription
AdsApp.PriceSelector The selector with the condition applied.

withOnlyUpgraded()

Fetches upgraded prices.

Return values:

TypeDescription
AdsApp.PriceSelector The selector with the condition applied.

withResourceNames(resourceNames)

Restricts this selector to return only prices with the given Google Ads API resource names. 
const priceResourceNames = [
  'customers/1234567890/extensionFeedItems/111',
  'customers/1234567890/extensionFeedItems/222',
  'customers/1234567890/extensionFeedItems/333',
];
selector = selector.withResourceNames(priceResourceNames);

The resulting selector can be further refined by applying additional conditions to it. The resource name condition will then be AND-ed together with all the other conditions.

The selector can only support up to 10,000 resource names. If more than 10,000 resource names are specified, the corresponding get() call will fail with a runtime error.

Arguments:

NameTypeDescription
resourceNames String[] Array of price resource names.

Return values:

TypeDescription
AdsApp.PriceSelector The selector restricted to the given resource names.