AdWordsApp.​BumperAdBuilder

Builder for a bumper video ad under construction.

Methods:

MemberTypeDescription
build AdWordsApp.VideoAdOperation Creates a bumper video ad.
withAdName AdWordsApp.BumperAdBuilder Sets the video ad name.
withCompanionBanner AdWordsApp.BumperAdBuilder Sets the image that will be used as customized companion banner.
withCustomParameters AdWordsApp.BumperAdBuilder Sets the custom parameters of the new video ad to the specified value.
withDisplayUrl AdWordsApp.BumperAdBuilder Sets the website address that appears on the ad.
withFinalUrl AdWordsApp.BumperAdBuilder Sets the final URL of the new video ad to the specified value.
withTrackingTemplate AdWordsApp.BumperAdBuilder Sets the tracking template of the new video ad to the specified value.
withVideo AdWordsApp.BumperAdBuilder Sets the YouTube video that this ad will be built on.

build()

Creates a bumper video ad. Returns a VideoAdOperation that can be used to get the new ad (or access any associated errors if creation failed).

Return values:

TypeDescription
AdWordsApp.VideoAdOperation The associated ad operation.

withAdName(adName)

Sets the video ad name. This field is required.

Arguments:

NameTypeDescription
adName String The video ad name.

Return values:

TypeDescription
AdWordsApp.BumperAdBuilder Ad builder with the specified video ad name.

withCompanionBanner(imageMedia)

Sets the image that will be used as customized companion banner. If this field is not specified, an auto-generated image from videos in your channel will be used.

Arguments:

NameTypeDescription
imageMedia AdWordsApp.Media The image that this ad will use as customized companion banner.

Return values:

TypeDescription
AdWordsApp.BumperAdBuilder Ad builder with the customized companion banner.

withCustomParameters(customParameters)

Sets the custom parameters of the new video 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.

Arguments:

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

Return values:

TypeDescription
AdWordsApp.BumperAdBuilder The video ad builder with the specified custom parameters.

withDisplayUrl(displayUrl)

Sets the website address that appears on the ad. This field is required.

Arguments:

NameTypeDescription
displayUrl String The website address that appears on the ad.

Return values:

TypeDescription
AdWordsApp.BumperAdBuilder Ad builder with the specified display URL.

withFinalUrl(finalUrl)

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

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

Return values:

TypeDescription
AdWordsApp.BumperAdBuilder The video ad builder with the specified final URL.

withTrackingTemplate(trackingTemplate)

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

Arguments:

NameTypeDescription
trackingTemplate String The tracking template for the video ad.

Return values:

TypeDescription
AdWordsApp.BumperAdBuilder The video ad builder with the specified tracking template.

withVideo(videoMedia)

Sets the YouTube video that this ad will be built on. This field is required.

Arguments:

NameTypeDescription
videoMedia AdWordsApp.Media The YouTube video that this ad will be built on. Use Media.getYouTubeVideoId() to check if a video is YouTube video.

Return values:

TypeDescription
AdWordsApp.BumperAdBuilder Ad builder with the specified video.

Send feedback about...

AdWords Scripts
AdWords Scripts
Need help? Visit our support page.