Class: Google::Apis::DisplayvideoV1::PartnerCost

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

Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data ( data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PartnerCost

Returns a new instance of PartnerCost.



7929
7930
7931
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7929

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

Instance Attribute Details

#cost_type ⇒ String

Required. The type of the partner cost. Corresponds to the JSON property costType

Returns:

  • (String) 


7900
7901
7902
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7900

def cost_type
  @cost_type
end

#fee_amount ⇒ Fixnum

The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is PARTNER_FEE_TYPE_CPM_FEE. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. Corresponds to the JSON property feeAmount

Returns:

  • (Fixnum) 


7908
7909
7910
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7908

def fee_amount
  @fee_amount
end

#fee_percentage_millis ⇒ Fixnum

The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is PARTNER_FEE_TYPE_MEDIA_FEE. Must be greater than or equal to 0. For example: 100 represents 0.1%. Corresponds to the JSON property feePercentageMillis

Returns:

  • (Fixnum) 


7915
7916
7917
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7915

def fee_percentage_millis
  @fee_percentage_millis
end

#fee_type ⇒ String

Required. The fee type for this partner cost. Corresponds to the JSON property feeType

Returns:

  • (String) 


7920
7921
7922
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7920

def fee_type
  @fee_type
end

#invoice_type ⇒ String

The invoice type for this partner cost. * Required when cost_type is one of: - PARTNER_COST_TYPE_ADLOOX - PARTNER_COST_TYPE_DOUBLE_VERIFY - PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE. * Output only for other types. Corresponds to the JSON property invoiceType

Returns:

  • (String) 


7927
7928
7929
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7927

def invoice_type
  @invoice_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7934
7935
7936
7937
7938
7939
7940
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7934

def update!(**args)
  @cost_type = args[:cost_type] if args.key?(:cost_type)
  @fee_amount = args[:fee_amount] if args.key?(:fee_amount)
  @fee_percentage_millis = args[:fee_percentage_millis] if args.key?(:fee_percentage_millis)
  @fee_type = args[:fee_type] if args.key?(:fee_type)
  @invoice_type = args[:invoice_type] if args.key?(:invoice_type)
end