与其他 Unity 服务集成
Integrate Cloud Code with various Unity Gaming Services using C# Software Development Kits or REST APIs.
阅读时间5 分钟最后更新于 1 个月前
为了充分发挥 Cloud Code 的潜力，您可以使用 C# Service SDK 或 REST API 将其与各种 Unity Gaming Services（Unity 游戏服务）无缝集成。 C# SDK 提供了更简单、更一致的体验，可以方便地访问 Unity Gaming Services（Unity 游戏服务）。如果您希望使用的 Unity Gaming Services（Unity 游戏服务）已经有 Cloud Code C# SDK，您可以利用它实现更顺畅的集成。但是，如果特定 UGS 服务缺少 Cloud Code C# SDK，您可以灵活地通过其 REST API 直接与其连接。
通过 UGS SDK 连接到 UGS
要从 NuGet 访问 Cloud Code C# 服务 SDK，请搜索 Com.Unity.Services.CloudCode.Apis。安装该包后，您可以在 C# 模块中使用该包来简化与其他 Unity 服务的连接方式。注意
注意：Cloud Code C# SDK 的文档尚未完成。如需了解更多信息，可以参阅 JavaScript 文档，其具有类似的结构。此外，请利用集成开发环境的自动补全和智能感知功能。
API 客户端
GameApiClientAdminApiClient使用 GameApiClient 类
GameApiClientGameApiClientICloudCodeSetupGameApiClientpublic class ModuleConfig : ICloudCodeSetup{ public void Setup(ICloudCodeConfig config) { config.Dependencies.AddSingleton(GameApiClient.Create()); }}
用法示例
您可以在归属于CloudCodeFunctionGameApiClientGameApiClientIGameApiClientusing Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Logging;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Shared;using Unity.Services.CloudSave.Model;namespace ExampleModule;public class CloudSaveSdkSample{ private static ILogger<CloudSaveSdkSample> _logger; public CloudSaveSdkSample(ILogger<CloudSaveSdkSample> logger) { _logger = logger; } [CloudCodeFunction("SaveData")] public async Task SaveData(IExecutionContext context, IGameApiClient gameApiClient, string key, object value) { try { await gameApiClient.CloudSaveData.SetItemAsync(context, context.AccessToken, context.ProjectId, context.PlayerId, new SetItemBody(key, value)); } catch (ApiException ex) { _logger.LogError("Failed to save data. Error: {Error}", ex.Message); throw new Exception($"Failed to save data for playerId {context.PlayerId}. Error: {ex.Message}"); } } [CloudCodeFunction("GetData")] public async Task<object> GetData(IExecutionContext context, IGameApiClient gameApiClient, string key) { try { var result = await gameApiClient.CloudSaveData.GetItemsAsync(context, context.AccessToken, context.ProjectId, context.PlayerId, new List<string> { key }); return result.Data.Results.First().Value; } catch (ApiException ex) { _logger.LogError("Failed to get data. Error: {Error}", ex.Message); throw new Exception($"Failed to get data for playerId {context.PlayerId}. Error: {ex.Message}"); } } public class ModuleConfig : ICloudCodeSetup { public void Setup(ICloudCodeConfig config) { config.Dependencies.AddSingleton(GameApiClient.Create()); } }}
使用 AdminApiClient 类
AdminApiClientAdminApiClientICloudCodeSetupAdminApiClientpublic class ModuleConfig : ICloudCodeSetup{ public void Setup(ICloudCodeConfig config) { config.Dependencies.AddSingleton(AdminApiClient.Create()); }}
用法示例
与GameApiClientAdminApiClientAdminApiClientIAdminApiClient注意
注意：要通过 Admin SDK 使用管理功能，您需要一些具有 项目角色的有效服务帐户凭据。要创建服务帐户，请参阅管理员身份验证。
Leaderboards Admin重要
警告：此 Cloud Code 示例演示了如何使用硬编码的纯文本服务帐户凭据。处理凭据和包含密钥的代码时，请务必小心谨慎。为了确保安全，建议您不要将密钥提交到版本控制系统。如果您的凭据被泄露，您可以立即重新生成您的服务帐户凭据。目前正在开发一种在 Cloud Code 中存储凭据的更安全的方法。
using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Logging;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Apis.Admin;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Shared;using Unity.Services.Leaderboards.Admin.Model;namespace ExampleModule;public class ModuleMain{ private static ILogger<ModuleMain> _logger; public ModuleMain(ILogger<ModuleMain> logger) { _logger = logger; } [CloudCodeFunction("CreateLeaderboard")] public async Task CreateLeaderboard(IExecutionContext context, IAdminApiClient adminApiClient) { try { await adminApiClient.Leaderboards.CreateLeaderboardAsync( executionContext: context, serviceAccountKey: "YOUR_SERVICE_ACCOUNT_KEY", serviceAccountSecret: "YOUR_SERVICE_ACCOUNT_SECRET", projectId: Guid.Parse(context.ProjectId), environmentId: Guid.Parse(context.EnvironmentId), leaderboardIdConfig: new LeaderboardIdConfig( id: "new-leaderboard", name: "new-leaderboard", sortOrder: SortOrder.Asc, updateType: UpdateType.KeepBest ) ); } catch (ApiException ex) { _logger.LogError("Failed to create a Leaderboard. Error: {Error}", ex.Message); throw new Exception($"Failed to create a Leaderboard. Error: {ex.Message}"); } } public class ModuleConfig : ICloudCodeSetup { public void Setup(ICloudCodeConfig config) { config.Dependencies.AddSingleton(AdminApiClient.Create()); } }}
通过 REST API 连接到 UGS
如果要使用尚无 C# SDK 的服务，也可以通过 REST API 直接与服务进行连接。身份验证
根据您的用例，您可以使用AccessTokenServiceTokenServiceToken注意
注意：如果要调用的服务提供了 Cloud Code C# SDK，则可以使用该 SDK，而不是直接调用服务 API。如需了解更多信息，请参阅可用库列表。
调用 API
通过依赖项注入可以将 API 接口创建为单例，并将它们注入到模块中。注意
除了 UGS API 之外，还可以将外部 API 实现为单例。如需查看如何实现外部 API 的示例，请参阅有关如何与外部服务集成的文档。