AdsApp.​ExcludedTopicSelector

AI-generated Key Takeaways

outlined_flag

• ExcludedTopicSelector is used to fetch excluded topics.

• It supports filtering results with withCondition and sorting with orderBy .

• The get() method retrieves the excluded topics and returns an iterator.

• You can limit the number of results returned by using the withLimit method.

Typical usage:

 var 
  
 adGroup 
  
 = 
  
 AdsApp 
 . 
 adGroups 
 () 
 . 
 get 
 () 
 . 
 next 
 (); 
 var 
  
 excludedTopicSelector 
  
 = 
  
 adGroup 
 . 
 display 
 () 
 . 
 excludedTopics 
 (); 
 var 
  
 excludedTopicIterator 
  
 = 
  
 excludedTopicSelector 
 . 
 get 
 (); 
 while 
  
 ( 
 excludedTopicIterator 
 . 
 hasNext 
 ()) 
  
 { 
  
 var 
  
 excludedTopic 
  
 = 
  
 excludedTopicIterator 
 . 
 next 
 (); 
 } 

• ExcludedTopicIterator
• ExcludedTopic

Methods:

get()

Return values:

orderBy(orderBy)

• orderBy("ad_group.name") - orders results by ad_group.name, in ascending order.
• orderBy("ad_group.name ASC") - orders results by ad_group.name, in ascending order.
• orderBy("ad_group.name DESC") - orders results by ad_group.name, in descending order.

See ExcludedTopicSelector.withCondition(String) for enumeration of columns that can be used.

orderBy() may be called multiple times. Consider the following example:

selector = selector.
    .orderBy("ad_group.name")
    .orderBy("campaign.name");

The results will be ordered by ad_group.name in ascending order. Results with equal ad_group.name value will be ordered by campaign.name in ascending order.

Arguments:

Return values:

withCondition(condition)

Multiple conditions may be added to the same selector:

 selector 
  
 = 
  
 selector 
  
 . 
 withCondition 
 ( 
 "ad_group.status NOT IN [PAUSED]" 
 ) 
  
 . 
 withCondition 
 ( 
 "campaign.name = 'Campaign 1'" 
 ); 

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

"COLUMN_NAME OPERATOR VALUE"

Operators

• For String columns (e.g. ad_group.name):

  =  !=  (NOT) (LIKE | CONTAINS | REGEXP_MATCH)

• For Enumeration columns (ones that can only take one value from a pre-defined list, such as ad_group.status):

  =  !=  IN () NOT IN ()

withCondition("ad_group.status IN [ENABLED, PAUSED]")

Columns

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

Arguments:

Return values:

withLimit(limit)

Arguments:

Return values: