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.



4685
4686
4687
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4685

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) 


4650
4651
4652
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4650

def cost
  @cost
end

#currency ⇒ String

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

Returns:

  • (String) 


4655
4656
4657
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4655

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) 


4666
4667
4668
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4666

def discount_value
  @discount_value
end

#tax ⇒ Float

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

Returns:

  • (Float) 


4671
4672
4673
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4671

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) 


4676
4677
4678
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4676

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) 


4683
4684
4685
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4683

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4690
4691
4692
4693
4694
4695
4696
4697
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4690

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