他の 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 の使用

• Currencies を使用すると、プレイヤーは 1 つ以上の通貨/貨幣単位のゲーム内残高を保持できます。
• インベントリアイテムは、設定の一部として作成するリソースの定義を表します。プレイヤーは、インベントリアイテムのインスタンス (例えば、同一の剣、盾、帽子の複数のコピー) を所有できます。通貨とは異なり、各インスタンスに独自のプロパティを付与できます。
• Purchases を使用すると、プレイヤーがゲーム内通貨とインベントリアイテムを買うために、別のゲーム内通貨やインベントリアイテムを使用する (virtual purchases) ことも、デジタルストアフロントで リアルマネー を使用することもできます。

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 },// };

Game Overrides での Economy の使用

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