Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TransactionInfo

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

Overview

A transaction represents the entire purchase transaction.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1TransactionInfo

Returns a new instance of GoogleCloudDiscoveryengineV1TransactionInfo.



7855
7856
7857
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7855

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

Instance Attribute Details

#cost ⇒ Float

All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost Corresponds to the JSON property cost

Returns:

  • (Float) 


7820
7821
7822
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7820

def cost
  @cost
end

#currency ⇒ String

Required. Currency code. Use three-character ISO-4217 code. Corresponds to the JSON property currency

Returns:

  • (String) 


7825
7826
7827
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7825

def currency
  @currency
end

#discount_value ⇒ Float

The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo. discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost Corresponds to the JSON property discountValue

Returns:

  • (Float) 


7836
7837
7838
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7836

def discount_value
  @discount_value
end

#tax ⇒ Float

All the taxes associated with the transaction. Corresponds to the JSON property tax

Returns:

  • (Float) 


7841
7842
7843
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7841

def tax
  @tax
end

#transaction_id ⇒ String

The transaction ID with a length limit of 128 characters. Corresponds to the JSON property transactionId

Returns:

  • (String) 


7846
7847
7848
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7846

def transaction_id
  @transaction_id
end

#value ⇒ Float

Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. Corresponds to the JSON property value

Returns:

  • (Float) 


7853
7854
7855
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7853

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7860
7861
7862
7863
7864
7865
7866
7867
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7860

def update!(**args)
  @cost = args[:cost] if args.key?(:cost)
  @currency = args[:currency] if args.key?(:currency)
  @discount_value = args[:discount_value] if args.key?(:discount_value)
  @tax = args[:tax] if args.key?(:tax)
  @transaction_id = args[:transaction_id] if args.key?(:transaction_id)
  @value = args[:value] if args.key?(:value)
end