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.



7567
7568
7569
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7567

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) 


7426
7427
7428
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7426

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:



7431
7432
7433
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7431

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:



7436
7437
7438
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7436

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) 


7441
7442
7443
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7441

def campaign_id
  @campaign_id
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:



7448
7449
7450
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7448

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


7453
7454
7455
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7453

def creative_ids
  @creative_ids
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) 


7459
7460
7461
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7459

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) 


7470
7471
7472
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7470

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) 


7476
7477
7478
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7476

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:



7482
7483
7484
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7482

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:



7488
7489
7490
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7488

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) 


7494
7495
7496
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7494

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:



7499
7500
7501
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7499

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) 


7504
7505
7506
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7504

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) 


7509
7510
7511
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7509

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:



7514
7515
7516
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7514

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) 


7519
7520
7521
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7519

def name
  @name
end

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

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

Returns:



7524
7525
7526
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7524

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:



7531
7532
7533
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7531

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:



7536
7537
7538
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7536

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) 


7541
7542
7543
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7541

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:



7547
7548
7549
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7547

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) 


7553
7554
7555
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7553

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


7560
7561
7562
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7560

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:



7565
7566
7567
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7565

def youtube_and_partners_settings
  @youtube_and_partners_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 7572

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