AdsApp.​ResponsiveDisplayAdBuilder

Builder for a responsive ad for Display.

Typical usage:

 var image1 = ...
 var image2 = ...
 var image3 = ...
 var squareImage1 = ...
 var squareImage2 = ...
 var adOperation = adGroup.newAd().responsiveDisplayAdBuilder()
   .withHeadlines([
     "Headline 1", "Headline 2"
   ])
   .addHeadline("Headline 3")
   .withDescriptions([
     "Description 1", "Description 2"
   ])
   .addDescription("Description 3")
   .withMarketingImages([
     image1, image2
   ])
   .addMarketingImage(image3)
   .withSquareMarketingImages([
     squareImage1, squareImage2
   ])
   .withFinalUrl("http://www.example.com")
   .withBusinessName("Your Business")
   .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 build() on the builder is sufficient to ensure that the ad is created.

Methods:

MemberTypeDescription
addDescription AdsApp.ResponsiveDisplayAdBuilder Adds the provided description to the current list of descriptions.
addHeadline AdsApp.ResponsiveDisplayAdBuilder Adds the provided headline to the current list of headlines.
addLandscapeLogoImage AdsApp.ResponsiveDisplayAdBuilder Adds the provided landscape logo image to the current list of landscape logo images.
addLogoImage AdsApp.ResponsiveDisplayAdBuilder Adds the provided logo image to the current list of logo images.
addMarketingImage AdsApp.ResponsiveDisplayAdBuilder Adds the provided marketing image to the current list of marketing images.
addSquareMarketingImage AdsApp.ResponsiveDisplayAdBuilder Adds the provided square marketing image to the current list of square marketing images.
addYouTubeVideo AdsApp.ResponsiveDisplayAdBuilder Adds the provided video to the current list of YouTube videos.
build AdsApp.AdOperation Creates a responsive ad for Display.
withBusinessName AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's business name to the specified value.
withCustomParameters AdsApp.ResponsiveDisplayAdBuilder Sets the custom parameters of the new ad to the specified value.
withDescriptions AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's descriptions to the specified value.
withFinalUrl AdsApp.ResponsiveDisplayAdBuilder Sets the final URL of the new ad to the specified value.
withFinalUrlSuffix AdsApp.ResponsiveDisplayAdBuilder Sets the final URL suffix of the new ad to the specified value.
withHeadlines AdsApp.ResponsiveDisplayAdBuilder Sets the list of the new ad's headlines to the specified value.
withLandscapeLogoImages AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's landscape logo images to the specified value.
withLogoImages AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's logo images to the specified value.
withLongHeadline AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's long headline to the specified value.
withMarketingImages AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's marketing images to the specified value.
withMobileFinalUrl AdsApp.ResponsiveDisplayAdBuilder Sets the mobile final URL of the new ad to the specified value.
withSquareMarketingImages AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's square marketing images to the specified value.
withTrackingTemplate AdsApp.ResponsiveDisplayAdBuilder Sets the tracking template of the new ad to the specified value.
withYouTubeVideos AdsApp.ResponsiveDisplayAdBuilder Sets the new ad's YouTube videos to the specified value.

addDescription(description)

Adds the provided description to the current list of descriptions.

Arguments:

NameTypeDescription
description Object The text of the description.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified descriptions.

addHeadline(headline)

Adds the provided headline to the current list of headlines.

Arguments:

NameTypeDescription
headline Object The text of the headline.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified headlines.

addLandscapeLogoImage(image)

Adds the provided landscape logo image to the current list of landscape logo images.

Arguments:

NameTypeDescription
image AdsApp.Asset The landscape logo image.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified landscape logo images.

addLogoImage(image)

Adds the provided logo image to the current list of logo images.

Arguments:

NameTypeDescription
image AdsApp.Asset The logo image.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified logo images.

addMarketingImage(image)

Adds the provided marketing image to the current list of marketing images.

Arguments:

NameTypeDescription
image AdsApp.Asset The marketing image.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified marketing images.

addSquareMarketingImage(image)

Adds the provided square marketing image to the current list of square marketing images.

Arguments:

NameTypeDescription
image AdsApp.Asset The square marketing image.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified square marketing images.

addYouTubeVideo(video)

Adds the provided video to the current list of YouTube videos.

Arguments:

NameTypeDescription
video AdsApp.Asset The YouTube video.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified YouTube videos.

build()

Creates a responsive ad for Display. Returns an AdOperation that can be used to get the new ad (or access any associated errors if creation failed).

Return values:

TypeDescription
AdsApp.AdOperation The associated ad operation.

withBusinessName(businessName)

Sets the new ad's business name to the specified value.

Arguments:

NameTypeDescription
businessName String The business name for the ad.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified business name.

withCustomParameters(customParameters)

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

See Using Upgraded URLs for more information.

Arguments:

NameTypeDescription
customParameters Object The custom parameters of the ad as a map of the following form: {key1: 'value1', key2: 'value2', key3: 'value3'}.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder The ad builder with the specified custom parameters.

withDescriptions(descriptions)

Sets the new ad's descriptions to the specified value.

Arguments:

NameTypeDescription
descriptions Object[] The ad descriptions. These can either be String instances or AdTextAsset instances.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified descriptions.

withFinalUrl(finalUrl)

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.

Arguments:

NameTypeDescription
finalUrl String The final URL for the ad.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder The ad builder with the specified final URL.

withFinalUrlSuffix(suffix)

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

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

Arguments:

NameTypeDescription
suffix String The final URL suffix to set on the ad.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder The ad builder with the specified final URL suffix.

withHeadlines(headlines)

Sets the list of the new ad's headlines to the specified value.

Arguments:

NameTypeDescription
headlines Object[] The headlines for the ad. These can either be String instances or AdTextAsset instances.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified headlines.

withLandscapeLogoImages(images)

Sets the new ad's landscape logo images to the specified value.

Arguments:

NameTypeDescription
images AdsApp.Asset[] The landscape logo images.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified landscape logo images.

withLogoImages(images)

Sets the new ad's logo images to the specified value.

Arguments:

NameTypeDescription
images AdsApp.Asset[] The logo images.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified logo images.

withLongHeadline(longHeadline)

Sets the new ad's long headline to the specified value.

Arguments:

NameTypeDescription
longHeadline String The long headline for the ad.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified long headline.

withMarketingImages(images)

Sets the new ad's marketing images to the specified value.

Arguments:

NameTypeDescription
images AdsApp.Asset[] The marketing images.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified marketing images.

withMobileFinalUrl(mobileFinalUrl)

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.

Arguments:

NameTypeDescription
mobileFinalUrl String The mobile final URL for the ad.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder The ad builder with the specified final URL.

withSquareMarketingImages(images)

Sets the new ad's square marketing images to the specified value.

Arguments:

NameTypeDescription
images AdsApp.Asset[] The square marketing images.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified square marketing images.

withTrackingTemplate(trackingTemplate)

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

NameTypeDescription
trackingTemplate String The tracking template for the ad.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder The ad builder with the specified tracking template.

withYouTubeVideos(videos)

Sets the new ad's YouTube videos to the specified value.

Arguments:

NameTypeDescription
videos AdsApp.Asset[] The YouTube videos.

Return values:

TypeDescription
AdsApp.ResponsiveDisplayAdBuilder Ad builder with the specified YouTube videos.