Struct google_api_proto::google::cloud::discoveryengine::v1::TransactionInfo

pub struct TransactionInfo {
    pub value: Option<f32>,
    pub currency: String,
    pub transaction_id: String,
    pub tax: Option<f32>,
    pub cost: Option<f32>,
    pub discount_value: Option<f32>,
}

A transaction represents the entire purchase transaction.

Fields

value: Option<f32>

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.

currency: String

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

transaction_id: String

The transaction ID with a length limit of 128 characters.

tax: Option<f32>

All the taxes associated with the transaction.

cost: Option<f32>

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][google.cloud.discoveryengine.v1.TransactionInfo.value] - [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] - [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost]

discount_value: Option<f32>

The total discount(s) value applied to this transaction. This figure should be excluded from [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]

For example, if a user paid [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value] amount, then nominal (pre-discount) value of the transaction is the sum of [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value] and [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value]

This means that profit is calculated the same way, regardless of the discount value, and that [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value] can be larger than [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]:

• Profit = [value][google.cloud.discoveryengine.v1.TransactionInfo.value] - [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] - [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost]

Implementations

impl TransactionInfo

pub fn value(&self) -> f32

Returns the value of value, or the default value if value is unset.

pub fn tax(&self) -> f32

Returns the value of tax, or the default value if tax is unset.

pub fn cost(&self) -> f32

Returns the value of cost, or the default value if cost is unset.

pub fn discount_value(&self) -> f32

Returns the value of discount_value, or the default value if discount_value is unset.

Trait Implementations

impl Clone for TransactionInfo

fn clone(&self) -> TransactionInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransactionInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TransactionInfo

fn default() -> Self

Returns the “default value” for a type.

impl Message for TransactionInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TransactionInfo

fn eq(&self, other: &TransactionInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TransactionInfo