PlaytoliaStore

Methods

Method	Parameters	Returns	Notes
`GetProducts()`	(none)	`List<Product>`	Returns all products in the catalog.
`SearchProducts(query)`	`string`	`List<Product>`	Matches the name, the product code, and the SKU.
`GetProductsByType(type)`	`ProductType`	`List<Product>`	Uses the product types below.
`GetProductByCode(code)`	`string`	`Product?`	Uses your own product code. This method is the first lookup to use.
`GetProductById(id)`	`string`	`Product?`	Uses the UUID from Playtolia.
`GetProductBySku(sku)`	`string`	`Product?`	Uses the SKU of the platform store.
`BeginPurchaseFlowByCode(code, onSuccess?, onError?)`	`string`, `Action<PurchaseReceipt>?`, `Action<PurchaseError>?`	`void`	The callbacks are optional.
`BeginPurchaseFlow(product, onSuccess?, onError?)`	`Product`, `Action<PurchaseReceipt>?`, `Action<PurchaseError>?`	`void`	The callbacks are optional.
`BeginPurchaseFlow(productId, onSuccess?, onError?)`	`string`, `Action<PurchaseReceipt>?`, `Action<PurchaseError>?`	`void`	Uses the UUID, not the code.
`Refresh()`	(none)	`void`	Reads the latest data from the server.
`AddListener(listener)`	`Action`	`void`	Calls the listener on each change of the state.
`RemoveListener(listener)`	`Action`	`void`	Deletes the listener.

Renamed methods

Store items now have the name products. The old names still work, but they are obsolete:

Old	New
`GetItems()`	`GetProducts()`
`SearchItems(query)`	`SearchProducts(query)`
`GetItemsByType(type)`	`GetProductsByType(type)`
`GetItemById(id)`	`GetProductById(id)`
`GetItemBySku(sku)`	`GetProductBySku(sku)`
`StoreItem` (type)	`Product`
`StoreItemType` (type)	`ProductType`

The two new type names are not source-compatible. If you declared variables as StoreItem and not as var, replace these declarations with Product.

Product types (for GetProductsByType)

ProductType.Consumable · ProductType.NonConsumable · ProductType.Subscription The Product.Type field carries the same value as a string: "CONSUMABLE", "NON_CONSUMABLE", "SUBSCRIPTION".

Product

Field	Type	Notes
`Id`	`string`	UUID from Playtolia. The value is opaque, and you must not write it in your code.
`Code`	`string`	The identifier that you give to the product at creation. The value does not change, and it is the same on every platform.
`Name`	`string`
`Description`	`string?`
`Sku`	`string`	Product ID for the App Store or the Play Store. The value is different on each platform.
`Type`	`string`
`Grants`	`Grant[]`	Rewards that the purchase gives to the player

Grant

Field	Type	Notes
`GrantId`	`string`	Groups the related grants
`GrantType`	`string`
`GrantAmount`	`long`
`Currency`	`Currency?`	Not null for currency grants

PurchaseReceipt

The onSuccess callback of BeginPurchaseFlow gives this object.

Field	Type	Notes
`Item`	`Product`	The product that the player bought
`ReceiptId`	`string`	Transaction ID of the platform (purchase token for Google Play, transaction ID for the App Store)
`Store`	`string`	`"google_play"` or `"apple_app_store"`

PurchaseError

The onError callback of BeginPurchaseFlow gives this object.

Field	Type	Notes
`Code`	`string`	Machine-readable error code (see the table below)
`Message`	`string`	Human-readable description
`Stage`	`string`	The step of the flow with the error
`ReceiptId`	`string?`	Has a value for a complete platform purchase with a failure in a later step
`ItemId`	`string?`	Playtolia product ID as a UUID (if known)
`ItemCode`	`string?`	Your product code (if known)
`ItemSku`	`string?`	Platform SKU (if known)

Purchase error codes

Code	Stage	Description
`BILLING_UNAVAILABLE`	`PURCHASE`	Platform billing is not available on this device.
`ITEM_NOT_FOUND`	`PURCHASE`	The SDK state does not contain this product ID or product code.
`USER_CANCELLED`	`PURCHASE`	The player closed the purchase dialog.
`PURCHASE_FAILED`	`PURCHASE`	Platform billing returned an error.
`VERIFICATION_FAILED`	`VERIFICATION`	The purchase verification on the backend failed.
`ACKNOWLEDGEMENT_FAILED`	`ACKNOWLEDGEMENT`	The platform acknowledgement failed after a successful verification.

If Stage is ACKNOWLEDGEMENT, the platform charged the player. The SDK does the acknowledgement again in the background at the next start of the app. You can tell the player that the purchase is in progress.

Auth

Social

Engagement

Billing

Methods

Renamed methods

Product types (for GetProductsByType)

Product

Grant

PurchaseReceipt

PurchaseError

Purchase error codes

​Methods

​Renamed methods

​Product types (for GetProductsByType)

​Product

​Grant

​PurchaseReceipt

​PurchaseError

​Purchase error codes

Methods

Renamed methods

Product types (for GetProductsByType)

Product

Grant

PurchaseReceipt

PurchaseError

Purchase error codes