Typical usage:
var displayKeywordSelector = AdsApp.display() .keywords() .withCondition("Impressions > 100") .forDateRange("LAST_MONTH") .orderBy("Clicks DESC"); var displayKeywordIterator = displayKeywordSelector.get(); while (displayKeywordIterator.hasNext()) { var displayKeyword = displayKeywordIterator.next(); }Related:
Methods:
Member | Type | Description |
---|---|---|
forDateRange | AdsApp.DisplayKeywordSelector |
Sets a predefined date range onto the selector. |
forDateRange | AdsApp.DisplayKeywordSelector |
Sets a custom date range onto the selector. |
get | AdsApp.DisplayKeywordIterator |
Fetches the requested display keywords and returns an iterator. |
orderBy | AdsApp.DisplayKeywordSelector |
Specifies the ordering of the resulting entities. |
withCondition | AdsApp.DisplayKeywordSelector |
Adds the specified condition to the selector in order to narrow down the results. |
withIds | AdsApp.DisplayKeywordSelector |
Restricts this selector to return only display keywords with the given display keyword IDs. |
withLimit | AdsApp.DisplayKeywordSelector |
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.DisplayKeywordSelector |
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.DisplayKeywordSelector |
The selector with date range applied. |
get()
Fetches the requested display keywords and returns an iterator.Return values:
Type | Description |
---|---|
AdsApp.DisplayKeywordIterator |
Iterator of the requested display keywords. |
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 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("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 DisplayKeywordSelector.forDateRange(String) or DisplayKeywordSelector.forDateRange(Object, Object).
LabelNames
column cannot be used for ordering.
Arguments:
Name | Type | Description |
---|---|---|
orderBy | String |
Ordering to apply. |
Return values:
Type | Description |
---|---|
AdsApp.DisplayKeywordSelector |
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
andLong
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 []
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 |
---|---|---|
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") |
Status | Enumeration: ENABLED , PAUSED , REMOVED |
withCondition("Status = PAUSED") |
Text | String | withCondition("Text STARTS_WITH 'leather'") |
KeywordMatchType | Enumeration: BROAD , EXACT , PHRASE |
withCondition("KeywordMatchType = PHRASE") |
MaxCpc | Double | withCondition("MaxCpc > 0.50") .
The value is in the currency of the account. |
QualityScore | Integer | withCondition("QualityScore >= 6") |
FirstPageCpc | Double | withCondition("FirstPageCpc < 1.00") .
The value is in the currency of the account. |
TopOfPageCpc | Double | withCondition("TopOfPageCpc < 3.00") .
The value is in the currency of the account. |
AdGroupName | String | withCondition("AdGroupName CONTAINS_IGNORE_CASE 'shoes'") |
AdGroupStatus | Enumeration: ENABLED , PAUSED , REMOVED |
withCondition("AdGroupStatus = ENABLED") . Use to fetch display keywords from only
ENABLED ad groups. |
CampaignName | String | withCondition("CampaignName CONTAINS_IGNORE_CASE 'promotion'") |
CampaignStatus | Enumeration: ENABLED , PAUSED , REMOVED |
withCondition("CampaignStatus = ENABLED") . Use to fetch display keywords from only
ENABLED campaigns. |
If a stats column is used in the condition, date range must be specified via DisplayKeywordSelector.forDateRange(String) or DisplayKeywordSelector.forDateRange(Object, Object).
Arguments:
Name | Type | Description |
---|---|---|
condition | String |
Condition to add to the selector. |
Return values:
Type | Description |
---|---|
AdsApp.DisplayKeywordSelector |
The selector with the condition applied. |
withIds(ids)
Restricts this selector to return only display keywords with the given
display keyword 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);will only get the display keyword with ID
[34567, 765765]
, since it would be
the only display keyword that satisfies both ID conditions.Arguments:
Name | Type | Description |
---|---|---|
ids | long[][] |
Array of display keyword IDs. |
Return values:
Type | Description |
---|---|
AdsApp.DisplayKeywordSelector |
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.DisplayKeywordSelector |
The selector with limit applied. |