Trait

com.google.appsscript.adwords

AdBuilder

Related Doc: package adwords

Permalink

trait AdBuilder extends Object with Builder[Ad] with BuilderWithCustomParameters

Builder for an ad under construction.

Typical usage: 

 var adOperation = adGroup.newTextAdBuilder()
    .withHeadline("headline of ad")
    .withDescription1("first line of ad description")
    .withDescription2("second line of ad description")
    .withDisplayUrl("www.example.com")
    .withFinalUrl("http://www.example.com")
    .build();
 var ad = adOperation.getResult();

Note that it is only necessary to call AdOperation.getResult() if you need to access the actual ad for further processing (for instance, one can attach a label to the newly created ad), otherwise, calling AdBuilder.build() on the AdBuilder is sufficient to ensure that the ad is created.

Annotations
@RawJSType()
Linear Supertypes
BuilderWithCustomParameters, Builder[Ad], Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdBuilder
  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[Ad]

    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 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

  27. def withDescription1(description1: String): AdBuilder

    Permalink

    Sets the first line of the new ad's description to the specified value.

    Sets the first line of the new ad's description to the specified value. This field is required.

  28. def withDescription2(description2: String): AdBuilder

    Permalink

    Sets the second line of the new ad's description to the specified value.

    Sets the second line of the new ad's description to the specified value. This field is required.

  29. def withDestinationUrl(destinationUrl: String): AdBuilder

    Permalink

    Sets the destination URL of the new ad to the specified value.

    Sets the destination URL of the new ad to the specified value. It is required to set either destination URL or final URL . <aside class="warning"> Deprecated. This method will be sunset when destination URLs become read-only on July 1, 2015. Please use AdBuilder.withFinalUrl instead. See Using Upgraded URLs for more information. </aside>

  30. def withDisplayUrl(displayUrl: String): AdBuilder

    Permalink

    Sets the display URL of the new ad to the specified value.

    Sets the display URL of the new ad to the specified value. This field is required.

  31. def withFinalUrl(finalUrl: String): AdBuilder

    Permalink

    Sets the final URL of the new ad to the specified value.

    Sets the final URL of the new ad to the specified value.

    The final URL represents the actual landing page for your ad. 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. This field is required.

  32. def withHeadline(headline: String): AdBuilder

    Permalink

    Sets the headline of the new ad to the specified value.

    Sets the headline of the new ad to the specified value. This field is required.

  33. def withMobileFinalUrl(mobileFinalUrl: String): AdBuilder

    Permalink

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

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

    The mobile final URL represents the actual landing page for your ad 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.

  34. def withMobilePreferred(isMobilePreferred: Boolean): AdBuilder

    Permalink

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

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

  35. def withTrackingTemplate(trackingTemplate: String): AdBuilder

    Permalink

    Sets the tracking template of the new ad to the specified value.

    Sets the tracking template of the new ad 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.

Inherited from BuilderWithCustomParameters

Inherited from Builder[Ad]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped