Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TransactionInfo

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1TransactionInfo

Returns a new instance of GoogleCloudDiscoveryengineV1TransactionInfo.



8192
8193
8194
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8192

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#costFloat

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)


8157
8158
8159
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8157

def cost
  @cost
end

#currencyString

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

Returns:

  • (String)


8162
8163
8164
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8162

def currency
  @currency
end

#discount_valueFloat

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)


8173
8174
8175
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8173

def discount_value
  @discount_value
end

#taxFloat

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

Returns:

  • (Float)


8178
8179
8180
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8178

def tax
  @tax
end

#transaction_idString

The transaction ID with a length limit of 128 characters. Corresponds to the JSON property transactionId

Returns:

  • (String)


8183
8184
8185
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8183

def transaction_id
  @transaction_id
end

#valueFloat

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)


8190
8191
8192
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8190

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8197
8198
8199
8200
8201
8202
8203
8204
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8197

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