Class: Google::Apis::DisplayvideoV3::MastheadAd
- Inherits:
-
Object
- Object
- Google::Apis::DisplayvideoV3::MastheadAd
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/displayvideo_v3/classes.rb,
lib/google/apis/displayvideo_v3/representations.rb,
lib/google/apis/displayvideo_v3/representations.rb
Overview
Details for a Masthead Ad.
Instance Attribute Summary collapse
-
#autoplay_video_duration ⇒ String
The duration of time the video will autoplay.
-
#autoplay_video_start_millisecond ⇒ Fixnum
The amount of time in milliseconds after which the video will start to play.
-
#call_to_action_button_label ⇒ String
The text on the call-to-action button.
-
#call_to_action_final_url ⇒ String
The destination URL for the call-to-action button.
-
#call_to_action_tracking_url ⇒ String
The tracking URL for the call-to-action button.
-
#companion_youtube_videos ⇒ Array<Google::Apis::DisplayvideoV3::YoutubeVideoDetails>
The videos that appear next to the Masthead Ad on desktop.
-
#description ⇒ String
The description of the ad.
-
#headline ⇒ String
The headline of the ad.
-
#show_channel_art ⇒ Boolean
(also: #show_channel_art?)
Whether to show a background or banner that appears at the top of a YouTube page.
-
#video ⇒ Google::Apis::DisplayvideoV3::YoutubeVideoDetails
Details of a YouTube video.
-
#video_aspect_ratio ⇒ String
The aspect ratio of the autoplaying YouTube video on the Masthead.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MastheadAd
constructor
A new instance of MastheadAd.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ MastheadAd
Returns a new instance of MastheadAd.
9454 9455 9456 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9454 def initialize(**args) update!(**args) end |
Instance Attribute Details
#autoplay_video_duration ⇒ String
The duration of time the video will autoplay.
Corresponds to the JSON property autoplayVideoDuration
9399 9400 9401 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9399 def autoplay_video_duration @autoplay_video_duration end |
#autoplay_video_start_millisecond ⇒ Fixnum
The amount of time in milliseconds after which the video will start to play.
Corresponds to the JSON property autoplayVideoStartMillisecond
9404 9405 9406 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9404 def autoplay_video_start_millisecond @autoplay_video_start_millisecond end |
#call_to_action_button_label ⇒ String
The text on the call-to-action button.
Corresponds to the JSON property callToActionButtonLabel
9409 9410 9411 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9409 def @call_to_action_button_label end |
#call_to_action_final_url ⇒ String
The destination URL for the call-to-action button.
Corresponds to the JSON property callToActionFinalUrl
9414 9415 9416 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9414 def call_to_action_final_url @call_to_action_final_url end |
#call_to_action_tracking_url ⇒ String
The tracking URL for the call-to-action button.
Corresponds to the JSON property callToActionTrackingUrl
9419 9420 9421 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9419 def call_to_action_tracking_url @call_to_action_tracking_url end |
#companion_youtube_videos ⇒ Array<Google::Apis::DisplayvideoV3::YoutubeVideoDetails>
The videos that appear next to the Masthead Ad on desktop. Can be no more than
two.
Corresponds to the JSON property companionYoutubeVideos
9425 9426 9427 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9425 def companion_youtube_videos @companion_youtube_videos end |
#description ⇒ String
The description of the ad.
Corresponds to the JSON property description
9430 9431 9432 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9430 def description @description end |
#headline ⇒ String
The headline of the ad.
Corresponds to the JSON property headline
9435 9436 9437 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9435 def headline @headline end |
#show_channel_art ⇒ Boolean Also known as: show_channel_art?
Whether to show a background or banner that appears at the top of a YouTube
page.
Corresponds to the JSON property showChannelArt
9441 9442 9443 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9441 def show_channel_art @show_channel_art end |
#video ⇒ Google::Apis::DisplayvideoV3::YoutubeVideoDetails
Details of a YouTube video.
Corresponds to the JSON property video
9447 9448 9449 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9447 def video @video end |
#video_aspect_ratio ⇒ String
The aspect ratio of the autoplaying YouTube video on the Masthead.
Corresponds to the JSON property videoAspectRatio
9452 9453 9454 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9452 def video_aspect_ratio @video_aspect_ratio end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9459 def update!(**args) @autoplay_video_duration = args[:autoplay_video_duration] if args.key?(:autoplay_video_duration) @autoplay_video_start_millisecond = args[:autoplay_video_start_millisecond] if args.key?(:autoplay_video_start_millisecond) @call_to_action_button_label = args[:call_to_action_button_label] if args.key?(:call_to_action_button_label) @call_to_action_final_url = args[:call_to_action_final_url] if args.key?(:call_to_action_final_url) @call_to_action_tracking_url = args[:call_to_action_tracking_url] if args.key?(:call_to_action_tracking_url) @companion_youtube_videos = args[:companion_youtube_videos] if args.key?(:companion_youtube_videos) @description = args[:description] if args.key?(:description) @headline = args[:headline] if args.key?(:headline) @show_channel_art = args[:show_channel_art] if args.key?(:show_channel_art) @video = args[:video] if args.key?(:video) @video_aspect_ratio = args[:video_aspect_ratio] if args.key?(:video_aspect_ratio) end |