Interface PurchaseTransactionOrBuilder (0.54.0)

Version 0.54.0

• 0.60.0 (latest)
• 0.59.0
• 0.58.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.4
• 0.8.10

public interface PurchaseTransactionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCosts(String key)

public abstract boolean containsCosts(String key)

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.

map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsTaxes(String key)

public abstract boolean containsTaxes(String key)

Optional. All the taxes associated with the transaction.

map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCosts() (deprecated)

public abstract Map<String,Float> getCosts()

Use #getCostsMap() instead.

Returns
Type	Description
Map<String,Float>

getCostsCount()

public abstract int getCostsCount()

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.

map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getCostsMap()

public abstract Map<String,Float> getCostsMap()

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.

map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,Float>

getCostsOrDefault(String key, float defaultValue)

public abstract float getCostsOrDefault(String key, float defaultValue)

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.

map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	float

Returns
Type	Description
float

getCostsOrThrow(String key)

public abstract float getCostsOrThrow(String key)

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.

map<string, float> costs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
float

getCurrencyCode()

public abstract String getCurrencyCode()

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

string currency_code = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The currencyCode.

getCurrencyCodeBytes()

public abstract ByteString getCurrencyCodeBytes()

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

string currency_code = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for currencyCode.

getId()

public abstract String getId()

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

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

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

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for id.

getRevenue()

public abstract float getRevenue()

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.

float revenue = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
float	The revenue.

getTaxes() (deprecated)

public abstract Map<String,Float> getTaxes()

Use #getTaxesMap() instead.

Returns
Type	Description
Map<String,Float>

getTaxesCount()

public abstract int getTaxesCount()

Optional. All the taxes associated with the transaction.

map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getTaxesMap()

public abstract Map<String,Float> getTaxesMap()

Optional. All the taxes associated with the transaction.

map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,Float>

getTaxesOrDefault(String key, float defaultValue)

public abstract float getTaxesOrDefault(String key, float defaultValue)

Optional. All the taxes associated with the transaction.

map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	float

Returns
Type	Description
float

getTaxesOrThrow(String key)

public abstract float getTaxesOrThrow(String key)

Optional. All the taxes associated with the transaction.

map<string, float> taxes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
float