AdsApp.​DisplayKeywordSelector

Typical usage:

var displayKeywordSelector = AdsApp.display()
    .keywords()
    .withCondition("metrics.impressions > 100")
    .forDateRange("LAST_MONTH")
    .orderBy("metrics.clicks DESC");

var displayKeywordIterator = displayKeywordSelector.get();
while (displayKeywordIterator.hasNext()) {
  var displayKeyword = displayKeywordIterator.next();
}

• DisplayKeywordIterator
• DisplayKeyword

Methods:

forDateRange(dateRange)

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:

Return values:

forDateRange(dateFrom, dateTo)

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:

Return values:

get()

Return values:

orderBy(orderBy)

• 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 DisplayKeywordSelector.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.

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

LabelNames column cannot be used for ordering.

Arguments:

Return values:

withCondition(condition)

Multiple conditions may be added to the same selector:

selector = selector.forDateRange("LAST_MONTH")
    .withCondition("metrics.clicks > 5")
    .withCondition("metrics.impressions > 100");

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

"COLUMN_NAME OPERATOR VALUE"

Operators

• 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 ()

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).

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

Arguments:

Return values:

withIds(ids)

All display keywords are uniquely identified by the combination of their ad group ID and display keyword ID. The IDs for this selector are thus represented as two-element arrays, with the first element being the ad group ID and the second being the display keyword ID:

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

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.display().keywords()
   .withIds(ids1)
   .withIds(ids2);

Arguments:

Return values:

withLimit(limit)

Arguments:

Return values:

withResourceNames(resourceNames)

const displayKeywordResourceNames = [
  'customers/1234567890/adGroupCriteria/111~222',
  'customers/1234567890/adGroupCriteria/111~333',
  'customers/1234567890/adGroupCriteria/444~555',
];
selector = selector.withResourceNames(displayKeywordResourceNames);

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:

Return values: