配置文件读取
个人资料 包含与玩家个人资料、实体个人资料、角色个人资料、组和物品栏相关的存储数据。 个人资料 数据是针对单个玩家、一组玩家或物品,并由 PlayFab 存储为键/值对 (KVP) 的信息。
以下 API 导致配置文件读取计量递增。
管理员 API
CheckLimitedEditionItemAvailability 检查受限版本项的全局计数。
GetAllSegments 检索玩家段定义的数组。 结果可用于后续 API 调用,例如需要段 ID 的 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 创建与创建时段定义匹配的所有玩家配置文件的快照,并保留"总生存时间"秒数,并在每次后续使用延续令牌时刷新其生存期。 分页过程中更改的配置文件不会反映在结果中。 此操作当前不支持 AB 测试段。
GetExperiments 获取游戏的所有试验的详细信息。
GetLatestScorecard 获取游戏实验的最新记分卡。
GetSignmentAssignment 获取游戏中每个正在运行的试验的玩家的治疗分配
客户端 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 获取玩家打开或接受的所有交易,可以选择按交易状态进行筛选。
GetPlayFabIDsFrom FacebookIDs 检索给定 Facebook 标识符集的唯一 PlayFab 标识符。
GetPlayFabIDsFrom FacebookInstantGamesIds 检索给定 Facebook 即时游戏标识符集的唯一 PlayFab 标识符。
GetPlayFabIDsFromGameCenterIDs 检索给定Game Center标识符集的唯一 PlayFab 标识符(在Game Center编程指南中作为玩家标识符引用)。
GetPlayFabIDsFromGenericIDs 检索给定一组泛型服务标识符的唯一 PlayFab 标识符。 泛型标识符是玩家的服务名称和特定于服务的 ID,在将通用标识符添加到玩家帐户时由游戏指定。
GetPlayFabIDsFromGoogleIDs 检索给定 Google 标识符集的唯一 PlayFab 标识符。 Google 标识符是用户帐户的 ID,可在 Google+ 人员 API 调用中用作"id"。
GetPlayFabIDsFromKongregateIDs 检索给定 Kongregate 标识符集的唯一 PlayFab 标识符。 Kongregate 标识符是用户帐户的 ID,可从 Kongregate API 方法中作为“user_id”提供(例如: http://developers.kongregate.com/docs/client/getUserId)。
GetPlayFabIDsFromNintendoSwitchDeviceIds 检索给定 Nintendo Switch 标识符集的唯一 PlayFab 标识符。
GetPlayFabIDsFromPSNAccountIDs 检索给定 PlayStation™ 网络标识符集的唯一 PlayFab 标识符。
GetPlayFabIDsFromSteamIDs 检索给定 Steam 标识符集的唯一 PlayFab 标识符。 Steam 标识符是用户帐户的配置文件 ID,可在 Steamworks 社区 API 调用中用作 SteamId。
GetPlayFabIDsFromTwitchID 检索给定 Twitch 标识符集的唯一 PlayFab 标识符。 Twitch 标识符是用户帐户的 ID,可从 Twitch API 方法中作为“_id”提供(例如: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser)。
GetPlayFabIDsFromXboxLiveID 检索给定 XboxLive 标识符集的唯一 PlayFab 标识符。
GetPublisherData 检索自定义发布服务器设置的键值存储。
GetPurchase 检索购买及其当前 PlayFab 状态。 从仍处于活动状态的购买中返回清单项。
GetSharedGroupData 检索存储在共享组对象中的数据以及组中的成员列表。 组的非成员可以使用此功能检索组数据(包括成员身份),但不会收到标记为私密的密钥的数据。 共享组专为在极少数玩家之间共享数据而设计,请参阅 使用共享组数据。
GetStoreItems 检索为指定存储定义的项集,包括定义的所有价格。
GetTitleData 检索自定义游戏设置的键值存储
GetAccountInfo 检索用户的 PlayFab 帐户详细信息。
LoginWithAndroidDeviceID 使用 Android 设备标识符登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。
LoginWithCustomID 使用游戏生成的自定义唯一标识符登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用
LoginWithEmailAddress 将用户登录 PlayFab 帐户,返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。 与大多数其他登录 API 调用不同,LoginWithEmailAddress 不允许通过 CreateAccountFlag 创建新帐户。 电子邮件地址可用于通过 RegisterPlayFabUser 创建帐户。
LoginWith Facebook 使用 Facebook 访问令牌登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。
LoginWith FacebookInstantGamesId 使用 Facebook 即时游戏 ID 登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。 需要配置 Facebook 即时游戏。
LoginWithGameCenter 使用 iOS Game Center玩家标识符登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。
LoginWithGoogleAccount 使用 iOS Game Center玩家标识符登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。
LoginWithIOSDeviceID 使用其 Google 帐户凭据登录用户。
LoginWithKongregate 使用 Kongregate 玩家帐户登录用户。
LoginWithNintendoSwitchDeviceId 使用任天堂交换机设备 ID 登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。
LoginWithOpenIdConnect 具有 Open ID Connect JWT 的用户中的日志,该用户由游戏与 Open ID Connect 提供程序之间的现有关系创建。
需要经过身份验证的用户的 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”是索尼互动娱乐公司的注册商标或商标。
数据 API
- GetObjects 从实体的配置文件中检索对象。
组 API
GetGroup 获取有关组及其角色的信息。
IsMember 检查实体是否为组中某个组或角色的成员。
ListGroupApplications 列出加入组的所有未完成请求。
ListGroupBlocks 列出阻止加入组的所有实体。
ListGroupInvitations 列出组的所有未完成邀请。
ListGroupMembers 列出组的所有成员。
ListMembership 列出实体的所有组和角色。
ListMembershipOpportunities 列出实体的所有未完成邀请和组应用程序。
配置文件 API
GetGlobalPolicy 获取全局游戏访问策略。
GetProfile 检索实体的配置文件。
GetProfiles 检索实体的配置文件。
GetTitlePlayersFromMasterPlayerAccountIds 检索与给定主玩家帐户关联的游戏玩家帐户。
服务器 API
EvaluateRandomResultTable 返回随机结果表的计算结果 - 游戏目录中的 ItemId,如果通过捆绑包或对 UnlockContainer 的调用添加了随机结果表,则该表将添加到玩家清单中。
GetAllSegments 检索玩家段定义的数组。 结果可用于后续 API 调用,例如需要段 ID 的 GetPlayersInSegment。 虽然段名称可以更改该段的 ID,但不会更改。
GetAllUsersCharacters 列出属于特定用户的所有字符。 CharacterId 不是全局唯一的;必须使用父 PlayFabId 计算 characterId,以确保唯一性。
GetCatalogItems 检索游戏虚拟商品目录的指定版本,包括所有定义的属性。
GetCharacterData 检索客户端可读和可写入的用户的游戏特定自定义数据。
GetCharacterInternalData 检索客户端无法访问的用户字符的游戏特定自定义数据。
GetCharacterInventory 检索指定字符的虚拟商品的当前清单。
GetCharacterStatistics 检索特定字符的所有特定于游戏的统计信息的详细信息。
GetFriendLeaderboard 从排行榜中的指示点开始,检索给定玩家的给定统计信息的排名好友列表。
GetFriendsList 检索 PlayFabId 用户的当前好友,该用户受 PlayFab 帐户约束。 还包含来自链接帐户(Facebook、Steam)的好友。 可以选择排除某些链接服务的好友。
GetLeaderboard 从排行榜中的指示点开始,检索给定统计信息的排名用户列表。
GetLeaderboardAroundCharacter 检索给定统计信息的排名字符列表,以请求的用户为中心。
GetLeaderboardAroundUser 检索给定统计信息的排名字符列表,以请求的用户为中心。
GetLeaderboardForUserCharacters 检索给定统计信息的所有用户字符的列表。
GetPlayerCombinedInfo 返回用户响应中请求的任何信息。 请注意,可以返回 PII(如电子邮件地址、facebook ID)。 所有参数默认为 false。
GetPlayerProfile 检索玩家的档案。
GetPlayerSegments 列出当前玩家当前所属的所有段。
GetPlayersInSegment 允许对给定段中的所有玩家进行分页。 此 API 创建与创建时段定义匹配的所有玩家配置文件的快照,并保留"总生存时间"秒数,并在每次后续使用延续令牌时刷新其生存期。 分页过程中更改的配置文件不会反映在结果中。 此操作当前不支持 AB 测试段。
GetPlayerStatistics 为本地玩家检索所指示统计信息的当前版本和值。
GetPlayerStatisticVersions 检索有关指定统计信息的可用版本的信息。
GetPlayerTags 从玩家配置文件中获取具有给定命名空间(可选)的所有标记。
GetPlayFabIDsFrom FacebookIDs 检索给定 Facebook 标识符集的唯一 PlayFab 标识符。
GetPlayFabIDsFrom FacebookInstantGamesIds 检索给定 Facebook 标识符集的唯一 PlayFab 标识符。
GetPlayFabIDsFromGenericIDs 检索给定一组泛型服务标识符的唯一 PlayFab 标识符。 泛型标识符是玩家的服务名称和特定于服务的 ID,在将通用标识符添加到玩家帐户时由游戏指定。
GetPlayFabIDsFromNintendoSwitchDeviceIds 检索给定一组任天堂交换机设备标识符的唯一 PlayFab 标识符。
GetPlayFabIDsFromPSNAccountIDs 检索给定 PlayStation 网络标识符集的唯一 PlayFab 标识符。
GetPlayFabIDsFromSteamIDs 检索给定 Steam 标识符集的唯一 PlayFab 标识符。 Steam 标识符是用户帐户的配置文件 ID,可在 Steamworks 社区 API 调用中用作 SteamId。
GetPlayFabIDsFromXboxLiveID 检索给定 XboxLive 标识符集的唯一 PlayFab 标识符。
GetPublisherData 检索自定义发布服务器设置的键值存储。
GetRandomResultTables 检索游戏的指定随机结果表的配置信息,包括所有 ItemId 值和权重。
GetServerCustomIDsFromPlayFabIDs 检索给定服务器自定义标识符集的关联 PlayFab 帐户标识符。
GetSharedGroupData 检索存储在共享组对象中的数据以及组中的成员列表。 服务器可以访问所有公共和专用组数据。 共享组专为在极少数玩家之间共享数据而设计,请参阅 使用共享组数据。
GetStoreItems 检索为指定存储定义的项集,包括为指定玩家定义的所有价格。
GetTitleData 检索自定义游戏设置的键值存储。
GetTitleInternalData 检索自定义内部游戏设置的键值存储。
GetUserAccountInfo 检索指定用户的相关详细信息。
GetUserBans 获取用户的所有禁用。
GetUserData 检索客户端可读和可写入的用户的游戏特定自定义数据。
GetUserInternalData 检索客户端无法访问的用户的游戏特定自定义数据。
GetUserInventory 检索指定用户的当前虚拟商品清单。
GetUserPublisherData 检索客户端可读和可写入的用户的特定于发布者的自定义数据。
GetUserPublisherInternalData 检索客户端无法访问的用户的特定于发布者的自定义数据。
GetUserReadOnlyData 更新用户的游戏特定自定义数据,该数据只能由客户端读取。
LoginWithServerCustomId 使用该玩家的自定义标识符从外部服务器后端安全登录游戏客户端。 服务器自定义 ID 和客户端自定义 ID 是互斥的,不能用于检索同一玩家帐户。
LoginWithXbox 从外部服务器后端使用Xbox Live令牌登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。
LoginWithXboxId 使用 Xbox ID 和沙盒 ID 登录用户,并返回会话标识符,该标识符随后可用于需要经过身份验证的用户的 API 调用。