Skip to main content
Profile 包括与玩家配置文件、实体配置文件、角色配置文件、组和库存相关的任何存储数据。配置文件数据是适用于单个玩家、玩家组或物品的信息,由 PlayFab 以键/值对(KVP)形式存储。 以下 API 会累加配置文件读取计量。

Admin API

  • CheckLimitedEditionItemAvailability 查询限量版物品的全局数量。
  • GetAllSegments 检索玩家细分定义数组。其结果可用于后续需要细分 ID 的 API 调用(如 GetPlayersInSegment)。虽然细分名称可能会更改,但该细分的 ID 不会更改。
  • ExportMasterPlayerData 导出主玩家账户的所有关联数据。
  • GetCatalogItems 检索标题虚拟商品目录的指定版本,包括所有已定义的属性。
  • GetContentList 列出标题的所有内容并获取统计信息(如大小)。
  • GetDataReport 检索所请求报告的下载 URL。
  • GetPlayerSegments 列出玩家当前所属的所有细分。
  • GetPlayerTags 从玩家配置文件中获取给定命名空间(可选)的所有标签。
  • GetPolicy 获取所请求的策略。
  • GetPublisherData 检索自定义发布者设置的键值存储。
  • GetRandomResultTables 检索标题的随机掉落表配置。
  • GetStoreItems 检索为指定商店定义的物品集合,包括所有已定义的价格。
  • GetTitleData 检索客户端可读取的自定义标题设置的键值存储。
  • [GetUserAccountInfo](根据提供的唯一标识符匹配检索指定用户的相关详细信息) 根据提供的唯一标识符匹配检索指定用户的相关详细信息。
  • GetUserBans 获取用户的所有封禁记录。
  • GetUserData 检索用户可由客户端读写的标题特定自定义数据。
  • GetUserInternalData 检索用户的标题特定自定义数据,客户端无法访问。
  • GetUserInventory 检索指定用户当前的虚拟商品库存
  • GetUserPublisherData 检索用户可由客户端读写的发布者特定自定义数据。
  • GetUserPublisherInternalData 检索用户的发布者特定自定义数据,客户端无法访问。
  • GetUserPublisherReadOnlyData 检索用户仅可由客户端读取的发布者特定自定义数据。
  • GetUserReadOnlyData 检索用户仅可由客户端读取的标题特定自定义数据。
  • ListVirtualCurrencyTypes 返回为标题定义的所有虚拟货币的列表
  • GetPlayerIdFromAuthToken 从身份验证令牌获取玩家的 ID。
  • GetPlayersInSegment 允许对给定细分中的所有玩家进行分页浏览。该 API 会在创建时对匹配细分定义的所有玩家配置文件生成快照,并在 Total Seconds to Live 期间保留;每次使用 Continuation Token 后会刷新其生命周期。分页过程中变化的配置文件不会反映在结果中。此操作当前不支持 AB Test 细分。
  • GetExperiments 获取标题所有实验的详细信息。
  • GetLatestScorecard 获取标题实验的最新记分卡。
  • GetTreatmentAssignment 获取该标题下每个正在运行的实验为玩家分配的处理组

Client API

  • GetAllUsersCharacters 列出属于特定用户的所有角色。CharacterId 不是全局唯一的;必须结合父级 PlayFabId 来评估 characterId 以保证唯一性。
  • GetCatalogItems 检索标题虚拟商品目录的指定版本,包括所有已定义的属性。
  • GetCharacterData 检索角色可由客户端读写的标题特定自定义数据。
  • GetCharacterInventory 检索指定角色当前的虚拟商品库存。
  • GetCharacterLeaderboard 从排行榜的指定位置起,检索给定统计数据的角色排名列表。
  • GetCharacterReadOnlyData 检索角色仅可由客户端读取的标题特定自定义数据。
  • GetCharacterStatistics 检索用户所有标题特定统计信息的详细信息。
  • GetFriendLeaderboard 从排行榜指定位置起,检索当前玩家好友的给定统计数据的排名列表。
  • GetFriendLeaderboardAroundPlayer 以请求的 PlayFab 用户为中心,检索当前玩家好友的给定统计数据的排名列表。如果 PlayFabId 为空或 null,则返回当前登录用户的列表。
  • GetFriendsList 检索本地用户当前的好友列表,仅限拥有 PlayFab 账户的用户。来自关联账户(Facebook、Steam)的好友也会包含在内。你可以选择排除某些关联服务的好友。
  • GetLeaderboard 从排行榜指定位置起,检索给定统计数据的用户排名列表。
  • GetLeaderboardAroundCharacter 以请求的角色 ID 为中心,检索给定统计数据的角色排名列表。
  • GetLeaderboardAroundPlayer 以请求的玩家为中心,检索给定统计数据的用户排名列表。如果 PlayFabId 为空或 null,则返回当前登录用户。
  • GetLeaderboardForUserCharacters 检索用户所有角色的给定统计数据列表。
  • GetPaymentToken 用于支付流程,其中支付提供商要求由 PlayFab(履约方)发起交易,但客户端完成其余流程。在 Xsolla 情境中,此处返回的令牌将由客户端传给 Xsolla 以创建购物车。完成支付后使用返回的 OrderId 轮询 GetPurchase。
  • GetPlayerProfile 检索玩家的配置文件。
  • GetPlayerSegments 列出玩家当前所属的所有细分。
  • GetPlayerStatistics 为本地玩家检索指定的统计信息(如果未指定,则返回所有统计信息的当前版本和值)。
  • GetPlayerStatisticVersions 检索指定统计信息可用版本的信息。
  • GetPlayerTags 从玩家配置文件中获取具有给定命名空间(可选)的所有标签。
  • GetPlayerTrades 获取玩家开启或接受的所有交易,可按交易状态选择性过滤。
  • GetPlayFabIDsFromFacebookIDs 检索给定 Facebook 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromFacebookInstantGamesIds 检索给定 Facebook Instant Game 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromGameCenterIDs 检索给定 Game Center 标识符集合的唯一 PlayFab 标识符(在 Game Center 编程指南中被称为 Player Identifier)。
  • GetPlayFabIDsFromGenericIDs 检索给定通用服务标识符集合的唯一 PlayFab 标识符。通用标识符是服务名称加上标题在将通用标识符添加到玩家账户时为该玩家指定的服务特定 ID。
  • GetPlayFabIDsFromGoogleIDs 检索给定 Google 标识符集合的唯一 PlayFab 标识符。Google 标识符是用户账户的 ID,可通过 Google+ People API 调用中的 id 获得。
  • GetPlayFabIDsFromKongregateIDs 检索给定 Kongregate 标识符集合的唯一 PlayFab 标识符。Kongregate 标识符是用户账户的 ID,可从 Kongregate API 方法中的 user_id 获得(例如 https://docs.kongregate.com/docs/concepts-handling-guests)。
  • GetPlayFabIDsFromNintendoSwitchDeviceIds 检索给定 Nintendo Switch 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromPSNAccountIDs 检索给定 PlayStation™ Network 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromSteamIDs 检索给定 Steam 标识符集合的唯一 PlayFab 标识符。Steam 标识符是用户账户的配置文件 ID,可从 Steamworks Community API 调用中的 SteamId 获得。
  • GetPlayFabIDsFromTwitchIDs 检索给定 Twitch 标识符集合的唯一 PlayFab 标识符。Twitch 标识符是用户账户的 ID,可从 Twitch API 方法的 “_id” 获得(例如:https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser)。
  • GetPlayFabIDsFromXboxLiveIDs 检索给定 XboxLive 标识符集合的唯一 PlayFab 标识符。
  • GetPublisherData 检索自定义发布者设置的键值存储。
  • GetPurchase 检索一次购买及其当前的 PlayFab 状态。返回购买中仍处于活动状态的库存物品。
  • GetSharedGroupData 检索存储在共享组对象中的数据以及组成员列表。组的非成员使用它来检索组数据(包括成员身份),但不会收到标记为私有的键的数据。共享组适用于少量玩家之间共享数据。更多信息请参阅 使用共享组数据
  • GetStoreItems 检索为指定商店定义的物品集合,包括所有已定义的价格。
  • GetTitleData 检索自定义标题设置的键值存储
  • GetAccountInfo 检索用户的 PlayFab 账户详细信息。
  • LoginWithAndroidDeviceID 使用 Android 设备标识符登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • LoginWithCustomID 使用标题生成的自定义唯一标识符登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符
  • LoginWithEmailAddress 将用户登录到 PlayFab 账户,返回可用于后续需要身份验证的 API 调用的会话标识符。与大多数其他登录 API 调用不同,LoginWithEmailAddress 不允许通过 CreateAccountFlag 创建新账户。电子邮件地址可通过 RegisterPlayFabUser 用于创建账户。
  • LoginWithFacebook 使用 Facebook 访问令牌登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • LoginWithFacebookInstantGamesId 使用 Facebook Instant Games ID 登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。需要配置 Facebook Instant Games。
  • LoginWithGameCenter 使用 iOS Game Center 玩家标识符登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • LoginWithGoogleAccount 使用 iOS Game Center 玩家标识符登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • LoginWithIOSDeviceID 使用用户的 Google 账户凭据登录用户。
  • LoginWithKongregate 使用 Kongregate 玩家账户登录用户。
  • LoginWithNintendoSwitchDeviceId 使用 Nintendo Switch Device ID 登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • LoginWithOpenIdConnect 通过标题与 Open ID Connect 提供者之间已有关系创建的 Open ID Connect JWT 登录用户。
  • LoginWithPlayFab 需要身份验证的用户。与大多数其他登录 API 调用不同,LoginWithPlayFab 不允许通过 CreateAccountFlag 创建新账户。用户名/密码凭据可通过 RegisterPlayFabUser 用于创建账户,或使用 AddUsernamePassword 添加到现有账户。
  • LoginWithPSN 将用户登录到 PlayFab 账户,返回可用于后续需要身份验证的 API 调用的会话标识符。与大多数其他登录 API 调用不同,LoginWithPlayFab 不允许通过 CreateAccountFlag 创建新账户。用户名/密码凭据通过 RegisterPlayFabUser 用于创建账户,或使用 AddUsernamePassword 添加到现有账户。
  • LoginWithSteam 使用 Steam 身份验证凭据登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • LoginWithTwitch 使用 Twitch 访问令牌登录用户。
  • LoginWithXbox 使用 XBOX Live 令牌登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • GetPlayerCombinedInfo 检索用户各种不同类型的信息。
“PlayStation” 是 Sony Interactive Entertainment Inc. 的注册商标或商标。

Data API

  • GetObjects 从实体的配置文件中检索对象。

Groups API

Profile API

Server API

  • EvaluateRandomResultTable 返回随机结果表评估的结果——如果通过 Bundle 或对 UnlockContainer 的调用添加了随机结果表,则会被添加到玩家库存的游戏目录中的 ItemId
  • GetAllSegments 检索玩家细分定义数组。其结果可用于后续需要细分 ID 的 API 调用(如 GetPlayersInSegment)。虽然细分名称可能会更改,但该细分的 ID 不会更改。
  • GetAllUsersCharacters 列出属于特定用户的所有角色。CharacterId 不是全局唯一的;必须结合父级 PlayFabId 来评估 characterId 以保证唯一性。
  • GetCatalogItems 检索标题虚拟商品目录的指定版本,包括所有已定义的属性。
  • GetCharacterData 检索用户可由客户端读写的标题特定自定义数据。
  • GetCharacterInternalData 检索用户角色的标题特定自定义数据,客户端无法访问。
  • GetCharacterInventory 检索指定角色当前的虚拟商品库存。
  • GetCharacterReadOnlyData
  • GetCharacterStatistics 检索指定角色所有标题特定统计信息的详细信息。
  • GetFriendLeaderboard 从排行榜指定位置起,检索给定玩家好友的给定统计数据的排名列表。
  • GetFriendsList 检索具有 PlayFabId 的用户的当前好友,仅限拥有 PlayFab 账户的用户。来自关联账户(Facebook、Steam)的好友也会包含在内。你可以选择排除某些关联服务的好友。
  • GetLeaderboard 从排行榜指定位置起,检索给定统计数据的用户排名列表。
  • GetLeaderboardAroundCharacter 以请求的用户为中心,检索给定统计数据的角色排名列表。
  • GetLeaderboardAroundUser 以请求的用户为中心,检索给定统计数据的角色排名列表。
  • GetLeaderboardForUserCharacters 检索用户所有角色的给定统计数据列表。
  • GetPlayerCombinedInfo 返回响应中所请求的用户任何信息。注意,可能会返回个人数据,如电子邮件地址、Facebook ID。所有参数默认为 false。
  • GetPlayerProfile 检索玩家的配置文件。
  • GetPlayerSegments 列出玩家当前所属的所有细分。
  • GetPlayersInSegment 允许对给定细分中的所有玩家进行分页浏览。该 API 会在创建时对匹配细分定义的所有玩家配置文件生成快照,并在 Total Seconds to Live 期间保留;每次使用 Continuation Token 后会刷新其生命周期。分页过程中变化的配置文件不会反映在结果中。此操作当前不支持 AB Test 细分。
  • GetPlayerStatistics 检索本地玩家指定统计信息的当前版本和值。
  • GetPlayerStatisticVersions 检索指定统计信息可用版本的信息。
  • GetPlayerTags 从玩家配置文件中获取具有给定命名空间(可选)的所有标签。
  • GetPlayFabIDsFromFacebookIDs 检索给定 Facebook 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromFacebookInstantGamesIds 检索给定 Facebook 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromGenericIDs 检索给定通用服务标识符集合的唯一 PlayFab 标识符。通用标识符是服务名称加上标题在将通用标识符添加到玩家账户时为该玩家指定的服务特定 ID。
  • GetPlayFabIDsFromNintendoSwitchDeviceIds 检索给定 Nintendo Switch Device 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromPSNAccountIDs 检索给定 PlayStation Network 标识符集合的唯一 PlayFab 标识符。
  • GetPlayFabIDsFromSteamIDs 检索给定 Steam 标识符集合的唯一 PlayFab 标识符。Steam 标识符是用户账户的配置文件 ID,可从 Steamworks Community API 调用中的 SteamId 获得。
  • GetPlayFabIDsFromXboxLiveIDs 检索给定 XboxLive 标识符集合的唯一 PlayFab 标识符。
  • GetPublisherData 检索自定义发布者设置的键值存储。
  • GetRandomResultTables 检索标题指定随机结果表的配置信息,包括所有 ItemId 值和权重。
  • GetServerCustomIDsFromPlayFabIDs 检索给定服务器自定义标识符集合的关联 PlayFab 账户标识符。
  • GetSharedGroupData 检索存储在共享组对象中的数据以及组成员列表。服务器可以访问所有公共和私有组数据。共享组适用于少量玩家之间共享数据。更多信息请参阅 使用共享组数据
  • GetStoreItems 检索为指定玩家在指定商店中定义的物品集合,包括所有已定义的价格。
  • GetTitleData 检索自定义标题设置的键值存储。
  • GetTitleInternalData 检索自定义内部标题设置的键值存储。
  • GetUserAccountInfo 检索指定用户的相关详细信息。
  • GetUserBans 获取用户的所有封禁记录。
  • GetUserData 检索用户可由客户端读写的标题特定自定义数据。
  • GetUserInternalData 检索用户的标题特定自定义数据,客户端无法访问。
  • GetUserInventory 检索指定用户当前的虚拟商品库存。
  • GetUserPublisherData 检索用户可由客户端读写的发布者特定自定义数据。
  • GetUserPublisherInternalData 检索用户的发布者特定自定义数据,客户端无法访问。
  • GetUserPublisherReadOnlyData
  • GetUserReadOnlyData 更新用户仅可由客户端读取的标题特定自定义数据。
  • LoginWithServerCustomId 使用玩家的自定义标识符从外部服务器后端安全登录游戏客户端。Server Custom ID 与 Client Custom ID 互斥,无法用于检索同一玩家账户。
  • LoginWithXbox 使用来自外部服务器后端的 XBOX Live 令牌登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
  • LoginWithXboxId 使用 XBOX ID 和 Sandbox ID 登录用户,返回可用于后续需要身份验证的 API 调用的会话标识符。
最后修改于 2026年8月25日