AdsApp.​AccountSnippetSelector

Page Summary

outlined_flag

• AccountSnippetSelector fetches account-level snippets and supports filtering and sorting.

• You can set a predefined or custom date range for the selector.

• The get() method fetches the snippets and returns an iterator.

• You can specify the order of the results using the orderBy() method.

• The withCondition() method allows you to filter results based on various criteria and operators.

• Use withLimit() to restrict the number of entities returned by the selector.

Typical usage:

 var 
  
 accountSnippetSelector 
  
 = 
  
 AdsApp 
 . 
 currentAccount 
 () 
 . 
 extensions 
 () 
  
 . 
 snippets 
 () 
  
 . 
 withCondition 
 ( 
 "metrics.impressions > 100" 
 ) 
  
 . 
 forDateRange 
 ( 
 "LAST_MONTH" 
 ) 
  
 . 
 orderBy 
 ( 
 "metrics.clicks DESC" 
 ); 
 var 
  
 accountSnippetIterator 
  
 = 
  
 accountSnippetSelector 
 . 
 get 
 (); 
 while 
  
 ( 
 accountSnippetIterator 
 . 
 hasNext 
 ()) 
  
 { 
  
 var 
  
 accountSnippet 
  
 = 
  
 accountSnippetIterator 
 . 
 next 
 (); 
 } 

• AccountSnippetIterator
• AccountSnippet

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

Arguments:

Return values:

withLimit(limit)

Arguments:

Return values: