Class: Google::Apis::DisplayvideoV2::LineItem

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v2/classes.rb,
lib/google/apis/displayvideo_v2/representations.rb,
lib/google/apis/displayvideo_v2/representations.rb

Overview

A single line item.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LineItem

Returns a new instance of LineItem.



6849
6850
6851
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6849

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

Instance Attribute Details

#advertiser_id ⇒ Fixnum

Output only. The unique ID of the advertiser the line item belongs to. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


6680
6681
6682
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6680

def advertiser_id
  @advertiser_id
end

#bid_strategy ⇒ Google::Apis::DisplayvideoV2::BiddingStrategy

Settings that control the bid strategy. Bid strategy determines the bid price. Corresponds to the JSON property bidStrategy

Returns:



6685
6686
6687
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6685

def bid_strategy
  @bid_strategy
end

#budget ⇒ Google::Apis::DisplayvideoV2::LineItemBudget

Settings that control how budget is allocated. Corresponds to the JSON property budget

Returns:



6690
6691
6692
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6690

def budget
  @budget
end

#campaign_id ⇒ Fixnum

Output only. The unique ID of the campaign that the line item belongs to. Corresponds to the JSON property campaignId

Returns:

  • (Fixnum) 


6695
6696
6697
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6695

def campaign_id
  @campaign_id
end

#contains_eu_political_ads ⇒ String

Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING in the parent advertiser, then this field will be assigned DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, the advertisers.lineItems.create request will fail. Corresponds to the JSON property containsEuPoliticalAds

Returns:

  • (String) 


6706
6707
6708
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6706

def contains_eu_political_ads
  @contains_eu_political_ads
end

#conversion_counting ⇒ Google::Apis::DisplayvideoV2::ConversionCountingConfig

Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. Corresponds to the JSON property conversionCounting

Returns:



6713
6714
6715
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6713

def conversion_counting
  @conversion_counting
end

#creative_ids ⇒ Array<Fixnum>

The IDs of the creatives associated with the line item. Corresponds to the JSON property creativeIds

Returns:

  • (Array<Fixnum>) 


6718
6719
6720
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6718

def creative_ids
  @creative_ids
end

#demand_gen_settings ⇒ Google::Apis::DisplayvideoV2::DemandGenSettings

Settings for Demand Gen line items. Corresponds to the JSON property demandGenSettings

Returns:



6723
6724
6725
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6723

def demand_gen_settings
  @demand_gen_settings
end

#display_name ⇒ String

Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


6729
6730
6731
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6729

def display_name
  @display_name
end

#entity_status ⇒ String

Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only ENTITY_STATUS_DRAFT is allowed. To activate a line item, use UpdateLineItem method and update the status to ENTITY_STATUS_ACTIVE after creation. * A line item cannot be changed back to ENTITY_STATUS_DRAFT status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is ENTITY_STATUS_ACTIVE. Corresponds to the JSON property entityStatus

Returns:

  • (String) 


6740
6741
6742
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6740

def entity_status
  @entity_status
end

#exclude_new_exchanges ⇒ Boolean Also known as: exclude_new_exchanges?

Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. Corresponds to the JSON property excludeNewExchanges

Returns:

  • (Boolean) 


6746
6747
6748
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6746

def exclude_new_exchanges
  @exclude_new_exchanges
end

#flight ⇒ Google::Apis::DisplayvideoV2::LineItemFlight

Settings that control the active duration of a line item. Corresponds to the JSON property flight

Returns:



6752
6753
6754
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6752

def flight
  @flight
end

#frequency_cap ⇒ Google::Apis::DisplayvideoV2::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 frequencyCap

Returns:



6758
6759
6760
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6758

def frequency_cap
  @frequency_cap
end

#insertion_order_id ⇒ Fixnum

Required. Immutable. The unique ID of the insertion order that the line item belongs to. Corresponds to the JSON property insertionOrderId

Returns:

  • (Fixnum) 


6764
6765
6766
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6764

def insertion_order_id
  @insertion_order_id
end

#integration_details ⇒ Google::Apis::DisplayvideoV2::IntegrationDetails

Integration details of an entry. Corresponds to the JSON property integrationDetails

Returns:



6769
6770
6771
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6769

def integration_details
  @integration_details
end

#line_item_id ⇒ Fixnum

Output only. The unique ID of the line item. Assigned by the system. Corresponds to the JSON property lineItemId

Returns:

  • (Fixnum) 


6774
6775
6776
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6774

def line_item_id
  @line_item_id
end

#line_item_type ⇒ String

Required. Immutable. The type of the line item. Corresponds to the JSON property lineItemType

Returns:

  • (String) 


6779
6780
6781
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6779

def line_item_type
  @line_item_type
end

#mobile_app ⇒ Google::Apis::DisplayvideoV2::MobileApp

A mobile app promoted by a mobile app install line item. Corresponds to the JSON property mobileApp

Returns:



6784
6785
6786
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6784

def mobile_app
  @mobile_app
end

#name ⇒ String

Output only. The resource name of the line item. Corresponds to the JSON property name

Returns:

  • (String) 


6789
6790
6791
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6789

def name
  @name
end

#optimize_fixed_bidding ⇒ Boolean Also known as: optimize_fixed_bidding?

Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to false, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a bidding_strategy of type FIXED_BID. Corresponds to the JSON property optimizeFixedBidding

Returns:

  • (Boolean) 


6800
6801
6802
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6800

def optimize_fixed_bidding
  @optimize_fixed_bidding
end

#pacing ⇒ Google::Apis::DisplayvideoV2::Pacing

Settings that control the rate at which a budget is spent. Corresponds to the JSON property pacing

Returns:



6806
6807
6808
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6806

def pacing
  @pacing
end

#partner_costs ⇒ Array<Google::Apis::DisplayvideoV2::PartnerCost>

The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order. Corresponds to the JSON property partnerCosts

Returns:



6813
6814
6815
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6813

def partner_costs
  @partner_costs
end

#partner_revenue_model ⇒ Google::Apis::DisplayvideoV2::PartnerRevenueModel

Settings that control how partner revenue is calculated. Corresponds to the JSON property partnerRevenueModel

Returns:



6818
6819
6820
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6818

def partner_revenue_model
  @partner_revenue_model
end

#reservation_type ⇒ String

Output only. The reservation type of the line item. Corresponds to the JSON property reservationType

Returns:

  • (String) 


6823
6824
6825
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6823

def reservation_type
  @reservation_type
end

#targeting_expansion ⇒ Google::Apis::DisplayvideoV2::TargetingExpansionConfig

Settings that control the optimized targeting settings of the line item. Corresponds to the JSON property targetingExpansion

Returns:



6829
6830
6831
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6829

def targeting_expansion
  @targeting_expansion
end

#update_time ⇒ String

Output only. The timestamp when the line item was last updated. Assigned by the system. Corresponds to the JSON property updateTime

Returns:

  • (String) 


6835
6836
6837
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6835

def update_time
  @update_time
end

#warning_messages ⇒ Array<String>

Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. Corresponds to the JSON property warningMessages

Returns:

  • (Array<String>) 


6842
6843
6844
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6842

def warning_messages
  @warning_messages
end

#youtube_and_partners_settings ⇒ Google::Apis::DisplayvideoV2::YoutubeAndPartnersSettings

Settings for YouTube and Partners line items. Corresponds to the JSON property youtubeAndPartnersSettings

Returns:



6847
6848
6849
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6847

def youtube_and_partners_settings
  @youtube_and_partners_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6854

def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @bid_strategy = args[:bid_strategy] if args.key?(:bid_strategy)
  @budget = args[:budget] if args.key?(:budget)
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
  @contains_eu_political_ads = args[:contains_eu_political_ads] if args.key?(:contains_eu_political_ads)
  @conversion_counting = args[:conversion_counting] if args.key?(:conversion_counting)
  @creative_ids = args[:creative_ids] if args.key?(:creative_ids)
  @demand_gen_settings = args[:demand_gen_settings] if args.key?(:demand_gen_settings)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_status = args[:entity_status] if args.key?(:entity_status)
  @exclude_new_exchanges = args[:exclude_new_exchanges] if args.key?(:exclude_new_exchanges)
  @flight = args[:flight] if args.key?(:flight)
  @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap)
  @insertion_order_id = args[:insertion_order_id] if args.key?(:insertion_order_id)
  @integration_details = args[:integration_details] if args.key?(:integration_details)
  @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
  @line_item_type = args[:line_item_type] if args.key?(:line_item_type)
  @mobile_app = args[:mobile_app] if args.key?(:mobile_app)
  @name = args[:name] if args.key?(:name)
  @optimize_fixed_bidding = args[:optimize_fixed_bidding] if args.key?(:optimize_fixed_bidding)
  @pacing = args[:pacing] if args.key?(:pacing)
  @partner_costs = args[:partner_costs] if args.key?(:partner_costs)
  @partner_revenue_model = args[:partner_revenue_model] if args.key?(:partner_revenue_model)
  @reservation_type = args[:reservation_type] if args.key?(:reservation_type)
  @targeting_expansion = args[:targeting_expansion] if args.key?(:targeting_expansion)
  @update_time = args[:update_time] if args.key?(:update_time)
  @warning_messages = args[:warning_messages] if args.key?(:warning_messages)
  @youtube_and_partners_settings = args[:youtube_and_partners_settings] if args.key?(:youtube_and_partners_settings)
end