Class: Google::Apis::DisplayvideoV3::MastheadAd

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MastheadAd

Returns a new instance of MastheadAd.



9476
9477
9478
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9476

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

Returns:

  • (String) 


9421
9422
9423
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9421

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

Returns:

  • (Fixnum) 


9426
9427
9428
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9426

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

Returns:

  • (String) 


9431
9432
9433
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9431

def call_to_action_button_label
  @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

Returns:

  • (String) 


9436
9437
9438
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9436

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

Returns:

  • (String) 


9441
9442
9443
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9441

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

Returns:



9447
9448
9449
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9447

def companion_youtube_videos
  @companion_youtube_videos
end

#description ⇒ String

The description of the ad. Corresponds to the JSON property description

Returns:

  • (String) 


9452
9453
9454
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9452

def description
  @description
end

#headline ⇒ String

The headline of the ad. Corresponds to the JSON property headline

Returns:

  • (String) 


9457
9458
9459
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9457

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

Returns:

  • (Boolean) 


9463
9464
9465
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9463

def show_channel_art
  @show_channel_art
end

#video ⇒ Google::Apis::DisplayvideoV3::YoutubeVideoDetails

Details of a YouTube video. Corresponds to the JSON property video

Returns:



9469
9470
9471
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9469

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

Returns:

  • (String) 


9474
9475
9476
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9474

def video_aspect_ratio
  @video_aspect_ratio
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9481

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