Class: Google::Apis::DisplayvideoV1::LineItem

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



5480
5481
5482
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5480

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) 


5350
5351
5352
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5350

def advertiser_id
  @advertiser_id
end

#bid_strategy ⇒ Google::Apis::DisplayvideoV1::BiddingStrategy

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

Returns:



5355
5356
5357
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5355

def bid_strategy
  @bid_strategy
end

#budget ⇒ Google::Apis::DisplayvideoV1::LineItemBudget

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

Returns:



5360
5361
5362
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5360

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) 


5365
5366
5367
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5365

def campaign_id
  @campaign_id
end

#conversion_counting ⇒ Google::Apis::DisplayvideoV1::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:



5372
5373
5374
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5372

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


5377
5378
5379
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5377

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) 


5383
5384
5385
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5383

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) 


5394
5395
5396
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5394

def entity_status
  @entity_status
end

#flight ⇒ Google::Apis::DisplayvideoV1::LineItemFlight

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

Returns:



5399
5400
5401
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5399

def flight
  @flight
end

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



5405
5406
5407
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5405

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) 


5411
5412
5413
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5411

def insertion_order_id
  @insertion_order_id
end

#integration_details ⇒ Google::Apis::DisplayvideoV1::IntegrationDetails

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

Returns:



5416
5417
5418
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5416

def integration_details
  @integration_details
end

#inventory_source_ids ⇒ Array<Fixnum>

The IDs of the private inventory sources assigned to the line item. Corresponds to the JSON property inventorySourceIds

Returns:

  • (Array<Fixnum>) 


5421
5422
5423
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5421

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


5426
5427
5428
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5426

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) 


5431
5432
5433
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5431

def line_item_type
  @line_item_type
end

#mobile_app ⇒ Google::Apis::DisplayvideoV1::MobileApp

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

Returns:



5436
5437
5438
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5436

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) 


5441
5442
5443
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5441

def name
  @name
end

#pacing ⇒ Google::Apis::DisplayvideoV1::Pacing

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

Returns:



5446
5447
5448
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5446

def pacing
  @pacing
end

#partner_costs ⇒ Array<Google::Apis::DisplayvideoV1::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:



5453
5454
5455
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5453

def partner_costs
  @partner_costs
end

#partner_revenue_model ⇒ Google::Apis::DisplayvideoV1::PartnerRevenueModel

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

Returns:



5458
5459
5460
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5458

def partner_revenue_model
  @partner_revenue_model
end

#targeting_expansion ⇒ Google::Apis::DisplayvideoV1::TargetingExpansionConfig

Settings that control the targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. Corresponds to the JSON property targetingExpansion

Returns:



5465
5466
5467
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5465

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) 


5471
5472
5473
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5471

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


5478
5479
5480
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5478

def warning_messages
  @warning_messages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5485

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