AdsApp.​ImageAdBuilder

Typical usage:

 var 
  
 adOperation 
  
 = 
  
 adGroup 
 . 
 newAd 
 () 
 . 
 imageAdBuilder 
 () 
  
 . 
 withName 
 ( 
 "Ad name" 
 ) 
  
 . 
 withImage 
 ( 
 image 
 ) 
  
 . 
 withDisplayUrl 
 ( 
 "http://www.example.com" 
 ) 
  
 . 
 withFinalUrl 
 ( 
 "http://www.example.com" 
 ) 
  
 . 
 build 
 (); 
 var 
  
 ad 
  
 = 
  
 adOperation 
 . 
 getResult 
 (); 

Images must meet the format specifications .

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 build() on the builder is sufficient to ensure that the ad is created.

Methods:

build()

Return values:

withCustomParameters(customParameters)

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 8 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 custom parameters specified at the ad level override the setting at the ad group level.

See Using Upgraded URLs for more information.

Arguments:

Return values:

withDisplayUrl(displayUrl)

Arguments:

Return values:

withFinalUrl(finalUrl)

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.

Arguments:

Return values:

withFinalUrlSuffix(suffix)

When parallel tracking is enabled, the final URL suffix gets appended to the final URL.

Arguments:

Return values:

withImage(image)

The image must meet the format's dimension and file size requirements .

Arguments:

Return values:

withMobileFinalUrl(mobileFinalUrl)

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.

Arguments:

Return values:

withName(name)

Arguments:

Return values:

withTrackingTemplate(trackingTemplate)

You can optionally use the tracking template to specify additional tracking parameters or redirects. Google Ads 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.

Arguments:

Return values: