Class: Google::Apis::DisplayvideoV3::DemandGenVideoAd

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 Demand Gen video ad.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DemandGenVideoAd

Returns a new instance of DemandGenVideoAd.



6640
6641
6642
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6640

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#business_name ⇒ String

Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. Corresponds to the JSON property businessName

Returns:

  • (String) 


6556
6557
6558
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6556

def business_name
  @business_name
end

#call_to_action ⇒ String

Required. The call-to-action button shown on the ad. The supported values are:

  • AUTOMATED * LEARN_MORE * GET_QUOTE * APPLY_NOW * SIGN_UP * CONTACT_US * SUBSCRIBE * DOWNLOAD * BOOK_NOW * SHOP_NOW * BUY_NOW * DONATE_NOW * ORDER_NOW * PLAY_NOW * SEE_MORE * START_NOW * VISIT_SITE * WATCH_NOW Corresponds to the JSON property callToAction

Returns:

  • (String) 


6565
6566
6567
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6565

def call_to_action
  @call_to_action
end

#companion_banner ⇒ Google::Apis::DisplayvideoV3::ImageAsset

Meta data of an image asset. Corresponds to the JSON property companionBanner

Returns:



6570
6571
6572
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6570

def companion_banner
  @companion_banner
end

#custom_parameters ⇒ Hash<String,String>

Optional. The custom parameters and accompanying values to add to the tracking URL. Corresponds to the JSON property customParameters

Returns:

  • (Hash<String,String>) 


6576
6577
6578
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6576

def custom_parameters
  @custom_parameters
end

#descriptions ⇒ Array<String>

Required. The list of descriptions shown on the ad. Corresponds to the JSON property descriptions

Returns:

  • (Array<String>) 


6581
6582
6583
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6581

def descriptions
  @descriptions
end

#display_url_breadcrumb1 ⇒ String

Optional. The first piece after the domain in the display URL. Corresponds to the JSON property displayUrlBreadcrumb1

Returns:

  • (String) 


6586
6587
6588
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6586

def display_url_breadcrumb1
  @display_url_breadcrumb1
end

#display_url_breadcrumb2 ⇒ String

Optional. The second piece after the domain in the display URL. Corresponds to the JSON property displayUrlBreadcrumb2

Returns:

  • (String) 


6591
6592
6593
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6591

def display_url_breadcrumb2
  @display_url_breadcrumb2
end

#final_mobile_url ⇒ String

Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. Corresponds to the JSON property finalMobileUrl

Returns:

  • (String) 


6597
6598
6599
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6597

def final_mobile_url
  @final_mobile_url
end

#final_url ⇒ String

Required. The URL address of the webpage that people reach after they click the ad. Corresponds to the JSON property finalUrl

Returns:

  • (String) 


6603
6604
6605
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6603

def final_url
  @final_url
end

#final_url_suffix ⇒ String

Optional. The suffix to append to landing page URLs. Corresponds to the JSON property finalUrlSuffix

Returns:

  • (String) 


6608
6609
6610
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6608

def final_url_suffix
  @final_url_suffix
end

#headlines ⇒ Array<String>

Required. The list of headlines shown on the ad. Corresponds to the JSON property headlines

Returns:

  • (Array<String>) 


6613
6614
6615
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6613

def headlines
  @headlines
end

#logo ⇒ Google::Apis::DisplayvideoV3::ImageAsset

Meta data of an image asset. Corresponds to the JSON property logo

Returns:



6618
6619
6620
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6618

def 
  @logo
end

#long_headlines ⇒ Array<String>

Required. The list of long headlines shown on the ad. Corresponds to the JSON property longHeadlines

Returns:

  • (Array<String>) 


6623
6624
6625
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6623

def long_headlines
  @long_headlines
end

#tracking_url ⇒ String

Output only. The URL address loaded in the background for tracking purposes. Corresponds to the JSON property trackingUrl

Returns:

  • (String) 


6628
6629
6630
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6628

def tracking_url
  @tracking_url
end

#user_specified_tracking_url ⇒ String

Optional. The tracking URL specified by the user manually. Corresponds to the JSON property userSpecifiedTrackingUrl

Returns:

  • (String) 


6633
6634
6635
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6633

def user_specified_tracking_url
  @user_specified_tracking_url
end

#videos ⇒ Array<Google::Apis::DisplayvideoV3::YoutubeVideoDetails>

Required. The list of YouTube video assets used by this ad. Corresponds to the JSON property videos

Returns:



6638
6639
6640
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6638

def videos
  @videos
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6645

def update!(**args)
  @business_name = args[:business_name] if args.key?(:business_name)
  @call_to_action = args[:call_to_action] if args.key?(:call_to_action)
  @companion_banner = args[:companion_banner] if args.key?(:companion_banner)
  @custom_parameters = args[:custom_parameters] if args.key?(:custom_parameters)
  @descriptions = args[:descriptions] if args.key?(:descriptions)
  @display_url_breadcrumb1 = args[:display_url_breadcrumb1] if args.key?(:display_url_breadcrumb1)
  @display_url_breadcrumb2 = args[:display_url_breadcrumb2] if args.key?(:display_url_breadcrumb2)
  @final_mobile_url = args[:final_mobile_url] if args.key?(:final_mobile_url)
  @final_url = args[:final_url] if args.key?(:final_url)
  @final_url_suffix = args[:final_url_suffix] if args.key?(:final_url_suffix)
  @headlines = args[:headlines] if args.key?(:headlines)
  @logo = args[:logo] if args.key?(:logo)
  @long_headlines = args[:long_headlines] if args.key?(:long_headlines)
  @tracking_url = args[:tracking_url] if args.key?(:tracking_url)
  @user_specified_tracking_url = args[:user_specified_tracking_url] if args.key?(:user_specified_tracking_url)
  @videos = args[:videos] if args.key?(:videos)
end