Class: Google::Apis::DisplayvideoV4::YoutubeAndPartnersSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v4/classes.rb,
lib/google/apis/displayvideo_v4/representations.rb,
lib/google/apis/displayvideo_v4/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.



14674
14675
14676
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14674

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

Instance Attribute Details

#content_category ⇒ String

Output only. The kind of content on which the YouTube and Partners ads will be shown. Warning: This field will be removed in the near future. Use effective_content_category instead. Corresponds to the JSON property contentCategory

Returns:

  • (String) 


14613
14614
14615
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14613

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. New line items will only inherit the advertiser level setting. Corresponds to the JSON property effectiveContentCategory

Returns:

  • (String) 


14621
14622
14623
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14621

def effective_content_category
  @effective_content_category
end

#inventory_source_settings ⇒ Google::Apis::DisplayvideoV4::YoutubeAndPartnersInventorySourceConfig

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

Returns:



14627
14628
14629
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14627

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) 


14632
14633
14634
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14632

def lead_form_id
  @lead_form_id
end

#linked_merchant_id ⇒ Fixnum

Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. Corresponds to the JSON property linkedMerchantId

Returns:

  • (Fixnum) 


14638
14639
14640
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14638

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>) 


14644
14645
14646
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14644

def related_video_ids
  @related_video_ids
end

#target_frequency ⇒ Google::Apis::DisplayvideoV4::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:



14650
14651
14652
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14650

def target_frequency
  @target_frequency
end

#third_party_measurement_configs ⇒ Google::Apis::DisplayvideoV4::ThirdPartyMeasurementConfigs

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

Returns:



14656
14657
14658
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14656

def third_party_measurement_configs
  @third_party_measurement_configs
end

#video_ad_inventory_control ⇒ Google::Apis::DisplayvideoV4::VideoAdInventoryControl

The video ad inventory control used in certain YouTube line item types. Corresponds to the JSON property videoAdInventoryControl

Returns:



14661
14662
14663
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14661

def video_ad_inventory_control
  @video_ad_inventory_control
end

#video_ad_sequence_settings ⇒ Google::Apis::DisplayvideoV4::VideoAdSequenceSettings

Settings related to VideoAdSequence. Corresponds to the JSON property videoAdSequenceSettings

Returns:



14666
14667
14668
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14666

def video_ad_sequence_settings
  @video_ad_sequence_settings
end

#view_frequency_cap ⇒ Google::Apis::DisplayvideoV4::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:



14672
14673
14674
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14672

def view_frequency_cap
  @view_frequency_cap
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 14679

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_inventory_control = args[:video_ad_inventory_control] if args.key?(:video_ad_inventory_control)
  @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