AdsApp.​AdSelector

Fetches ads in an account, except from shared libraries. Supports filtering and sorting.

Typical usage:

 var adSelector = AdsApp
     .ads()
     .withCondition("Impressions > 100")
     .forDateRange("LAST_MONTH")
     .orderBy("Clicks DESC");

 var adIterator = adSelector.get();
 while (adIterator.hasNext()) {
   var ad = adIterator.next();
 }

Related:

• AdIterator
• Ad

Methods:

Member	Type	Description
forDateRange	AdsApp.AdSelector	Sets a predefined date range onto the selector.
forDateRange	AdsApp.AdSelector	Sets a custom date range onto the selector.
get	AdsApp.AdIterator	Fetches the requested ads and returns an iterator.
orderBy	AdsApp.AdSelector	Specifies the ordering of the resulting entities.
withCondition	AdsApp.AdSelector	Adds the specified condition to the selector in order to narrow down the results.
withIds	AdsApp.AdSelector	Restricts this selector to return only ads with the given ad IDs.
withLimit	AdsApp.AdSelector	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.AdSelector	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.AdSelector	The selector with date range applied.

get()

Fetches the requested ads and returns an iterator.

Return values:

Type	Description
AdsApp.AdIterator	Iterator of the requested ads.

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

LabelNames column cannot be used for ordering.

Arguments:

Name	Type	Description
orderBy	String	Ordering to apply.

Return values:

Type	Description
AdsApp.AdSelector	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")
Ad attributes
Status	Enumeration: ENABLED, PAUSED, DISABLED	withCondition("Status = PAUSED")
CombinedApprovalStatus	Enumeration: APPROVED, APPROVED_LIMITED, ELIGIBLE, UNDER_REVIEW, DISAPPROVED, SITE_SUSPENDED	withCondition("CombinedApprovalStatus NOT_IN [DISAPPROVED, UNDER_REVIEW]")
Type	Enumeration: EXPANDED_TEXT_AD, GMAIL_IMAGE_AD, GMAIL_SINGLE_PROMOTION_AD, GMAIL_MULTI_PRODUCT_AD, HTML5_AD, IMAGE_AD, MOBILE_AD, MOBILE_IMAGE_AD, PRODUCT_AD, RESPONSIVE_DISPLAY_AD, RICH_MEDIA_AD, TEMPLATE_AD, TEXT_AD	withCondition("Type NOT_IN [IMAGE_AD, RICH_MEDIA_AD]")
Headline	String	withCondition("Headline CONTAINS_IGNORE_CASE 'leather shoes'")
Description1	String	withCondition("Description1 STARTS_WITH 'Leather'")
Description2	String	withCondition("Description2 = 'Hurry to buy'")
DisplayUrl	String	withCondition("DisplayUrl STARTS_WITH 'www.example.com'")
DestinationUrl	String	withCondition("DestinationUrl STARTS_WITH 'http://www.example.com'")
CreativeFinalUrls	String	withCondition("CreativeFinalUrls CONTAINS 'http://www.example.com'")
AdGroupName	String	withCondition("AdGroupName CONTAINS_IGNORE_CASE 'shoes'")
AdGroupStatus	Enumeration: ENABLED, PAUSED, REMOVED	withCondition("AdGroupStatus = ENABLED"). Use to fetch ads from only ENABLED ad groups.
CampaignName	String	withCondition("CampaignName CONTAINS_IGNORE_CASE 'promotion'")
CampaignStatus	Enumeration: ENABLED, PAUSED, REMOVED	withCondition("CampaignStatus = ENABLED"). Use to fetch ads from only ENABLED campaigns.
LabelNames	StringSet	withCondition("LabelNames CONTAINS_ANY ['Xmas', 'New Year']"). The value is a list of exact, case-sensitive label names.
DevicePreferenceType	Enumeration: MOBILE, ALL	withCondition("DevicePreferenceType = MOBILE"). Use to fetch only mobile-preferred ads.

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

Arguments:

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

Return values:

Type	Description
AdsApp.AdSelector	The selector with the condition applied.

withIds(ids)

Restricts this selector to return only ads with the given ad IDs.

All ads are uniquely identified by the combination of their ad group ID and ad 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 ad ID:

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

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

 var ids = [12345, 23456, 34567];
 var ads = adGroup.ads().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.ads()
    .withIds(ids1)
    .withIds(ids2);

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

Arguments:

Name	Type	Description
ids	long[][]	Array of ad IDs.

Return values:

Type	Description
AdsApp.AdSelector	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.AdSelector	The selector with limit applied.