与其他 Unity 服务集成

使用 UGS SDK

data

使用 Cloud Save SDK

读取和写入数据

JavaScript

const _ = require("lodash-4.17");const { DataApi } = require("@unity-services/cloud-save-1.4");module.exports = async ({ params, context, logger }) => {  const { projectId, playerId, accessToken } = context;  const cloudSaveApi = new DataApi(context);  try {    // Default item data, readable and writable by the player    await cloudSaveApi.setItem(projectId, playerId, {      key: "defaultData",      value: "value"    });    // Custom item - non-player entities    // Record any game data!    const customId = "gameLevelAttributes";    await cloudSaveApi.setCustomItem(projectId, customId, {      key: "levelDifficulty",      value: "easy"    });    // Protected data can be read by player, but not written to    await cloudSaveApi.setProtectedItem(projectId, playerId, {      key: "protectedItem",      value: "verySecretData"    });    // Private data that should only be accessed by server/service accounts    await cloudSaveApi.setPrivateCustomItem(projectId, customId, {      key: "levelTimerInMinutes",      value: 25,    });    const result = await cloudSaveApi.getItems(projectId, playerId);    logger.info(`Retrieved default items from Cloud Save: ${JSON.stringify(result.data)}`)    const protectedDataResult = await cloudSaveApi.getProtectedItems(projectId, playerId, ["protectedItem"]);    logger.info(`Retrieved protected item from Cloud Save: ${JSON.stringify(protectedDataResult.data)}`)    const customDataResult = await cloudSaveApi.getPrivateCustomItems(projectId, customId);    logger.info(`Retrieved private custom items from Cloud Save: ${JSON.stringify(customDataResult.data)}`)  } catch (err) {    logger.error("Error while calling out to Cloud Save", { "error.message": err.message });    throw err;  }};

查询数据

• 对于键

  health

  ，对玩家实体进行升序查询，使用默认访问类。
• 对于键

  difficulty

  ，对自定义实体进行降序查询，使用私有访问类。
• 对于键

  level

  ，对玩家实体进行升序查询，使用受保护访问类。

JavaScript

const _ = require("lodash-4.17");const { DataApi } = require("@unity-services/cloud-save-1.4");module.exports = async ({ params, context, logger }) => {  const { projectId, playerId } = context;  const cloudSaveApi = new DataApi(context);  try {    // --------------------------------------------------------------------------------    // Query player data with the key `health` to find players with health lower than 100    // Set data for player    const requestData = {      data: [{        key: "health",        value: 95,      },        {          key: "stamina",          value: 20,        }      ]    };    await cloudSaveApi.setItemBatch(projectId, playerId, requestData);    // Query and return player stamina for players with health less than 100    const query = {      fields: [{        asc: true,        key: 'health',        op: 'LT',        value: 100,      }],      returnKeys: ["stamina"]    };    const queryRes = await cloudSaveApi.queryDefaultPlayerData(projectId, query);    logger.info(`Query results: ${JSON.stringify(queryRes.data)}`)    // --------------------------------------------------------------------------------    // Query private custom data to retrieve game levels with easy difficulty    // Record two levels with different difficulty levels    const casteLevelId = "castleLevel";    const anotherLevelId = "forestLevel";    await cloudSaveApi.setPrivateCustomItem(projectId, casteLevelId, {      key: "difficulty",      value: "easy"    });    await cloudSaveApi.setPrivateCustomItem(projectId, anotherLevelId, {      key: "difficulty",      value: "hard"    });    // Query levels with easy levels only    const privateQuery = {      fields: [{        asc: false,        key: 'difficulty',        op: 'EQ',        value: 'easy'      }],    };    const privateQueryRes = await cloudSaveApi.queryPrivateCustomData(projectId, privateQuery);    logger.info(`Private query results: ${JSON.stringify(privateQueryRes.data)}`)    // --------------------------------------------------------------------------------    // Query protected player data for players that are over level 5    // Set data for player    const protectedRequestData = {      data: [{        key: "level",        value: 15,      },        {          key: "experiencePoints",          value: 20,        }      ]    };    await cloudSaveApi.setProtectedItemBatch(projectId, playerId, protectedRequestData);    // Query players over level 5, and return their health    const protectedPlayerQuery = {      fields: [{        asc: true,        key: 'level',        op: 'GT',        value: 5,      }],      returnKeys: ["experiencePoints", "level"]    };    const protectedPlayerRes = await cloudSaveApi.queryProtectedPlayerData(projectId, protectedPlayerQuery);    logger.info(`Protected player query results: ${JSON.stringify(protectedPlayerRes.data)}`)    // --------------------------------------------------------------------------------  } catch (err) {    logger.error("Error while calling out to Cloud Save", { "error.message": err.message });    throw err;  }};

使用 Economy SDK

• 货币：允许玩家在游戏中拥有一种或多种货币/面额的余额。
• 背包物品：表示在配置过程中创建的资源的定义。玩家可以拥有背包物品的实例（例如，相同的剑、盾牌、帽子的多个副本），与货币不同，您还可以为每个实例指定各自的属性。
• 购买：允许玩家使用其他游戏内货币和背包物品来购买游戏内货币和背包物品（虚拟购买），或通过数字店面用真实资金进行购买。

Economy SDK 玩家背包

SWORD

SWORD

playerId

JavaScript

const { InventoryApi } = require("@unity-services/economy-2.4");module.exports = async ({ params, context, logger }) => {  const { projectId, playerId, accessToken } = context;  const inventory = new InventoryApi({ accessToken });  const addInventoryRequest = { inventoryItemId : "SWORD" };  try {    await inventory.addInventoryItem({      addInventoryRequest,      playerId,      projectId    });    const result = await inventory.getPlayerInventory({ projectId, playerId });    return result.data;  } catch (err) {    logger.error("Error while retrieving inventory items", {"error.message": err.message});    throw err;  }}

Economy SDK 玩家货币

currencyId

playerId

JavaScript

const { CurrenciesApi } = require("@unity-services/economy-2.4");module.exports = async ({ params, context, logger }) => {  const { projectId, playerId, accessToken } = context;  const { currencyId } = params;  const currencies = new CurrenciesApi({ accessToken });  try {    await currencies.setPlayerCurrencyBalance({ projectId, playerId, currencyId, currencyBalanceRequest: { balance: 100 } });    await currencies.decrementPlayerCurrencyBalance({ projectId, playerId, currencyId, currencyModifyBalanceRequest: { amount: 50 } });    await currencies.incrementPlayerCurrencyBalance({ projectId, playerId, currencyId, currencyModifyBalanceRequest: { amount: 10 } });    const result = await currencies.getPlayerCurrencies({ projectId, playerId });    return result.data;  } catch (err) {    logger.error("Error while updating currencies", {"error.message": err.message}, {"currencyId" : currencyId});    throw err;  }}// Uncomment the code below to enable the inline parameter definition// - Requires Cloud Code JS dev environment setup with NodeJS (https://docs.unity3d.com/Packages/com.unity.services.cloudcode@latest/index.html?subfolder=/manual/Authoring/javascript_project.html)//// module.exports.params = {//   currencyId: { type: "String", required: true },// };

使用 Economy SDK 虚拟购买

purchaseId

currencyId

currencyId

playerId

JavaScript

const { CurrenciesApi, PurchasesApi, InventoryApi } = require("@unity-services/economy-2.4");module.exports = async ({ params, context, logger }) => {  const { projectId, playerId, accessToken } = context;  const { purchaseId, currencyId } = params;  const inventory = new InventoryApi({ accessToken });  const purchases = new PurchasesApi({ accessToken });  const currencies = new CurrenciesApi({ accessToken });  try {    // Give a player some currency to complete the purchase    await currencies.setPlayerCurrencyBalance({ projectId, playerId, currencyId, currencyBalanceRequest: { balance: 1 } });    const makeVirtualPurchaseResult = await purchases.makeVirtualPurchase({ projectId, playerId, playerPurchaseVirtualRequest: { id: purchaseId } });    const getPlayerInventoryResult = await inventory.getPlayerInventory({ projectId, playerId });    await inventory.deleteInventoryItem({ projectId, playerId, playersInventoryItemId: makeVirtualPurchaseResult.data.rewards.inventory[0].playersInventoryItemIds[0], inventoryDeleteRequest: {} });    return {      makeVirtualPurchaseResult: makeVirtualPurchaseResult.data,      getPlayerInventoryResult: getPlayerInventoryResult.data    };  } catch (err) {    logger.error("Error while calling out to Economy", {"error.message": err.message});    throw err;  }}// Uncomment the code below to enable the inline parameter definition// - Requires Cloud Code JS dev environment setup with NodeJS (https://docs.unity3d.com/Packages/com.unity.services.cloudcode@latest/index.html?subfolder=/manual/Authoring/javascript_project.html)//// module.exports.params = {//   currencyId: { type: "String", required: true },//   purchaseId: { type: "String", required: true },// };

Economy 与 Game Overrides 结合使用：

使用 Remote Config SDK

JavaScript

const { SettingsApi } = require("@unity-services/remote-config-1.1");module.exports = async ({ context, logger }) => {  const { projectId, playerId, accessToken } = context;  const remoteConfig = new SettingsApi({ accessToken });  try {    const result = await remoteConfig.assignSettings({ projectId, "userId": playerId, "attributes": { "unity": {}, "app": {}, "user": {} } });    return result.data;  } catch (err) {    logger.error("Error while assigning settings", {"error.message": err.message});    throw err;  }}

使用 Vivox SDK

JavaScript

const { TokenApi } = require("@unity-services/vivox-0.1");module.exports = (async e => {  const o = {    iss: "gary.charlton.oogabooga",    exp: 1559359105,    vxa: "join",    vxi: 1,    f: "sip:.username.@domain.vivox.com",    t: "sip:confctl-g-channelname@domain.vivox.com"  };  try {    return TokenApi.generateVivoxToken("TEST_KEY", o)  } catch (err) {    logger.error("Error while generating vivox token", {"error.message": err.message});    throw err;  }});

使用 Lobby SDK

playerId

serviceId

serviceId

JavaScript

const { LobbyApi } = require("@unity-services/lobby-1.2");module.exports = async ({ params, context, logger }) => {  const lobbyApi = new LobbyApi(context);  const { serviceId, playerId } = params;  try {    // Create a private lobby without any initial players.    const { data: lobby } = await lobbyApi.createLobby(      serviceId,      null, {        name: "my new lobby name",        maxPlayers: 4,        isPrivate: true,      }    );    logger.info(`Created lobby: ${JSON.stringify(lobby)}`);    // Heartbeat the lobby to keep it active.    await lobbyApi.heartbeat(lobby.id, serviceId);    // Update the lobby's name and get the updated lobby.    const { data: updateResponse } = await lobbyApi.updateLobby(      lobby.id,      serviceId,      null, { name: "my updated lobby name" }    );    logger.info(`Lobby updated: ${JSON.stringify(updateResponse)}`);    // Join the lobby as an impersonated player.    const { data: joinResponse } = await lobbyApi.joinLobbyById(lobby.id, serviceId, playerId);    logger.info(`Player joined: ${JSON.stringify(joinResponse)}`);    // Get and return the lobby.    const getResponse = await lobbyApi.getLobby(lobby.id, serviceId);    return getResponse.data;  } catch (err) {    logger.error("Error while calling out to Lobby", {"error.message": err.message});    throw err;  }};// Uncomment the code below to enable the inline parameter definition// - Requires Cloud Code JS dev environment setup with NodeJS (https://docs.unity3d.com/Packages/com.unity.services.cloudcode@latest/index.html?subfolder=/manual/Authoring/javascript_project.html)//// module.exports.params = {//   serviceId: { type: "String", required: true },//   playerId: { type: "String", required: true },// };

使用 Leaderboards SDK

leaderboardId

JavaScript

const { LeaderboardsApi } = require("@unity-services/leaderboards-1.1");module.exports = async ({ params, context, logger }) => {  const leaderboardsApi = new LeaderboardsApi({accessToken : context.accessToken});  let result;  try {    await leaderboardsApi.addLeaderboardPlayerScore(context.projectId, params.leaderboardId, context.playerId, { score : 20});    const result = await leaderboardsApi.getLeaderboardScores(context.projectId, params.leaderboardId);    return result.data;  } catch (err) {    logger.error("Error while calling out to Leaderboards", {"error.message": err.message});    throw err;  }};// Uncomment the code below to enable the inline parameter definition// - Requires Cloud Code JS dev environment setup with NodeJS (https://docs.unity3d.com/Packages/com.unity.services.cloudcode@latest/index.html?subfolder=/manual/Authoring/javascript_project.html)//// module.exports.params = {//   leaderboardId: { type: "String", required: true },// };

使用 Friends SDK

JavaScript

const { RelationshipsApi, PresenceApi, MessagingApi, NotificationsApi } = require("@unity-services/friends-1.0");module.exports = async ({ params, context, logger }) => {  // Send friend requests and retrieve friends  const relationshipsApi = new RelationshipsApi({ accessToken: context.accessToken });  try {    const payload = {      type: "FRIEND_REQUEST",      members: [{ id: params.playerId }]    };    const createRes = await relationshipsApi.createRelationship(true, true, payload);    logger.info(`New relationship initiated: ${JSON.stringify(createRes.data)}`)  } catch (err) {    // The call will fail if the friend request has already been sent    logger.error("Error while sending a friend request", { "error.message": err.message });  }  try {    const list = await relationshipsApi.getRelationships(10, 0, true, true, ["FRIEND_REQUEST", "FRIEND"]);    logger.info(`Retrieved relationships: ${JSON.stringify(list.data)}`)  } catch (err) {    logger.error("Error while retrieving relationships", { "error.message": err.message });  }  // -------------------------------------------------------------------------  // Retrieve a notification token  const notificationsApi = new NotificationsApi({ accessToken: context.accessToken });  try {    const auth = await notificationsApi.getNotificationsAuth();    logger.info(`Retrieved notifications subscription token: ${JSON.stringify(auth.data)}`)  } catch (err) {    logger.error("Error while retrieving notification subscription token", { "error.message": err.message });  }  // -------------------------------------------------------------------------  // Set and receive presence  const presenceApi = new PresenceApi({ accessToken: context.accessToken });  try {    const newStatus = {      activity: { // define any payload structure        location: "In Menu",      },      availability: "ONLINE",    };    const setPresenceStatus = await presenceApi.setPresence(newStatus);    logger.info(`Changed player presence status for player ${context.playerId}: ${JSON.stringify(setPresenceStatus.data)}`)  } catch (err) {    logger.error("Error while setting a presence status", { "error.message": err.message });  }  try {    // This call will fail if the requested user has not accepted the friend request!    const presenceStatus = await presenceApi.getPresence(params.playerId);    logger.info(`Retrieved player presence for player ${params.playerId}: ${JSON.stringify(presenceStatus.data)}`)  } catch (err) {    logger.error("Error while retrieving a presence status", { "error.message": err.message });  }  // -------------------------------------------------------------------------  // Send messages  const messagingApi = new MessagingApi({ accessToken: context.accessToken });  try {    const messagePayload = {      id: params.playerId,      message: { // define any payload structure        hello: "world",        custom: "sending you a message!"      }    }    // This call will fail if the requested user has not accepted the friend request!    const messageResponse = await messagingApi.message(messagePayload);    logger.info(`Sent a message to player ${params.playerId}`)  } catch (err) {    logger.error("Error while sending a message", { "error.message": err.message });    throw err;  }}// Uncomment the code below to enable the inline parameter definition// - Requires Cloud Code JS dev environment setup with NodeJS (https://docs.unity3d.com/Packages/com.unity.services.cloudcode@latest/index.html?subfolder=/manual/Authoring/javascript_project.html)//// module.exports.params = {//   playerId: { type: "String", required: true },// };

使用 Player Names SDK

JavaScript

const { PlayerNamesApi } = require("@unity-services/player-names-1.0");module.exports = async ({ params, context, logger }) => {  const playerNamesApi = new PlayerNamesApi({ accessToken: context.accessToken });  try {    const playerData = await playerNamesApi.getName(context.playerId);    logger.info(`The received player data is ${JSON.stringify(playerData.data)}`);    const updatedData = await playerNamesApi.updateName(context.playerId, {name: "newCustomName"});    logger.info(`The updated player data is ${JSON.stringify(updatedData.data)})`);  } catch (err) {    logger.error("Error while calling out to Player Names", { "error.message": err.message });    throw err;  }};

通过 REST API 与 UGS 进行连接

身份验证

accessToken

serviceToken

serviceToken