Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::TransactionInfo (v1.2.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::TransactionInfo.

A transaction represents the entire purchase transaction.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#cost

def cost() -> ::Float

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

#cost=

def cost=(value) -> ::Float

Parameter

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

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

#currency

def currency() -> ::String

Returns

(::String) — Required. Currency code. Use three-character ISO-4217 code.

#currency=

def currency=(value) -> ::String

Parameter

value (::String) — Required. Currency code. Use three-character ISO-4217 code.

Returns

(::String) — Required. Currency code. Use three-character ISO-4217 code.

#discount_value

def discount_value() -> ::Float

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

#discount_value=

def discount_value=(value) -> ::Float

Parameter

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

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

#tax

def tax() -> ::Float

Returns

(::Float) — All the taxes associated with the transaction.

#tax=

def tax=(value) -> ::Float

Parameter

value (::Float) — All the taxes associated with the transaction.

Returns

(::Float) — All the taxes associated with the transaction.

#transaction_id

def transaction_id() -> ::String

Returns

(::String) — The transaction ID with a length limit of 128 characters.

#transaction_id=

def transaction_id=(value) -> ::String

Parameter

value (::String) — The transaction ID with a length limit of 128 characters.

Returns

(::String) — The transaction ID with a length limit of 128 characters.

#value

def value() -> ::Float

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.

#value=

def value=(value) -> ::Float

Parameter

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.

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.