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.
7534 7535 7536 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7534 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
7499 7500 7501 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7499 def cost @cost end |
#currency ⇒ String
Required. Currency code. Use three-character ISO-4217 code.
Corresponds to the JSON property currency
7504 7505 7506 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7504 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
7515 7516 7517 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7515 def discount_value @discount_value end |
#tax ⇒ Float
All the taxes associated with the transaction.
Corresponds to the JSON property tax
7520 7521 7522 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7520 def tax @tax end |
#transaction_id ⇒ String
The transaction ID with a length limit of 128 characters.
Corresponds to the JSON property transactionId
7525 7526 7527 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7525 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
7532 7533 7534 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7532 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7539 7540 7541 7542 7543 7544 7545 7546 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7539 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 |