Trait

com.google.appsscript.adwords

PlatformSelector

Related Doc: package adwords

Permalink

trait PlatformSelector extends Object with Selector[PlatformSelector] with OrderableSelector with HasStatistics

Fetches platforms. Supports filtering and sorting.

Typical usage:

 var platformSelector = AdWordsApp.targeting()
     .platforms()
     .withCondition("Impressions > 100")
     .forDateRange("LAST_MONTH")
     .orderBy("Clicks DESC");
 var platformIterator = platformSelector.get();
 while (platformIterator.hasNext()) {
   var platform = platformIterator.next();
 }

Annotations
@RawJSType()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlatformSelector
  2. HasStatistics
  3. OrderableSelector
  4. Selector
  5. Object
  6. Any
  7. AnyRef
  8. 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. def desktop(): PlatformSelector

    Permalink

    Restricts this selector to only select desktop targets.

  7. final def eq(arg0: AnyRef): Boolean

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

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

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

    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.

  11. def get(): PlatformIterator

    Permalink

    Fetches the requested platforms and returns an iterator.

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. 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
  14. def hasOwnProperty(v: String): Boolean

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

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

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

    Permalink
    Definition Classes
    Object
  18. def mobile(): PlatformSelector

    Permalink

    Restricts this selector to only select mobile targets.

  19. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  22. def orderBy(orderBy: String): PlatformSelector.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
  23. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def tablet(): PlatformSelector

    Permalink

    Restricts this selector to only select tablet targets.

  26. def toLocaleString(): String

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def withCondition(condition: String): PlatformSelector

    Permalink
    Definition Classes
    Selector
  33. def withIds(ids: Array[Array[Long]]): PlatformSelector

    Permalink

    Restricts this selector to return only platforms with the given platform IDs.

    Restricts this selector to return only platforms with the given platform IDs.

    All platforms are uniquely identified by the combination of their campaign ID and platform ID. The IDs for this selector are thus represented as two-element arrays, with the first element being the campaign ID and the second being the platform ID:

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

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

     var ids = [12345, 23456, 34567];
     var platforms = campaign.targeting().platforms().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],
     ];
     AdWordsApp.platforms()
        .withIds(ids1)
        .withIds(ids2);
    
    will only get the platform with ID [34567, 765765] , since it would be the only platform that satisfies both ID conditions.

  34. def withLimit(limit: Int): PlatformSelector

    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 Selector[PlatformSelector]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped