Struct gapi_grpc::google::cloud::recommendationengine::v1beta1::PurchaseTransaction

pub struct PurchaseTransaction {
    pub id: String,
    pub revenue: f32,
    pub taxes: HashMap<String, f32>,
    pub costs: HashMap<String, f32>,
    pub currency_code: String,
}

A transaction represents the entire purchase transaction.

Fields

id: String

Optional. The transaction ID with a length limit of 128 bytes.

revenue: f32

Required. Total revenue or grand total associated with the transaction. This value include shipping, tax, or other adjustments to total revenue that you want to include as part of your revenue calculations. This field is not required if the event type is refund.

taxes: HashMap<String, f32>

Optional. All the taxes associated with the transaction.

costs: HashMap<String, f32>

Optional. All the costs associated with the product. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs.

Total product cost such that profit = revenue - (sum(taxes) + sum(costs)) If product_cost is not set, then profit = revenue - tax - shipping - sum(CatalogItem.costs).

If CatalogItem.cost is not specified for one of the items, CatalogItem.cost based profit cannot be calculated for this Transaction.

currency_code: String

Required. Currency code. Use three-character ISO-4217 code. This field is not required if the event type is refund.

Trait Implementations

impl Clone for PurchaseTransaction

fn clone(&self) -> PurchaseTransaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PurchaseTransaction

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

Formats the value using the given formatter.

impl Default for PurchaseTransaction

fn default() -> PurchaseTransaction

Returns the “default value” for a type.

impl Message for PurchaseTransaction

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<PurchaseTransaction> for PurchaseTransaction

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

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

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

This method tests for !=.

impl StructuralPartialEq for PurchaseTransaction