AdsApp.​InStreamAdBuilder

Builder for an in-stream video ad under construction.

Methods:

MemberTypeDescription
build AdsApp.VideoAdOperation Creates an in-stream video ad.
withActionHeadline AdsApp.InStreamAdBuilder Sets the headline of the call-to-action of the ad.
withAdName AdsApp.InStreamAdBuilder Sets the video ad name.
withCallToAction AdsApp.InStreamAdBuilder Sets the call-to-action of the ad.
withCompanionBanner AdsApp.InStreamAdBuilder Sets the image that will be used as customized companion banner.
withCustomParameters AdsApp.InStreamAdBuilder Sets the custom parameters of the new video ad to the specified value.
withDisplayUrl AdsApp.InStreamAdBuilder Sets the website address that appears on the ad.
withFinalUrl AdsApp.InStreamAdBuilder Sets the final URL of the new video ad to the specified value.
withMobileFinalUrl AdsApp.InStreamAdBuilder Sets the mobile final URL of the new video ad to the specified value.
withTrackingTemplate AdsApp.InStreamAdBuilder Sets the tracking template of the new video ad to the specified value.
withVideo AdsApp.InStreamAdBuilder Sets the YouTube video that this ad will be built on.

build()

Creates an in-stream 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
AdsApp.VideoAdOperation The associated ad operation.

withActionHeadline(headline)

Sets the headline of the call-to-action of the ad. This field is optional.

Arguments:

NameTypeDescription
headline String The headline text that appears on the ad.

Return values:

TypeDescription
AdsApp.InStreamAdBuilder Ad builder with the specified call-to-action headline.

withAdName(adName)

Sets the video ad name. This field is required.

Arguments:

NameTypeDescription
adName String The video ad name.

Return values:

TypeDescription
AdsApp.InStreamAdBuilder Ad builder with the specified video ad name.

withCallToAction(callToAction)

Sets the call-to-action of the ad. This field is optional.

Arguments:

NameTypeDescription
callToAction String The call-to-action text that appears on the ad.

Return values:

TypeDescription
AdsApp.InStreamAdBuilder Ad builder with the specified call-to-action.

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:

NameTypeDescription
image AdsApp.Asset The image that this ad will use as customized companion banner.

Return values:

TypeDescription
AdsApp.InStreamAdBuilder 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 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:

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
AdsApp.InStreamAdBuilder 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
AdsApp.InStreamAdBuilder 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.

Refer to Using Upgraded URLs for more information. This field is required.

Arguments:

NameTypeDescription
finalUrl String The final URL for the video ad.

Return values:

TypeDescription
AdsApp.InStreamAdBuilder The video ad builder with the specified final URL.

withMobileFinalUrl(mobileFinalUrl)

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

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

Return values:

TypeDescription
AdsApp.InStreamAdBuilder 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. 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 video ad.

Return values:

TypeDescription
AdsApp.InStreamAdBuilder The video ad builder with the specified tracking template.

withVideo(video)

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

Arguments:

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

Return values:

TypeDescription
AdsApp.InStreamAdBuilder Ad builder with the specified video.