Перейти к основному содержимому

Товары и покупки

RockRimStore

Класс RockRimStore предоставляет API для работы с магазином проекта: получение товаров, управление покупками и израсходование приобретённых товаров.


Методы

GetItems

Возвращает список всех доступных товаров магазина.

public static void GetItems(
Action<List<StoreItem>> onComplete,
Action<Error> onError
)

Параметры

ИмяТипОписание
onCompleteAction<List>Вызывается при успешном получении списка товаров
onErrorAction<Error>Вызывается при возникновении ошибки

GetPurchases

Возвращает список покупок пользователя.

public static void GetPurchases(
Action<List<PurchaseInfo>> onComplete,
Action<Error> onError,
PurchaseFilter purchasesFilter = PurchaseFilter.IsNotConsumed
)

Параметры

ИмяТипОписание
onCompleteAction<List<PurchaseInfo>>Вызывается при успешном получении списка покупок
onErrorAction<Error>Вызывается при возникновении ошибки
purchasesFilterPurchaseFilterФильтр покупок

Purchase

Запускает процесс покупки товара.

public static void Purchase(
string itemName,
Action<PurchaseCheckout> onComplete,
Action<Error> onError
)

Примечание
При вызове метода из редактора Unity покупка не выполняется реально, а эмулируется, после чего сразу вызывается колбэк onComplete.

Параметры

ИмяТипОписание
itemNamestringУникальное название товара
onCompleteAction<PurchaseCheckout>Вызывается при успешной оплате товара
onErrorAction<Error>Вызывается при возникновении ошибки

Consume

Израсходует ранее приобретённый товар.

public static void Consume(
string itemName,
Action<PurchaseInfo> onComplete,
Action<Error> onError
)

Параметры

ИмяТипОписание
itemNamestringУникальное название товара
onCompleteAction<PurchaseCheckout>Вызывается при успешной оплате товара
onErrorAction<Error>Вызывается при возникновении ошибки

Примечание
При вызове метода из редактора Unity израсходование не выполняется реально, а эмулируется, после чего сразу вызывается колбэк onComplete.


Классы

StoreItem

Класс StoreItem описывает элемент магазина (товар), содержащий базовую информацию о продукте: идентификатор, название, цену и тип. Используется как неизменяемая (read-only) структура данных после создания экземпляра.

Описание полей

ПолеТипОписание
IdstringУникальный идентификатор товара
NamestringУникальное название товара
DisplayNamestringОтображаемое название товара
DescriptionstringОписание товара
PriceintСтоимость товара

PurchaseInfo


Класс PurchaseInfo содержит информацию о покупке товара и используется для хранения и передачи данных о транзакции, полученных от магазина или платёжного провайдера. Объект является неизменяемым после создания.

Описание полей

ПолеТипОписание
IdstringУникальный идентификатор покупки
ItemIdstringУникальный идентификатор приобретённого товара
ItemNamestringУникальное название приобретённого товара
CreatedAtstringДата и время создания покупки
IsConsumedboolПризнак того, что покупка была израсходована
ProviderstringПлатёжный провайдер
SourcestringИсточник покупки
StatusstringТекущий статус покупки
UpdatedAtstringДата и время последнего обновления статуса покупки

PurchaseCheckout

Класс PurchaseCheckout представляет краткую информацию о результате оформления покупки (checkout). Используется для передачи итогового статуса покупки после завершения процесса оплаты.


Описание полей

ПолеТипОписание
PurchaseIdstringИдентификатор созданной покупки
ItemNamestringУникальное название приобретённого товара
StatusstringИтоговый статус оформления покупки

Error

Класс Error описывает структуру ошибки, возвращаемой SDK при выполнении операций.

Описание полей

ПолеТипОписание
StatusCodestringКод ошибки или статус ответа.
ErrorMessagestringТекстовое описание ошибки.
ErrorTypeErrorTypeТип ошибки.