Unity专用SDK(PC、网页端) / 在应用程序侧集成SDK
  返回文档

Unity专用SDK(PC、网页端)

在应用程序侧集成SDK

一般信息

  1. 设计应用程序的登录系统、游戏内商店及其他页面的界面。
  2. 使用SDK方法在应用程序中实现用户认证商店显示购买等逻辑。

注:
您可以按照Unity说明中的信息创建自己的解决方案,也可以将演示场景用作模板。要根据自己的应用程序调整演示场景UI,请使用UI生成器

快速指南

以下是最简单的游戏内销售方案实施说明。

交互流程:

  1. 用户启动游戏。
  2. 该应用程序将启动艾克索拉登录web小部件。
  3. 用户登录到游戏并转到商品目录。
  4. 应用程序从艾克索拉请求商品目录。
  5. 成功接收商品数据后,应用程序将显示商品目录。
  6. 用户点击商品购买按钮。
  7. 应用程序启动购买过程并在浏览器中显示支付UI。
  8. 用户进行支付。
  9. 应用程序关闭支付UI并将支付数据传递给艾克索拉。
  10. 应用程序向日志输出关于支付处理结果的消息。

应用(StoreController脚本)与SDK交互时序图:

场景限制:

  • 现成的艾克索拉登录管理器web小部件用于用户授权。艾克索拉提供标准小组件模板。它们的外观和内容取决于您在发布商帐户中为项目所选的登录方式小组件自定义设置
注:
小组件自定义仅在签署艾克索拉产品许可协议后可用。要签署该协议,请前往您发布商帐户中的协议与税务信息 > 协议部分。
  • 该场景仅使用真实货币销售商品,不使用购物车,即用户只能购买一件商品。

创建商品小组件脚本

创建一个名为VirtualItemWidget的新脚本:

  1. 在Unity Editor中打开您的项目。
  2. 在主菜单中,前往Assets > Create > C# Script
  3. Assets文件夹中的新文件的名称指定为VirtualItemWidget
  4. 在编辑器中打开创建的文件,并向其中添加以下代码:
Copy
Full screen
Small screen
using UnityEngine;
using UnityEngine.UI;

namespace Xsolla.Example
{
    public class VirtualItemWidget : MonoBehaviour
    {
       public Image IconImage;
       public Text NameText;
       public Text DescriptionText;
       public Text PriceText;
       public Button BuyButton;
    }
}
  1. 保存更改。

创建商品小组件预制体

创建UI以在商店中显示商品:

  1. 创建一个Canvas对象来显示UI元素。方法是在主菜单中转到GameObject > UI > Canvas。这将在场景中创建以下对象:
    • 带有CanvasCanvas Scaler以及Graphic Raycaster组件的Canvas对象。
    • 如果场景中不存在此类对象,则为EventSystem对象。
  2. 创建VirtualItemWidget子对象:
    1. Hierarchy面板中,选择Canvas对象。
    2. 在主菜单中,前往GameObject > UI > Image。这将创建一个新的游戏对象,该对象将是Canvas对象的子对象。
    3. 将创建的对象重命名为VirtualItemWidget
  3. 添加UI对象以显示商品信息:
    1. 创建一个对象以显示小部件图标:
      1. Hierarchy面板中,选择VirtualItemWidget对象。
      2. 在主菜单中,前往GameObject > UI > Image
      3. 将创建的对象重命名为IconImage
    1. 创建一个对象以显示商品名称:
      1. Hierarchy面板中,选择VirtualItemWidget对象。
      2. 在主菜单中,前往GameObject > UI > Legacy > Text
      3. 将创建的对象重命名为NameText
    1. 创建一个对象以显示商品说明:
      1. Hierarchy面板中,选择VirtualItemWidget对象。
      2. 在主菜单中,前往GameObject > UI > Legacy > Text
      3. 将创建的对象重命名为DescriptionText
    1. 为商品购买按钮创建对象:
      1. Hierarchy面板中,选择VirtualItemWidget对象。
      2. 在主菜单中,前往GameObject > UI > Legacy > Button。这将创建一个带有Text子对象的按钮对象。
      3. 将创建的对象重命名为BuyButton
      4. Text对象重命名为PriceText
  4. 将商品小部件脚本作为组件添加到VirtualItemWidget对象:
    1. Hierarchy面板中选择VirtualItemWidget对象。
    2. Inspector面板中,单击Add Component,然后选择VirtualItemWidget脚本。
  5. 将UI元素分配到所需的脚本插槽:
    1. Hierarchy面板中,选择 VirtualItemWidget对象。
    2. 将子UI对象从Hierarchy面板拖放到Inspector面板中的相应的VirtualItemWidget组件插槽。
  6. 将创建的VirtualItemWidget对象转换为预制件:
    1. Hierarchy面板中,选择VirtualItemWidget对象。
    2. 将对象拖放到Assets文件夹中的Project面板。因此,Assets文件夹中会出现一个新对象,场景中的对象颜色也会变为蓝色。

小组件预制件的示例:

创建商店脚本

创建一个名为StoreController的新脚本:

  1. 在Unity Editor中打开您的项目。
  2. 在主菜单中,前往Assets > Create > C# Script
  3. Assets文件夹中的新文件的名称指定为StoreController
  4. 在编辑器中打开创建的文件,并向其中添加以下代码:
Copy
Full screen
Small screen
using System.Linq;
using UnityEngine;
using Xsolla.Auth;
using Xsolla.Catalog;
using Xsolla.Core;
namespace Xsolla.Example
{
	public class StoreController : MonoBehaviour
	{
		[SerializeField] private VirtualItemWidget WidgetPrefab;
		[SerializeField] private Transform WidgetsContainer;
		private void Start()
		{
			StartAuthorization();
		}
		private void StartAuthorization()
		{
			Debug.Log("Start the authorization process with the Xsolla Login Widget");
			XsollaAuth.AuthWithXsollaWidget(OnAuthSuccess, OnError, null);
		}
		private void OnAuthSuccess()
		{
			Debug.Log("Authorization successful");
			Debug.Log("Get the catalog of virtual items");
			XsollaCatalog.GetItems(OnCatalogReceived, OnError);
		}
		private void OnCatalogReceived(StoreItems items)
		{
			Debug.Log("Catalog received successfully");
			BuildStoreUI(items.items);
		}
		private void BuildStoreUI(StoreItem[] items)
		{
			// Create a widget for each item in the catalog
			foreach (var item in items)
			{
				// Check if the item has a price for real money. If not, skip the item (e.g., it is a virtual currency)
				if (item.price == null)
					continue;
				// Instantiate a widget prefab
				var widget = Instantiate(WidgetPrefab, WidgetsContainer, false);
				// Fill the widget with data
				widget.NameText.text = item.name;
				widget.DescriptionText.text = item.description;
				widget.PriceText.text = $"{item.price.amount} {item.price.currency}";
				// Loading the item image and assigning it to the UI element
				ImageLoader.LoadSprite(item.image_url, sprite => widget.IconImage.sprite = sprite);
				// Add a click listener to the Buy button
				widget.BuyButton.onClick.AddListener(() => StartPurchase(item.sku));
			}
		}
		private void StartPurchase(string sku)
		{
			Debug.Log($"Start the purchase process for the item: {sku}");
			XsollaCatalog.Purchase(sku, OnPurchaseCompleted, OnError);
		}
		private void OnPurchaseCompleted(OrderStatus status)
		{
			Debug.Log("Purchase completed");
		}
		private void OnError(Error error)
		{
			Debug.LogError($"Error message: {error.errorMessage}");
		}
	}
}
  1. 保存更改。

创建商店对象

创建UI以在商店中显示商品列表:

  1. 添加一个组件,在网格中排列单个商品的小部件,管理嵌套对象的位置和大小。方法是:
    1. Hierarchy面板中,选择Canvas对象。
    2. Inspector面板中,单击Add Component并选择Grid Layout Group脚本。
    3. Inspector面板中,必要时更改组件设置:设置单元格大小、间距等。
注:
我们建议制作VirtualItemWidget对象的多个副本,以获得更好的可视化效果和更轻松的配置。这使您可以立即评估商店的总体布局。
  1. 将商店小部件脚本作为组件添加到Canvas对象:
    1. Hierarchy面板中选择Canvas对象。
    2. Inspector面板中,单击Add Component,然后选择StoreController脚本。
  2. 将元素分配到所需的StoreController脚本插槽:
    1. Hierarchy面板中,选择 Canvas对象。
    2. Canvas对象从Hierarchy面板拖放到Inspector面板中的WidgetsContainer插槽。
    3. VirtualItemWidget对象从Hierarchy面板拖放到Inspector面板中的WidgetPrefab插槽。

商店对象的示例:

启动和测试商店

在Unity Editor中启动商店并检查其操作:

  1. 对于Canvas对象,删除所有子对象。
  2. 单击Play。这样,当应用程序启动时,就会打开一个带有艾克索拉登录部件的浏览器窗口。
  1. 登录到应用程序。用户授权成功后,应用程序将从艾克索拉请求商品目录。成功接收商品数据后,应用程序将创建必要的小部件。而后,显示商店商品列表。
  1. 点击任何商品部件中的购买按钮。应用程序就会启动购买流程,并在浏览器中显示支付UI。
  1. 完成购买过程。使用测试卡进行支付。购买成功后,日志中会显示Purchase completed消息。
本文对您的有帮助吗?
谢谢!
我们还有其他可改进之处吗? 留言
非常抱歉
请说明为何本文没有帮助到您。 留言
感谢您的反馈!
我们会查看您的留言并运用它改进用户体验。

有用链接

上次更新时间: 2025年2月7日

发现了错别字或其他内容错误? 请选择文本,然后按Ctrl+Enter。

报告问题
我们非常重视内容质量。您的反馈将帮助我们做得更好。
请留下邮箱以便我们后续跟进
感谢您的反馈!