Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TransactionInfo
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TransactionInfo
- 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
-
#cost ⇒ Float
All the costs associated with the products.
-
#currency ⇒ String
Required.
-
#discount_value ⇒ Float
The total discount(s) value applied to this transaction.
-
#tax ⇒ Float
All the taxes associated with the transaction.
-
#transaction_id ⇒ String
The transaction ID with a length limit of 128 characters.
-
#value ⇒ Float
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1TransactionInfo
constructor
A new instance of GoogleCloudDiscoveryengineV1TransactionInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1TransactionInfo
Returns a new instance of GoogleCloudDiscoveryengineV1TransactionInfo.
8575 8576 8577 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8575 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
8540 8541 8542 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8540 def cost @cost end |
#currency ⇒ String
Required. Currency code. Use three-character ISO-4217 code.
Corresponds to the JSON property currency
8545 8546 8547 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8545 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
8556 8557 8558 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8556 def discount_value @discount_value end |
#tax ⇒ Float
All the taxes associated with the transaction.
Corresponds to the JSON property tax
8561 8562 8563 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8561 def tax @tax end |
#transaction_id ⇒ String
The transaction ID with a length limit of 128 characters.
Corresponds to the JSON property transactionId
8566 8567 8568 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8566 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
8573 8574 8575 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8573 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8580 8581 8582 8583 8584 8585 8586 8587 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8580 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 |