Trait

com.google.appsscript.adwords

CalloutBuilder

Related Doc: package adwords

Permalink

trait CalloutBuilder extends Object with Builder[Callout]

Builder for Callout objects.

Example usage:

 // Create a callout builder.
 var calloutBuilder = AdWordsApp.extensions().newCalloutBuilder();
 // Create a callout operation.
 var calloutOperation = calloutBuilder
   .withText("Free Shipping")                // required
   .withMobilePreferred(true)                // optional
   .build();
 // Optional: examine the outcome. The call to isSuccessful()
 // will block until the operation completes.
 if (calloutOperation.isSuccessful()) {
   // Get the result.
   var callout = calloutOperation.getResult();
 } else {
   // Handle the errors.
   var errors = calloutOperation.getErrors();
 }

Annotations
@RawJSType()
Linear Supertypes
Builder[Callout], Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CalloutBuilder
  2. Builder
  3. Object
  4. Any
  5. AnyRef
  6. 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 build(): Operation[Callout]

    Permalink
    Definition Classes
    Builder
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hasOwnProperty(v: String): Boolean

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. def propertyIsEnumerable(v: String): Boolean

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def withEndDate(date: AnyRef): CalloutBuilder

    Permalink

    Sets the callout's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

    Sets the callout's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. This field is optional. For instance, calloutBuilder.withEndDate("20130503"); is equivalent to calloutBuilder.withEndDate({year: 2013, month: 5, day: 3}); . The change will fail and report an error if:

    • the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
    • the start date now comes after the end date, or
    • it's a date in the past
  27. def withMobilePreferred(isMobilePreferred: Boolean): CalloutBuilder

    Permalink

    Sets the callout's device preference to mobile or clears it.

    Sets the callout's device preference to mobile or clears it. This field is optional and defaults to false .

  28. def withSchedules(schedules: Array[ExtensionSchedule]): CalloutBuilder

    Permalink

    Sets the callout scheduling.

    Sets the callout scheduling. Scheduling of a callout allows you to control the days of week and times of day during which the callout will show alongside your ads.

    Passing in an empty array clears the scheduling field, causing the callout to run at all times.

    The following example sets the callout to run on Mondays and Tuesday from 8:00 to 11:00.

      var mondayMorning = {
        dayOfWeek: "MONDAY",
        startHour: 8,
        startMinute: 0,
        endHour: 11,
        endMinute: 0
      };
      var tuesdayMorning = {
        dayOfWeek: "TUESDAY",
        startHour: 8,
        startMinute: 0,
        endHour: 11,
        endMinute: 0
      };
      calloutBuilder.withSchedules([mondayMorning, tuesdayMorning]);
    

  29. def withStartDate(date: AnyRef): CalloutBuilder

    Permalink

    Sets the callout's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

    Sets the callout's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. This field is optional. For instance, calloutBuilder.withStartDate("20130503"); is equivalent to calloutBuilder.withStartDate({year: 2013, month: 5, day: 3}); . The change will fail and report an error if:

    • the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
    • the given date is after the callout's end date,
  30. def withText(text: String): CalloutBuilder

    Permalink

    Sets the text of the new callout to the specified value.

    Sets the text of the new callout to the specified value. This field is required.

Inherited from Builder[Callout]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped