Интеграция с PlayFab
Как это работает
Внимание
Поддерживаемая версия PlayFab API: Economy v1 .
- Импорт каталога товаров из PlayFab в In-Game Store, чтобы пользоваться решениями Xsolla.
- Автоматическая передача товаров, которые пользователь приобретет через In-Game Store, в PlayFab.
Для кого подходит
- Для партнеров, у которых уже интегрирован PlayFab и которые хотят расширить область распространения товаров (виртуальной валюты, виртуальных предметов) через решения Xsolla.
- Для партнеров, которые уже используют решения Xsolla и хотят монетизировать товары в PlayFab (продавать их за реальную валюту).
Правила импорта
При импорте товаров из PlayFab применяется следующая логика:
- Нерасходуемые предметы (durable goods) из PlayFab импортируются как виртуальные предметы (не виртуальная валюта и не бандлы).
- Все товары, а также пакеты виртуальной валюты и товары внутри PlayFab бандла, импортируются как потребляемые (параметр
consumable = true
или не передается). - Виртуальная валюта импортируется в статусе Частично доступен и без указания цены (состояние флагов для API:
is_show_in_store = false
,is_enabled = true
,is_free = true
). - Бандл, содержащий только виртуальную валюту одного типа, импортируется как пакет виртуальной валюты.
- Бандл, содержащий только виртуальную валюту нескольких типов, импортируется в виде нескольких пакетов виртуальной валюты. Для каждой уникальной комбинации артикула и количества создается отдельный бесплатный пакет виртуальной валюты со статусом Частично доступен (состояние флагов для API:
is_show_in_store = false
,is_enabled = true
,is_free = true
). - Бандл, содержащий разные типы товаров импортируется как бандл.
- Если в PlayFab для товара не заполнено поле Description, в качестве описания товара используется Name; если нет Name, используется SKU.
Ограничения при импорте
Ограничения на стороне In-Game Store
- Контейнеры и бандлы, содержащие контейнеры, не импортируются.
- DropTables и бандлы, содержащие DropTables, не импортируются.
- Игнорируются параметры, специфичные для PlayFab:
isStackable
,isTradable
,UsageCount
,UsagePeriod
,UsagePeriodGroup
. - Расходуемые предметы создаются без учета количества использований (предмет исчезает из инвентаря после первого использования).
Ограничения на стороне PlayFab
- PlayFab не хранит цены в реальных валютах. Используется только предустановленная виртуальная валюта с кодом RM (Real money), которая приравнивается к реальной валюте — 1 цент (100 RM = 1 USD). Поэтому у товара можно задать цену либо в виртуальной валюте, либо в RM.
- Артикулы товаров должны быть уникальными и содержать только цифры, латинские буквы, подчеркивания и дефисы.
Как настроить
Импорт каталога из PlayFab
Примечание
Вам понадобится ID проекта и секретный ключ проекта в PlayFab. Также каталог, который вы хотите импортировать в Xsolla, должен быть установлен в PlayFab как базовый (Base).
Если у вас еще не настроен PlayFab:
- Создайте PlayFab-аккаунт.
- Создайте игру.
- Получите уникальный ID игры Title ID.
- Получите PlayFab Secret key.
Перейдите в Личный кабинет и импортируйте каталог товаров из PlayFab в In-Game Store.
Примечание
Вы можете импортировать виртуальные предметы, виртуальную валюту или пакеты виртуальной валюты.
- В вашем проекте в Личном кабинете перейдите в раздел Store > Управление каталогом > Управление каталогом > Интеграция с внешними платформами > PlayFab.
- На вкладке Импорт товаров укажите:
- Title ID — ID проекта в PlayFab.
- Секретный ключ — ключ проекта в PlayFab.
- Нажмите Сохранить.
- Синхронизируйте инвентарь пользователя с PlayFab (опционально):
- Перейдите на вкладку Синхронизация инвентаря и укажите:
- Title ID — ID проекта в PlayFab.
- Секретный ключ — ключ проекта в PlayFab.
- Установите переключатель Синхронизировать инвентарь пользователя с PlayFab в положение Вкл.
- Нажмите Сохранить.
- Перейдите на вкладку Синхронизация инвентаря и укажите:
- Перейдите на вкладку Импорт товаров и нажмите Начать импорт. Импорт каталога начнется автоматически.
- Если вы хотите продавать виртуальные предметы на сайте, созданном с помощью Site Builder, в Личном кабинете создайте группы и укажите для каждого виртуального предмета одну или несколько групп.
- Если вы хотите, чтобы у товаров были изображения, необходимо добавить изображения в Личном кабинете.
Чтобы проверить, успешно ли прошел импорт каталога, перейдите в раздел Store в боковом меню и убедитесь, что предметы, валюта и бандлы доступны на вкладках Виртуальная валюта, Виртуальные предметы и Бандлы.
Внимание
При проверке результатов импорта учитывайте, что пакетом виртуальной валюты считается бандл, который содержит в себе только одну валюту. PlayFab использует виртуальную валюту RM (Real money), которая приравнивается к реальной валюте — 1 цент (100 RM = 1 USD). Например, если вы импортируете из PlayFab 400 RM, в Личном кабинете вы увидите 4 USD.
Повторный импорт каталога
При повторном импорте каталога вам необходимо учитывать следующее:- Товары, которые уже есть в Store, будут обновлены.
- Товары, которые отсутствуют в Store, будут добавлены.Т
- овары, которые уже были удалены из источника импорта, останутся в Store. Вы можете удалить их в Личном кабинете или с помощью API.
Начисление товаров в инвентарь PlayFab
Вы можете настроить начисление товаров, купленных в Xsolla In-Game Store, в инвентарь PlayFab следующими способами:- Через синхронизацию инвентаря Xsolla с инвентарем PlayFab.
- Через интеграцию хранилища пользователей PlayFab с Xsolla Login. В этом случае в токене указывается ID пользователя PlayFab. В случае возврата товара на стороне Xsolla в токене отправляется соответствующий запрос в PlayFab.
Примечание
PlayFab позволяет не задавать название или описание товара. В этом случае в методах API возвращается пустая строка.
Если вы хотите синхронизировать инвентарь пользователя с инвентарем PlayFab:
- В вашем проекте в Личном кабинете перейдите в раздел Store > Управление каталогом > Управление каталогом > Интеграция с внешними платформами > PlayFab.
- Перейдите на вкладку Синхронизация инвентаря и укажите:
- Title ID — уникальный ID игры в PlayFab.Секретный ключ — ключ проекта в PlayFab.
- Установите переключатель Синхронизировать инвентарь пользователя с PlayFab в положение Вкл.
- Нажмите Сохранить.
Теперь информация о купленных во Внутриигровом магазине товарах будет автоматически передаваться в PlayFab.
Была ли статья полезна?
Спасибо за обратную связь!
Ваши мысли и идеи помогут нам улучшить ваш пользовательский опыт.Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.