Trait

com.google.appsscript.adwords

MobileAppBuilder

Related Doc: package adwords

Permalink

trait MobileAppBuilder extends Object with Builder[MobileApp] with BuilderWithCustomParameters

Builder for MobileApp objects.

Example usage:

 // Create a mobile app builder.
 var mobileAppBuilder = AdWordsApp.extensions().newMobileAppBuilder();
 // Create a mobile app operation.
 var mobileAppOperation = mobileAppBuilder
   .withAppId("store specific app id")                 // required
   .withStore("Android")                               // required
   .withLinkText("Download Android App Here")          // required
   .withFinalUrl("http://wwww.example.com/androidApp") // required
   .withStartDate({day: 12, month: 9, year: 2013})     // optional
   .build();
 // Optional: examine the outcome. The call to isSuccessful()
 // will block until the operation completes.
 if (mobileAppOperation.isSuccessful()) {
   // Get the result.
   var mobileApp = mobileAppOperation.getResult();
 } else {
   // Handle the errors.
   var errors = mobileAppOperation.getErrors();
 }

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

    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 withAppId(appId: String): MobileAppBuilder

    Permalink

    Sets the mobile app's app ID.

    Sets the mobile app's app ID. Takes a string representing the store-specific ID for the target application. This field is required.

  27. def withCustomParameters(customParameters: AnyRef): AdBuilder

    Permalink

    Sets the custom parameters of the new ad to the specified value.

    Sets the custom parameters of the new ad to the specified value.

    Custom parameters enable you to create your own ValueTrack parameters that you can assign your own IDs to.

    The name of a custom parameter can contain only alphanumeric characters, and custom parameter values may not contain white space. When referring to the custom parameter in final URLs and tracking template, you should surround the custom parameter in braces, and prefix an underscore to its name, e.g. {_param}.

    You can have up to 3 custom parameters for an entity. The key and value must not exceed 16 and 200 bytes respectively.

    Custom parameters specified at a lower level entity will override the setting specified at a higher level entity, e.g., setting custom parameters at the ad group level overrides the setting at the campaign level, and and custom parameters specified at the ad level override the setting at the ad group level.

    See Using Upgraded URLs for more information.

    Definition Classes
    BuilderWithCustomParameters
  28. def withEndDate(date: AnyRef): MobileAppBuilder

    Permalink

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

    Sets the mobile app'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, mobileAppBuilder.withEndDate("20130503"); is equivalent to mobileAppBuilder.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
  29. def withFinalUrl(finalUrl: String): MobileAppBuilder

    Permalink

    Sets the final URL of the new mobile app to the specified value.

    Sets the final URL of the new mobile app to the specified value.

    The final URL represents the actual landing page for your mobile app. The final URL must be the URL of the page that the user ends up on after clicking on your ad, once all the redirects have taken place.

    See Using Upgraded URLs for more information. Final URLs are required.

  30. def withLinkText(linkText: String): MobileAppBuilder

    Permalink

    Sets the link text of the mobile app.

    Sets the link text of the mobile app. This field is required.

  31. def withLinkUrl(linkUrl: String): MobileAppBuilder

    Permalink

    Sets the link URL of the mobile app.

    Sets the link URL of the mobile app. <aside class="warning"> Deprecated. This method will be sunset when destination URLs become read-only on July 1, 2015. Please use MobileAppBuilder.withFinalUrl instead. See Using Upgraded URLs for more information. </aside>

  32. def withMobileFinalUrl(mobileFinalUrl: String): MobileAppBuilder

    Permalink

    Sets the mobile final URL of the new mobile app to the specified value.

    Sets the mobile final URL of the new mobile app to the specified value.

    The mobile final URL represents the actual landing page for your mobile app on a mobile device. The final mobile URL must be the URL of the page that the user ends up on after clicking on your ad on a mobile device, once all the redirects have taken place.

    See Using Upgraded URLs for more information.

  33. def withMobilePreferred(isMobilePreferred: Boolean): MobileAppBuilder

    Permalink

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

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

  34. def withSchedules(schedules: Array[ExtensionSchedule]): MobileAppBuilder

    Permalink

    Sets the mobile app scheduling.

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

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

    The following example sets the mobile app 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
      };
      mobileAppBuilder.withSchedules([mondayMorning, tuesdayMorning]);
    

  35. def withStartDate(date: AnyRef): MobileAppBuilder

    Permalink

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

    Sets the mobile app'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, mobileAppBuilder.withStartDate("20130503"); is equivalent to mobileAppBuilder.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 mobile app's end date,
  36. def withStore(store: String): MobileAppBuilder

    Permalink

    Sets the application store that this application belongs to.

    Sets the application store that this application belongs to. This accepts either "iOS" or "Android". This field is required.

  37. def withTrackingTemplate(trackingTemplate: String): MobileAppBuilder

    Permalink

    Sets the tracking template of the new mobile app to the specified value.

    Sets the tracking template of the new mobile app to the specified value.

    You can optionally use the tracking template to specify additional tracking parameters or redirects. AdWords will use this template to assemble the actual destination URL to associate with the ad.

    A tracking template specified at a lower level entity will override the setting specified at a higher level entity, e.g., a tracking template set at the ad group level overrides the setting at the campaign level, and a tracking template specified at the ad level overrides the setting at the ad group level.

    See Using Upgraded URLs for more information. If tracking template is not set, then tracking template will default to "{lpurl}" (no tracking).

Inherited from Builder[MobileApp]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped