Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTransactionInfo

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

Overview

A transaction represents the entire purchase transaction.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaTransactionInfo

Returns a new instance of GoogleCloudDiscoveryengineV1betaTransactionInfo.



1571
1572
1573
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1571

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) 


1536
1537
1538
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1536

def cost
  @cost
end

#currency ⇒ String

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

Returns:

  • (String) 


1541
1542
1543
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1541

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) 


1552
1553
1554
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1552

def discount_value
  @discount_value
end

#tax ⇒ Float

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

Returns:

  • (Float) 


1557
1558
1559
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1557

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) 


1562
1563
1564
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1562

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) 


1569
1570
1571
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1569

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1576
1577
1578
1579
1580
1581
1582
1583
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1576

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