Class: Google::Apis::DisplayvideoV3::YoutubeAndPartnersSettings

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

Settings for YouTube and Partners line items.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ YoutubeAndPartnersSettings

Returns a new instance of YoutubeAndPartnersSettings.



12783
12784
12785
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12783

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

Instance Attribute Details

#content_category ⇒ String

The kind of content on which the YouTube and Partners ads will be shown. Corresponds to the JSON property contentCategory

Returns:

  • (String) 


12728
12729
12730
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12728

def content_category
  @content_category
end

#effective_content_category ⇒ String

Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item. Corresponds to the JSON property effectiveContentCategory

Returns:

  • (String) 


12735
12736
12737
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12735

def effective_content_category
  @effective_content_category
end

#inventory_source_settings ⇒ Google::Apis::DisplayvideoV3::YoutubeAndPartnersInventorySourceConfig

Settings that control what YouTube related inventories the YouTube and Partners line item will target. Corresponds to the JSON property inventorySourceSettings

Returns:



12741
12742
12743
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12741

def inventory_source_settings
  @inventory_source_settings
end

#lead_form_id ⇒ Fixnum

Optional. The ID of the form to generate leads. Corresponds to the JSON property leadFormId

Returns:

  • (Fixnum) 


12746
12747
12748
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12746

def lead_form_id
  @lead_form_id
end

#linked_merchant_id ⇒ Fixnum

Optional. The ID of the merchant which is linked to the line item for product feed. Corresponds to the JSON property linkedMerchantId

Returns:

  • (Fixnum) 


12752
12753
12754
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12752

def linked_merchant_id
  @linked_merchant_id
end

#related_video_ids ⇒ Array<String>

Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. Corresponds to the JSON property relatedVideoIds

Returns:

  • (Array<String>) 


12758
12759
12760
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12758

def related_video_ids
  @related_video_ids
end

#target_frequency ⇒ Google::Apis::DisplayvideoV3::TargetFrequency

Setting that controls the average number of times the ads will show to the same person over a certain period of time. Corresponds to the JSON property targetFrequency

Returns:



12764
12765
12766
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12764

def target_frequency
  @target_frequency
end

#third_party_measurement_configs ⇒ Google::Apis::DisplayvideoV3::ThirdPartyMeasurementConfigs

Settings that control what third-party vendors are measuring specific line item metrics. Corresponds to the JSON property thirdPartyMeasurementConfigs

Returns:



12770
12771
12772
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12770

def third_party_measurement_configs
  @third_party_measurement_configs
end

#video_ad_sequence_settings ⇒ Google::Apis::DisplayvideoV3::VideoAdSequenceSettings

Settings related to VideoAdSequence. Corresponds to the JSON property videoAdSequenceSettings

Returns:



12775
12776
12777
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12775

def video_ad_sequence_settings
  @video_ad_sequence_settings
end

#view_frequency_cap ⇒ Google::Apis::DisplayvideoV3::FrequencyCap

Settings that control the number of times a user may be shown with the same ad during a given time period. Corresponds to the JSON property viewFrequencyCap

Returns:



12781
12782
12783
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12781

def view_frequency_cap
  @view_frequency_cap
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12788

def update!(**args)
  @content_category = args[:content_category] if args.key?(:content_category)
  @effective_content_category = args[:effective_content_category] if args.key?(:effective_content_category)
  @inventory_source_settings = args[:inventory_source_settings] if args.key?(:inventory_source_settings)
  @lead_form_id = args[:lead_form_id] if args.key?(:lead_form_id)
  @linked_merchant_id = args[:linked_merchant_id] if args.key?(:linked_merchant_id)
  @related_video_ids = args[:related_video_ids] if args.key?(:related_video_ids)
  @target_frequency = args[:target_frequency] if args.key?(:target_frequency)
  @third_party_measurement_configs = args[:third_party_measurement_configs] if args.key?(:third_party_measurement_configs)
  @video_ad_sequence_settings = args[:video_ad_sequence_settings] if args.key?(:video_ad_sequence_settings)
  @view_frequency_cap = args[:view_frequency_cap] if args.key?(:view_frequency_cap)
end