Class: Advertisement

GoBrain.Dtos. Advertisement

GoBrain.Core/src/dtos/advertisement.js, line 1
Properties:
Name Type Argument Default Description
clickThroughLink String <optional>

Link that will be shown on mobile devices.

clickThroughLinkText String <optional>
Go to the advertiser's website

Text for clickThroughLink.

companion GoBrain.Dtos.Companion <optional>

Companion ad configuration.

linear Boolean <optional>
true

Indicates whether ad is linear or non linear.

message String <optional>
Your video will resume in xx

Ad countdown message, 'xx' will be replaced by remaining seconds.

name String <optional>

Ad configuration name. Must be unique among all ad configurations. If not specified a unique id will be generated.

offset String <optional>
pre

When the ad should appear. Options include 'pre', 'mid', 'post', number of seconds, percentage of video or a timestamp.

provider String <optional>
vast

Which playback provider to use. Valid options are 'vast' or 'googima'.

skipMessage String <optional>
Skip ad in xx

Skip message, 'xx' will be replaced by remaining seconds.

skipOffset Number <optional>

After how many seconds skipping the ad is allowed.

skipText String <optional>
Skip ad

Text to show when the ad is skippable.

type String <optional>
tag

Which type of ad response is used.

url String

Ad url.