Interface TransactionInfoOrBuilder (0.48.0)

public interface TransactionInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCost()

public abstract float getCost()

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

optional float cost = 5;

Returns
Type Description
float

The cost.

getCurrency()

public abstract String getCurrency()

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

string currency = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The currency.

getCurrencyBytes()

public abstract ByteString getCurrencyBytes()

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

string currency = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for currency.

getDiscountValue()

public abstract float getDiscountValue()

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

optional float discount_value = 6;

Returns
Type Description
float

The discountValue.

getTax()

public abstract float getTax()

All the taxes associated with the transaction.

optional float tax = 4;

Returns
Type Description
float

The tax.

getTransactionId()

public abstract String getTransactionId()

The transaction ID with a length limit of 128 characters.

string transaction_id = 3;

Returns
Type Description
String

The transactionId.

getTransactionIdBytes()

public abstract ByteString getTransactionIdBytes()

The transaction ID with a length limit of 128 characters.

string transaction_id = 3;

Returns
Type Description
ByteString

The bytes for transactionId.

getValue()

public abstract float getValue()

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.

optional float value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
float

The value.

hasCost()

public abstract boolean hasCost()

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

optional float cost = 5;

Returns
Type Description
boolean

Whether the cost field is set.

hasDiscountValue()

public abstract boolean hasDiscountValue()

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

optional float discount_value = 6;

Returns
Type Description
boolean

Whether the discountValue field is set.

hasTax()

public abstract boolean hasTax()

All the taxes associated with the transaction.

optional float tax = 4;

Returns
Type Description
boolean

Whether the tax field is set.

hasValue()

public abstract boolean hasValue()

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.

optional float value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the value field is set.