Class: Google::Cloud::DiscoveryEngine::V1::TransactionInfo

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::TransactionInfo

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/user_event.rb

Overview

A transaction represents the entire purchase transaction.

Instance Attribute Summary

• #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 Attribute Details

#cost ⇒ ::Float

Returns 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.

Returns:

• (::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

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 417

class TransactionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#currency ⇒ ::String

Returns Required. Currency code. Use three-character ISO-4217 code.

Returns:

• (::String) —

  Required. Currency code. Use three-character ISO-4217 code.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 417

class TransactionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#discount_value ⇒ ::Float

Returns 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.

Returns:

• (::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

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 417

class TransactionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#tax ⇒ ::Float

Returns All the taxes associated with the transaction.

Returns:

• (::Float) —

  All the taxes associated with the transaction.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 417

class TransactionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction_id ⇒ ::String

Returns The transaction ID with a length limit of 128 characters.

Returns:

• (::String) —

  The transaction ID with a length limit of 128 characters.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 417

class TransactionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#value ⇒ ::Float

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 417

class TransactionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end