Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTransactionInfo

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

Overview

A transaction represents the entire purchase transaction.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaTransactionInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaTransactionInfo.



10152
10153
10154
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10152

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) 


10117
10118
10119
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10117

def cost
  @cost
end

#currency ⇒ String

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

Returns:

  • (String) 


10122
10123
10124
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10122

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) 


10133
10134
10135
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10133

def discount_value
  @discount_value
end

#tax ⇒ Float

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

Returns:

  • (Float) 


10138
10139
10140
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10138

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) 


10143
10144
10145
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10143

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) 


10150
10151
10152
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10150

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10157

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