com.google.api.services.androidpublisher.model

Class Order

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.androidpublisher.model.Order

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Order
extends com.google.api.client.json.GenericJson

The Order resource encapsulates comprehensive information about a transaction made on Google Play. It includes a variety of attributes that provide details about the order itself, the products purchased, and the history of events related to the order. The Orders APIs provide real- time access to your order data within the Google Play ecosystem. You can retrieve detailed information and metadata for both one-time and recurring orders, including transaction details like charges, taxes, and refunds, as well as metadata such as pricing phases for subscriptions. The Orders APIs let you automate tasks related to order management, reducing the need for manual checks via the Play Developer Console. The following are some of the use cases for this API: + Real-time order data retrieval - Get order details and metadata immediately after a purchase using an order ID. + Order update synchronization - Periodically sync order updates to maintain an up-to-date record of order information. Note: + The Orders API calls count towards your Play Developer API quota, which defaults to 200K daily, and may be insufficient to sync extensive order histories. + A maximum of 1000 orders can be retrieved per call. Using larger page sizes is recommended to minimize quota usage. Check your quota in the Cloud Console and request more if required.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Android Developer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Order()

Method Summary

Modifier and Type	Method and Description
Order	clone()
BuyerAddress	getBuyerAddress() Address information for the customer, for use in tax computation.
String	getCreateTime() The time when the order was created.
Money	getDeveloperRevenueInBuyerCurrency() Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees.
String	getLastEventTime() The time of the last event that occurred on the order.
List<LineItem>	getLineItems() The individual line items making up this order.
OrderDetails	getOrderDetails() Detailed information about the order at creation time.
OrderHistory	getOrderHistory() Details about events which modified the order.
String	getOrderId() The order ID.
PointsDetails	getPointsDetails() Play points applied to the order, including offer information, discount rate and point values.
String	getPurchaseToken() The token provided to the user's device when the subscription or item was purchased.
String	getState() The state of the order.
Money	getTax() The total tax paid as a part of this order.
Money	getTotal() The final amount paid by the customer, taking into account discounts and taxes.
Order	set(String fieldName, Object value)
Order	setBuyerAddress(BuyerAddress buyerAddress) Address information for the customer, for use in tax computation.
Order	setCreateTime(String createTime) The time when the order was created.
Order	setDeveloperRevenueInBuyerCurrency(Money developerRevenueInBuyerCurrency) Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees.
Order	setLastEventTime(String lastEventTime) The time of the last event that occurred on the order.
Order	setLineItems(List<LineItem> lineItems) The individual line items making up this order.
Order	setOrderDetails(OrderDetails orderDetails) Detailed information about the order at creation time.
Order	setOrderHistory(OrderHistory orderHistory) Details about events which modified the order.
Order	setOrderId(String orderId) The order ID.
Order	setPointsDetails(PointsDetails pointsDetails) Play points applied to the order, including offer information, discount rate and point values.
Order	setPurchaseToken(String purchaseToken) The token provided to the user's device when the subscription or item was purchased.
Order	setState(String state) The state of the order.
Order	setTax(Money tax) The total tax paid as a part of this order.
Order	setTotal(Money total) The final amount paid by the customer, taking into account discounts and taxes.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Order

public Order()

Method Detail

getBuyerAddress

public BuyerAddress getBuyerAddress()

Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown.

Returns:

value or null for none

setBuyerAddress

public Order setBuyerAddress(BuyerAddress buyerAddress)

Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown.

Parameters:

buyerAddress - buyerAddress or null for none

getCreateTime

public String getCreateTime()

The time when the order was created.

Returns:

value or null for none

setCreateTime

public Order setCreateTime(String createTime)

The time when the order was created.

Parameters:

createTime - createTime or null for none

getDeveloperRevenueInBuyerCurrency

public Money getDeveloperRevenueInBuyerCurrency()

Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions.

Returns:

value or null for none

setDeveloperRevenueInBuyerCurrency

public Order setDeveloperRevenueInBuyerCurrency(Money developerRevenueInBuyerCurrency)

Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions.

Parameters:

developerRevenueInBuyerCurrency - developerRevenueInBuyerCurrency or null for none

getLastEventTime

public String getLastEventTime()

The time of the last event that occurred on the order.

Returns:

value or null for none

setLastEventTime

public Order setLastEventTime(String lastEventTime)

The time of the last event that occurred on the order.

Parameters:

lastEventTime - lastEventTime or null for none

getLineItems

public List<LineItem> getLineItems()

The individual line items making up this order.

Returns:

value or null for none

setLineItems

public Order setLineItems(List<LineItem> lineItems)

The individual line items making up this order.

Parameters:

lineItems - lineItems or null for none

getOrderDetails

public OrderDetails getOrderDetails()

Detailed information about the order at creation time.

Returns:

value or null for none

setOrderDetails

public Order setOrderDetails(OrderDetails orderDetails)

Detailed information about the order at creation time.

Parameters:

orderDetails - orderDetails or null for none

getOrderHistory

public OrderHistory getOrderHistory()

Details about events which modified the order.

Returns:

value or null for none

setOrderHistory

public Order setOrderHistory(OrderHistory orderHistory)

Details about events which modified the order.

Parameters:

orderHistory - orderHistory or null for none

getOrderId

public String getOrderId()

The order ID.

Returns:

value or null for none

setOrderId

public Order setOrderId(String orderId)

The order ID.

Parameters:

orderId - orderId or null for none

getPointsDetails

public PointsDetails getPointsDetails()

Play points applied to the order, including offer information, discount rate and point values.

Returns:

value or null for none

setPointsDetails

public Order setPointsDetails(PointsDetails pointsDetails)

Play points applied to the order, including offer information, discount rate and point values.

Parameters:

pointsDetails - pointsDetails or null for none

getPurchaseToken

public String getPurchaseToken()

The token provided to the user's device when the subscription or item was purchased.

Returns:

value or null for none

setPurchaseToken

public Order setPurchaseToken(String purchaseToken)

The token provided to the user's device when the subscription or item was purchased.

Parameters:

purchaseToken - purchaseToken or null for none

getState

public String getState()

The state of the order.

Returns:

value or null for none

setState

public Order setState(String state)

The state of the order.

Parameters:

state - state or null for none

getTax

public Money getTax()

The total tax paid as a part of this order.

Returns:

value or null for none

setTax

public Order setTax(Money tax)

The total tax paid as a part of this order.

Parameters:

tax - tax or null for none

getTotal

public Money getTotal()

The final amount paid by the customer, taking into account discounts and taxes.

Returns:

value or null for none

setTotal

public Order setTotal(Money total)

The final amount paid by the customer, taking into account discounts and taxes.

Parameters:

total - total or null for none

set

public Order set(String fieldName,
                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Order clone()

Overrides:

clone in class com.google.api.client.json.GenericJson