Trait

com.google.appsscript.adwords

TopicSelector

Related Doc: package adwords

Permalink

trait TopicSelector extends Object with Selector[TopicSelector] with Location with OrderableSelector with HasStatistics

Fetches topics. Supports filtering and sorting.

Typical usage:

 var topicSelector = AdWordsApp.display()
     .topics()
     .withCondition("Impressions > 100")
     .forDateRange("LAST_MONTH")
     .orderBy("Clicks DESC");
 var topicIterator = topicSelector.get();
 while (topicIterator.hasNext()) {
   var topic = topicIterator.next();
 }

Annotations
@RawJSType()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopicSelector
  2. HasStatistics
  3. OrderableSelector
  4. Location
  5. Selector
  6. Object
  7. Any
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def forDateRange(dateFrom: AnyRef, dateTo: AnyRef): TopicSelector

    Permalink

    Sets a custom date range onto the selector.

    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.

  10. def get(): TopicIterator

    Permalink

    Fetches the requested topics and returns an iterator.

  11. def getCampaign(): Campaign

    Permalink

    Returns the campaign to which this location belongs.

    Returns the campaign to which this location belongs.

    Definition Classes
    Location
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getCountryCode(): String

    Permalink

    Returns the country code of this location.

    Returns the country code of this location.

    This is the standard two-letter country code, e.g. "US" or "BR".

    Definition Classes
    Location
  14. def getEntityType(): String

    Permalink

    Returns the type of this entity as a String .

    Returns the type of this entity as a String .

    Definition Classes
    Location
  15. def getId(): Long

    Permalink

    Returns the ID of the location.

    Returns the ID of the location.

    Location IDs are shared across campaigns. In order to uniquely identify a location exclusion, one must specify both its campaign ID and the location ID.

    Definition Classes
    Location
  16. def getName(): String

    Permalink

    Returns the name of this location.

    Returns the name of this location.

    Definition Classes
    Location
  17. def getStatsFor(dateFrom: AnyRef, dateTo: AnyRef): Stats

    Permalink

    Returns stats for the specified custom date range.

    Returns stats for the specified custom date range. 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") defines a range of a single day.

    Definition Classes
    HasStatistics
  18. def getTargetType(): String

    Permalink

    Returns the target type of this location.

    Returns the target type of this location.

    The target type is a generic description of the location, such as "City", "Postal Code", or "Country". For a full list of target types, see the AdWords API documentation on geotargeting.

    Definition Classes
    Location
  19. def getTargetingStatus(): String

    Permalink

    Returns the targeting status of this location.

    Returns the targeting status of this location.

    This can return one of three values:

    • "ACTIVE": indicates that the location can be targeted as normal. The vast majority of locations are active.
    • "PHASING_OUT": indicates that the location can be targeted, but that support will soon be removed. To get a list of which locations are phasing out, please see the AdWords API documentation on geotargeting.
    • "OBSOLETE": indicates that the location cannot be targeted.
    Definition Classes
    Location
  20. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. def orderBy(orderBy: String): TopicSelector.this.type

    Permalink

    Specifies the ordering of the resulting entities.

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

    LabelNames column cannot be used for ordering.

    Definition Classes
    OrderableSelector
  28. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  29. def remove(): Unit

    Permalink

    Removes the location.

    Removes the location.

    Returns nothing.

    Definition Classes
    Location
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  32. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  33. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def withCondition(condition: String): TopicSelector

    Permalink
    Definition Classes
    Selector
  38. def withIds(ids: Array[Array[Long]]): TopicSelector

    Permalink

    Restricts this selector to return only Topics with the given IDs.

    Restricts this selector to return only Topics with the given IDs.

    All Topics are uniquely identified by the combination of their ad group ID and their individual ID (obtained using Topic.getId()). 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 individial topic ID:

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

    Restricts this selector to return only topics with the given 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],
     ];
     AdWordsApp.display().topics()
        .withIds(ids1)
        .withIds(ids2);
    
    will only get the topic with ID [34567, 765765] , since it would be the only topic that satisfies both ID conditions.

  39. def withLimit(limit: Int): TopicSelector

    Permalink

    Specifies limit for the selector to use.

    Specifies limit for the selector to use. For instance, withLimit(50) returns only the first 50 entities.

    Definition Classes
    Selector

Inherited from HasStatistics

Inherited from OrderableSelector

Inherited from Location

Inherited from Selector[TopicSelector]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped