通过

写入个人资料

  • 项目

个人资料 包含与玩家个人资料、实体个人资料、角色个人资料、组和物品栏相关的存储数据。 个人资料 数据是针对单个玩家、一组玩家或物品，并由 PlayFab 存储为键/值对 (KVP) 的信息。

以下 API 会导致配置文件写入计量递增。

管理员 API

客户端 API

  • AcceptTrade 接受开放交易（尚未接受或取消），如果本地登录玩家在交易允许的玩家列表中，或者它对所有玩家开放。 如果调用成功，提供和接受的物品会在两个玩家的物品栏之间进行交换。

  • AddFriend 根据所提供的唯一标识符的匹配将 PlayFab 用户添加到本地用户的好友列表。 至少应初始化 FriendPlayFabId、FriendUsername、FriendEmail 或 FriendTitleDisplayName 之一。

  • AddGenericID 将指定的泛型服务标识符添加到玩家的 PlayFab 帐户。 这旨在允许对游戏要添加的任何任意服务标识符进行 PlayFab ID 查找。 此标识符不应用作身份验证凭据，因为其目的是其他玩家可以轻松访问它。

  • AddOrUpdateContactEmail 向玩家个人资料添加或更新联系人电子邮件。

  • AddSharedGroupMembers 将用户添加到能够同时更新共享数据的用户集以及组中的用户集。 只有组（和服务器）中的用户可以添加新成员。 共享组专为在极少数玩家之间共享数据而设计，请参阅 使用共享组数据。

  • AddUsernamePassword 将 playfab 用户名/密码身份验证添加到通过匿名身份验证方法创建的现有帐户，例如自动设备 ID 登录。

  • AndroidDevicePushNotificationRegistration 注册 Android 设备以接收推送通知

  • ConsumePSNEntitlements 检查是否有任何新的易耗品权利。 如果找到任何项，则使用它们并将其添加为 PlayFab 项。

  • ConsumeXboxEntitlements 从Xbox Live授予玩家的当前权利，使用 Xbox 中的所有可用项目，并将其授予玩家的 PlayFab 清单。 此调用是幂等的，不会向玩家授予以前授予的项目。

  • CreateSharedGroup 请求创建共享组对象，其中包含可能由组的所有成员更新的键/值对。 创建后，当前用户将是该组的唯一成员。 共享组专为在极少数玩家之间共享数据而设计。 有关详细信息，请参阅 使用共享组数据。

  • GrantCharacterToUser 向用户授予指定的字符类型。 CharacterId 不是全局唯一的;必须使用父 PlayFabId 计算 characterId，以确保唯一性。

  • LinkAndroidDeviceID 将 Android 设备标识符链接到用户的 PlayFab 帐户

  • LinkCustomID 将游戏生成的自定义标识符链接到用户的 PlayFab 帐户。

  • Link FacebookAccount 将与提供的 Facebook 访问令牌关联的 Facebook 帐户链接到用户的 PlayFab 帐户。

  • Link FacebookInstantGamesId 将 Facebook 即时游戏 ID 链接到用户的 PlayFab 帐户。

  • LinkGameCenterAccount 将与提供的Game Center ID 关联的Game Center帐户链接到用户的 PlayFab 帐户。

  • LinkGoogleAccount 使用其 Google 帐户凭据将当前登录的用户帐户链接到其 Google 帐户。

  • LinkIOSDeviceID 将供应商特定的 iOS 设备标识符链接到用户的 PlayFab 帐户。

  • LinkKongregate 将 Kongregate 标识符链接到用户的 PlayFab 帐户。

  • LinkNintendoSwitchDeviceId 将 NintendoSwitchDeviceId 链接到用户的 PlayFab 帐户。

  • LinkOpenIdConnect 根据游戏和 Open ID Connect 提供程序与该提供程序的 OpenId Connect JWT 之间的现有关系，将OpenID Connect帐户链接到用户的 PlayFab 帐户。

  • LinkPSNAccount 将与提供的访问代码关联的 PlayStation™ 网络帐户链接到用户的 PlayFab 帐户。

  • LinkSteamAccount 将与提供的 Steam 身份验证票证关联的 Steam 帐户链接到用户的 PlayFab 帐户。

  • LinkTwitch 将与令牌关联的 Twitch 帐户链接到用户的 PlayFab 帐户。

  • LinkWindowsHello 将Windows Hello身份验证链接到当前 PlayFab 帐户。

  • LinkXboxAccount 将与提供的访问代码关联的Xbox Live帐户链接到用户的 PlayFab 帐户。

  • OpenTrade 打开新的未结交易。 请注意，给定项实例一次只能在一个开放交易中。

  • PurchaseItem 使用虚拟货币购买单个商品。 必须同时指定要用于购买的虚拟货币，以及客户端认为价格是怎样的。 如果价格已更改，这会使服务器无法购买。

  • PayForPurchase 选择通过 StartPurchase 创建的采购订单的付款选项

  • RegisterForIOSPushNotification 注册 iOS 设备以接收推送通知

  • RegisterPlayFabUser 注册新的 Playfab 用户帐户，并返回会话标识符，该标识符随后可用于需要经过身份验证的用户的 API 调用。 必须提供用户名或电子邮件地址。

  • RegisterWithWindowsHello 使用Windows Hello身份验证注册新的 PlayFab 用户帐户，并返回随后可用于需要经过身份验证的用户的 API 调用的会话票证

  • RemoveContactEmail 从玩家的档案中删除联系人电子邮件。

  • RemoveFriend 从本地用户的友元列表中删除指定的用户。

  • RemoveGenericID 从玩家的 PlayFab 帐户中删除指定的通用服务标识符。

  • RemoveSharedGroupMembers 从能够更新共享数据的用户集和组中的用户集中删除用户。 只有组中的用户才能删除成员。 如果由于调用而导致没有用户继续具有访问权限，则将删除该组及其关联的数据。 共享组专为在极少数玩家之间共享数据而设计，请参阅 使用共享组数据。

  • ReportAdActivity 报表播放器的广告活动

  • ReportDeviceInfo 编写 PlayStream 事件来描述提供的玩家设备信息。 此 API 方法不设计为由开发人员直接调用。 每个 PlayFab 客户端 SDK 最终将自动报告此信息。

  • ReportPlayer 为其他玩家提交报表（由于恶意玩家等），以便游戏的客户服务代表可以对可能有害的玩家采取措施。

  • RestoreIOSPurchases 根据给定的还原回执还原所有应用内购买

  • SetFriendTags 更新本地用户好友列表中指定用户的标记列表。

  • SubtractUserVirtualCurrency 按规定金额递减指定虚拟货币的用户余额。 可以使用此 API 使 VC 余额负。

  • UnlinkAndroidDeviceID 从用户的 PlayFab 帐户取消链接相关的 Android 设备标识符。

  • UnlinkCustomID 取消链接用户 PlayFab 帐户中的相关自定义标识符。

  • Unlink FacebookAccount 取消链接用户 PlayFab 帐户中的相关 Facebook 帐户。

  • Unlink FacebookInstantGamesId 从用户的 PlayFab 帐户取消链接相关的 Facebook 即时游戏 ID。

  • UnlinkGameCenterAccount 从用户的 PlayFab 帐户取消关联相关Game Center帐户。

  • UnlinkGoogleAccount 从用户的 PlayFab 帐户（https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods）取消关联相关 Google 帐户。

  • UnlinkIOSDeviceID 取消链接用户 PlayFab 帐户中的相关 iOS 设备标识符。

  • UnlinkKongregate 取消链接用户 PlayFab 帐户中的相关 Kongregate 标识符。

  • UnlinkNintendoSwitchDeviceId 从用户的 PlayFab 帐户取消链接相关的 NintendoSwitchDeviceId。

  • UnlinkOpenIdConnect 根据游戏与 Open ID Connect 提供程序之间现有关系的连接 ID，从用户的 PlayFab 帐户取消链接OpenID Connect帐户。

  • UnlinkPSNAccount 取消链接用户 PlayFab 帐户中的相关 PSN 帐户。

  • UnlinkSteamAccount 从用户的 PlayFab 帐户取消关联相关的 Steam 帐户。

  • UnlinkTwitch 从用户的 PlayFab 帐户取消关联相关的 Twitch 帐户。

  • UnlinkWindowsHello 从当前 PlayFab 帐户取消链接Windows Hello身份验证。

  • UnlinkXboxAccount 取消链接用户 PlayFab 帐户中的相关Xbox Live帐户。

  • UnlockContainerInstance 使用指定的密钥（如果需要）打开指定容器，并返回打开的容器的内容。 如果容器（以及相关密钥）是易耗品（RemainingUses > 0），则其 RemainingUse 将递减，这与 ConsumeItem 的操作一致。

  • UnlockContainerItem 在目标清单中搜索与给定 CatalogItemId 匹配的 ItemInstance，如有必要，请使用相应的密钥将其解锁，并返回打开的容器的内容。 如果容器（以及相关密钥）是易耗品（RemainingUses > 0），则其 RemainingUse 将递减，这与 ConsumeItem 的操作一致。

  • UpdateAvatarUrl 更新玩家的虚拟形象 URL。

  • UpdateCharacterData 创建和更新用户字符的特定于游戏的自定义数据，该数据可由客户端读取和写入

  • UpdateCharacterStatistics 更新特定字符的指定游戏特定统计信息的值。 默认情况下，不允许客户端更新统计信息。 开发人员可以在 Game Manager > “设置” > API 功能中重写此设置。

  • UpdatePlayerStatistics 更新用户的指定游戏特定统计信息的值。 默认情况下，不允许客户端更新统计信息。 开发人员可以在 Game Manager > “设置” > API 功能中重写此设置。

  • UpdateSharedGroupData 添加、更新和删除共享组对象的数据密钥。 如果权限设置为"公共"，则此调用中更新或添加的所有字段将由不在组中的用户读取。 默认情况下，数据权限设置为"专用"。 无论权限设置如何，只有组成员才能更新数据。 共享组专为在极少数玩家之间共享数据而设计，请参阅 使用共享组数据。

  • UpdateUserData 为用户创建和更新特定于游戏的自定义数据，该数据可由客户端读取和写入。

  • UpdateUserPublisherData 为用户创建和更新特定于发布者的自定义数据，该数据可由客户端读取和写入。

  • UpdateUserTitleDisplayName 更新用户的游戏特定显示名称

“PlayStation”是索尼交互娱乐公司的注册商标或商标。

“PSN”是索尼交互娱乐公司的注册商标或商标。

数据 API

  • SetObjects 设置实体配置文件上的对象。

组 API

配置文件 API

  • SetGlobalPolicy 设置全局游戏访问策略。

  • SetProfileLanguage 更新实体的语言。 与玩家通信的优先层次结构是游戏玩家帐户语言、主玩家帐户语言，如果未设置或支持前两种语言，则为游戏默认语言。

  • SetProfilePolicy 设置配置文件访问策略。

服务器 API

  • AddCharacterVirtualCurrency 按指定金额递增指定虚拟货币的字符余额。

  • AddFriend 使用 PlayFabId 将 Friend 用户添加到用户的好友列表中。 至少应初始化 FriendPlayFabId、FriendUsername、FriendEmail 或 FriendTitleDisplayName 之一。

  • AddGenericID 将指定的泛型服务标识符添加到玩家的 PlayFab 帐户。 这旨在允许对游戏要添加的任何任意服务标识符进行 PlayFab ID 查找。 此标识符不应用作身份验证凭据，因为其目的是其他玩家可以轻松访问它。

  • AddPlayerTag 向玩家档案添加给定标记。 根据标记的源自动生成标记的命名空间。

  • AddSharedGroupMembers 将用户添加到能够同时更新共享数据的用户集以及组中的用户集。 只有组（和服务器）中的用户可以添加新成员。 共享组专为在极少数玩家之间共享数据而设计，请参阅 使用共享组数据。

  • AddUserVirtualCurrency 按指定金额递增指定虚拟货币的用户余额。

  • AwardSteamAchievement 为指定用户授予指定的 Steam 成就。

  • BanUsers 使用可选 IP 地址的 PlayFab ID 或提供的游戏的 MAC 地址禁止用户。

  • ConsumeItem 使用易耗品。 当使用所有用途时，它将从玩家的清单中删除。

  • CreateSharedGroup 请求创建共享组对象，其中包含可能由组的所有成员更新的键/值对。 由服务器创建时，组最初将没有成员。 共享组专为在极少数玩家之间共享数据而设计，请参阅 使用共享组数据。

  • DeleteCharacterFromUser 从指定用户中删除特定字符 ID。

  • DeleteSharedGroup 删除共享组，释放要为新组重复使用的共享组 ID。 共享组专为在极少数玩家之间共享数据而设计，请参阅 使用共享组数据。

  • GrantCharacterToUser 向用户授予指定的字符类型。 CharacterId 不是全局唯一的;必须使用父 PlayFabId 计算 characterId，以确保唯一性。

  • GrantItemsToCharacter 将指定项添加到指定字符的清单中。

  • GrantItemsToUser 将指定项添加到指定用户的清单。

  • GrantItemsToUsers 将指定项添加到指定的用户清单中，

  • LinkServerCustomId 将游戏生成的自定义服务器标识符链接到用户的 PlayFab 帐户。

  • LinkXboxAccount 将与提供的访问代码关联的Xbox Live帐户链接到用户的 PlayFab 帐户。

  • ModifyItemUses 修改玩家物品的剩余使用数。

  • MoveItemToCharacterFromCharacter 将项从字符的清单移到另一个用户字符的清单中。

  • MoveItemToCharacterFromUser 将项从用户的清单移动到其字符的清单中。

  • MoveItemToUserFromCharacter 将项从字符的清单移动到拥有用户的清单中。

  • RedeemCoupon 将与优惠券关联的虚拟商品添加到用户的库存中。 优惠券可以通过 PlayFab Game Manager 中的“Economy->目录”选项卡生成。

  • RemoveFriend 从用户的好友列表中删除指定的好友。

  • RemoveGenericID 从玩家的 PlayFab 帐户中删除指定的通用服务标识符。

  • RemovePlayerTag 从玩家档案中删除给定的标记。 根据标记的源自动生成标记的命名空间。

  • RemoveSharedGroupMembers 从能够更新共享数据的用户集和组中的用户集中删除用户。 只有组中的用户才能删除成员。 如果由于调用而导致没有用户继续具有访问权限，则将删除该组及其关联的数据。 共享组专为在极少数玩家之间共享数据而设计，请参阅 使用共享组数据。

  • RevokeAllBansForUser 撤销用户的所有活动禁用。

  • RevokeBans 撤销使用 BanId 指定的所有活动封禁。

  • RevokeInventoryItem 撤消对用户清单中项的访问权限。

  • RevokeInventoryItems 撤消多个用户和字符中最多 25 个项目的访问权限。

  • SetFriendTags 更新另一个用户的友元列表中指定用户的标记列表。

  • SetPlayerSecret 设置玩家的机密（如果尚未设置）。 玩家机密用于对 API 请求进行签名。 若要重置玩家的机密，请使用 Admin 或 Server API 方法 SetPlayerSecret。

  • SetPublisherData 更新自定义发布服务器设置的键值存储。

  • SetTitleData /rest/api/playfab/server/title-wide-data-management/setpublisherdata?

  • SetTitleInternalData 更新自定义游戏设置的键值存储

  • SubtractCharacterVirtualCurrency 按指定金额递减指定虚拟货币的字符余额。 可以使用此 API 使 VC 余额负。

  • SubtractUserVirtualCurrency 按规定金额递减指定虚拟货币的用户余额。 可以使用此 API 使 VC 余额负。

  • UnlinkServerCustomId 从用户的 PlayFab 帐户取消链接自定义服务器标识符。

  • UnlinkXboxAccount 取消链接用户 PlayFab 帐户中的相关Xbox Live帐户。

  • UnlockContainerInstance 打开具有特定密钥的特定容器 （ContainerItemInstanceId），并在需要时返回打开的容器的内容。 如果容器（以及相关密钥）是易耗品（RemainingUses > 0），则其 RemainingUse 将递减，这与 ConsumeItem 的操作一致。

  • UnlockContainerItem 搜索与给定 CatalogItemId 匹配的任何 ItemInstance 的 Player 或 Character 清单，如有必要，请使用任何适当的密钥将其解锁，并返回打开的容器的内容。 如果容器（以及相关密钥）是易耗品（RemainingUses > 0），则其 RemainingUse 将递减，这与 ConsumeItem 的操作一致。

  • UpdateAvatarUrl 更新指定玩家的虚拟形象 URL。

  • UpdateBans 使用禁用 ID 指定的现有封禁列表的更新信息。

  • UpdateCharacterData 更新客户端可读和可写入的用户字符的游戏特定自定义数据。

  • UpdateCharacterInternalData 更新客户端无法访问的用户字符的游戏特定自定义数据。

  • UpdateCharacterReadOnlyData 更新用户字符的游戏特定自定义数据，该数据只能由客户端读取。

  • UpdateCharacterStatistics 更新特定字符的指定游戏特定统计信息的值。

  • UpdatePlayerStatistics 更新用户的指定游戏特定统计信息的值。

  • UpdateUserData 更新客户端可读和可写入的用户的游戏特定自定义数据。

  • UpdateUserInternalData 更新客户端无法访问的用户的游戏特定自定义数据。

  • UpdateUserInventoryItemCustomData 更新标记为指定项的键值对数据，该项是从客户端读取的。

  • UpdateUserPublisherData 更新客户端可读和可写入的用户的特定于发布者的自定义数据。

  • UpdateUserPublisherInternalData 更新客户端无法访问的用户的特定于发布者的自定义数据。

  • UpdateUserPublisherReadOnlyData 更新仅可由客户端读取的用户的特定于发布者的自定义数据。

  • UpdateUserReadOnlyData 更新用户的游戏特定自定义数据，该数据只能由客户端读取。