Builder for a responsive video ad.
Methods:
build()
Creates a responsive video ad. Returns a
VideoAdOperation that can be used to get the
new ad (or access any associated errors if creation failed).
Return values:
withAdName(adName)
Sets the video ad name. This field is required.
Arguments:
| Name | Type | Description |
|---|
| adName |
String |
The video ad name. |
Return values:
withBreadcrumb1(breadcrumb1)
Sets the first breadcrumb that appears with the new video ad's displayed URL.
Arguments:
| Name | Type | Description |
|---|
| breadcrumb1 |
String |
The text of the first breadcrumb. |
Return values:
withBreadcrumb2(breadcrumb2)
Sets the second breadcrumb that appears with the new video ad's displayed URL.
Arguments:
| Name | Type | Description |
|---|
| breadcrumb2 |
String |
The text of the second breadcrumb. |
Return values:
withCallToAction(callToAction)
Sets the call-to-action of the new video ad to the specified value. This field is required.
Arguments:
| Name | Type | Description |
|---|
| callToAction |
String |
The call-to-action for the video ad. |
Return values:
withCompanionBanner(image)
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:
| Name | Type | Description |
|---|
| image |
AdsApp.Asset |
The image that this ad will use as customized companion banner. |
Return values:
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 custom parameters specified at the ad level override the
setting at the ad group level.
See Using Upgraded URLs for
more information.
Arguments:
| Name | Type | Description |
|---|
| customParameters |
Object |
The custom parameters of the video ad as a map of the
following form: {key1: 'value1', key2: 'value2', key3: 'value3'}. |
Return values:
withDescription(description)
Sets the description of the new video ad to the specified value. This field is required.
Arguments:
| Name | Type | Description |
|---|
| description |
String |
The description for the video ad. |
Return values:
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 redirects
have taken place.
Refer to Using Upgraded URLs
for more information. This field is required.
Arguments:
| Name | Type | Description |
|---|
| finalUrl |
String |
The final URL for the video ad. |
Return values:
withFinalUrlSuffix(suffix)
Sets the final URL suffix of the new video ad to the specified value.
When parallel tracking is
enabled, the final URL suffix gets appended to the final URL.
Arguments:
| Name | Type | Description |
|---|
| suffix |
String |
The final URL suffix to set on the video ad. |
Return values:
withHeadline(headline)
Sets the headline of the new video ad to the specified value.
Arguments:
| Name | Type | Description |
|---|
| headline |
String |
The headline for the video ad. |
Return values:
withLongHeadline(longHeadline)
Sets the long headline of the new video ad to the specified value. This field is required.
Arguments:
| Name | Type | Description |
|---|
| longHeadline |
String |
The long headline for the video ad. |
Return values:
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. 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:
| Name | Type | Description |
|---|
| trackingTemplate |
String |
The tracking template for the video ad. |
Return values:
withVideo(video)
Sets the YouTube video that this ad will be built on. This field is required.
Arguments:
Return values:
