配置文件写入计量 API 说明

​

Admin API

• AddPlayerTag 向玩家配置文件添加给定的标签。标签的命名空间会根据标签来源自动生成。
• AddUserVirtualCurrency 将指定虚拟货币按所述数量递增
• AddVirtualCurrencyTypes 向为标题定义的集合中添加一种或多种虚拟货币。授予玩家时，虚拟货币的最大值为 2,147,483,647。任何超过该值的数值都将被丢弃。
• BanUsers 通过 PlayFab ID 封禁用户，可为所提供的游戏提供可选的 IP 地址。
• CreateActionsOnPlayersInSegmentTask 创建 ActionsOnPlayersInSegment 任务，遍历细分中的所有玩家以执行操作。
• CreatePlayerSharedSecret 创建新的玩家共享密钥。该 API 返回后，此密钥可能需要最多 5 分钟才能普遍可用。
• CreatePlayerStatisticDefinition 向标题添加新的玩家统计信息配置，可选允许开发者指定重置间隔和聚合方法。
• DeleteMasterPlayerAccount 从所有标题中完全删除主玩家账户，并删除所有相关联的数据。
• DeletePlayer 从标题中删除用户的玩家账户，并删除所有相关联的数据
• DeletePlayerSharedSecret 删除现有的玩家共享密钥。该 API 返回后，此删除操作可能需要最多 5 分钟才能生效。
• DeleteStore 删除现有的虚拟物品商店。
• DeleteTitle 永久删除标题及所有相关联的配置。
• GrantItemsToUsers 将指定物品添加到指定用户库存
• IncrementLimitedEditionItemAvailability 增加给定稀缺资源的全局数量。
• IncrementPlayerStatisticVersion 重置指定的统计信息，删除该统计信息的所有玩家条目并备份旧值。
• RefundPurchase 尝试通过原始真实货币支付提供商处理订单退款。""
• RemovePlayerTag 从玩家配置文件中移除给定标签。标签的命名空间根据标签来源自动生成。
• RemoveVirtualCurrencyTypes 从为标题定义的集合中移除一种或多种虚拟货币。
• ResetCharacterStatistics 完全移除当前游戏中指定角色的所有统计信息。
• ResetUserStatistics 完全移除当前游戏中指定用户的所有统计信息。
• ResolvePurchaseDispute 尝试与原订单的支付提供商解决争议。
• RevokeAllBansForUser 撤销用户的所有活动封禁。
• RevokeBans 撤销所有以 BanId 指定的活动封禁。
• RevokeInventoryItem 撤销对用户库存中某项物品的访问权限
• RevokeInventoryItems 撤销跨多个用户和角色最多 25 个物品的访问权限。
• SetCatalogItems 为指定目录版本创建所有虚拟商品的目录配置。
• SetPlayerSecret 设置或重置玩家密钥。玩家密钥用于签名 API 请求。
• SetPublishedRevision 设置标题 Cloud Script 的当前发布修订版本。
• SetPublisherData 更新自定义发布者设置的键值存储
• SetStoreItems 设置一个虚拟商店中的所有物品。
• SetTitleData 创建并更新客户端可读取的自定义标题设置的键值存储。
• SetTitleInternalData 更新客户端无法读取的自定义标题设置的键值存储。
• SubtractUserVirtualCurrency 将指定虚拟货币按所述数量递减。
• UpdateBans 更新以 Ban Id 指定的现有封禁列表的信息。
• UpdateCatalogItems 更新指定目录版本中虚拟商品的目录配置。
• UpdatePlayerSharedSecret 更新现有的玩家共享密钥。该 API 返回后，此更新可能需要最多 5 分钟才能普遍可用。
• UpdatePlayerStatisticDefinition 更新标题的玩家统计信息配置，可选允许开发者指定重置间隔。
• UpdateRandomResultTables 更新标题的随机掉落表配置
• UpdateStoreItems 使用新的或修改的物品更新现有的虚拟物品商店。
• UpdateUserData 更新用户可由客户端读写的标题特定自定义数据。
• UpdateUserInternalData 更新用户的标题特定自定义数据，客户端无法访问。
• UpdateUserPublisherData 更新用户可由客户端读写的发布者特定自定义数据。
• UpdateUserPublisherInternalData 更新用户的发布者特定自定义数据，客户端无法访问。
• UpdateUserPublisherReadOnlyData 更新用户仅可由客户端读取的发布者特定自定义数据。
• UpdateUserReadOnlyData 更新用户仅可由客户端读取的标题特定自定义数据。
• UpdateUserTitleDisplayName 更新用户的标题特定显示名称。

​

Client API

• AcceptTrade 接受尚未被接受或取消的开放交易——前提是本地登录玩家在该交易的允许玩家列表中，或该交易对所有玩家开放。若调用成功，报价和接受的物品将在两位玩家的库存之间交换。
• AddFriend 根据提供的唯一标识符匹配，将 PlayFab 用户添加到本地用户的好友列表。至少需要初始化 FriendPlayFabId、FriendUsername、FriendEmail 或 FriendTitleDisplayName 之一。
• AddGenericID 将指定的通用服务标识符添加到玩家的 PlayFab 账户。这样做旨在允许对标题希望添加的任意服务标识符进行 PlayFab ID 查找。此标识符不应用作身份验证凭据，因为其目的是可被其他玩家轻松访问。
• AddOrUpdateContactEmail 向玩家配置文件添加或更新联系电子邮件。
• AddSharedGroupMembers 将用户添加到能够更新共享数据以及组内成员集合的用户集合。只有组内用户（和服务器）可添加新成员。共享组适用于极少数玩家之间共享数据，见 使用共享组数据。
• AddUsernamePassword 向通过匿名身份验证方式（例如自动设备 ID 登录）创建的现有账户添加 PlayFab 用户名/密码身份验证。
• AndroidDevicePushNotificationRegistration 注册 Android 设备以接收推送通知
• ConsumePSNEntitlements 检查是否有新的可消耗权利。如果有，将被消耗并作为 PlayFab 物品添加。
• ConsumeXboxEntitlements 授予玩家当前从 XBOX Live 获得的权利，消耗 XBOX 中所有可用物品并将其授予玩家的 PlayFab 库存。此调用是幂等的，不会向玩家授予先前已授予的物品。
• CreateSharedGroup 请求创建共享组对象，其中包含可由该组所有成员更新的键/值对。创建时，当前用户将是组的唯一成员。共享组适用于极少数玩家之间共享数据。更多信息请参阅 使用共享组数据。
• GrantCharacterToUser 向用户授予指定角色类型。CharacterIds 不是全局唯一的；必须结合父级 PlayFabId 评估 characterId 以保证唯一性。
• LinkAndroidDeviceID 将 Android 设备标识符链接到用户的 PlayFab 账户
• LinkCustomID 将由标题生成的自定义标识符链接到用户的 PlayFab 账户。
• LinkFacebookAccount 将与提供的 Facebook 访问令牌关联的 Facebook 账户链接到用户的 PlayFab 账户。
• LinkFacebookInstantGamesId 将 Facebook Instant Games 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™Network 账户链接到用户的 PlayFab 账户。
• LinkSteamAccount 将与提供的 Steam 身份验证凭证关联的 Steam 账户链接到用户的 PlayFab 账户。
• LinkTwitch 将与令牌关联的 Twitch 账户链接到用户的 PlayFab 账户。
• LinkXboxAccount 将与提供的访问代码关联的 XBOX Live 账户链接到用户的 PlayFab 账户。
• OpenTrade 开启新的未处理交易。请注意，任何给定的物品实例一次只能存在于一笔开放交易中。
• PurchaseItem 用虚拟货币购买单件物品。你必须同时指定用于购买的虚拟货币，以及客户端所认为的价格。这样，如果价格已更改，服务器可以让购买失败。
• PayForPurchase 为通过 StartPurchase 创建的采购订单选择支付方式
• RegisterForIOSPushNotification 注册 iOS 设备以接收推送通知
• RegisterPlayFabUser 注册新的 PlayFab 用户账户，返回可用于后续需要身份验证的 API 调用的会话标识符。你必须提供用户名或电子邮件地址。
• RemoveContactEmail 从玩家配置文件中移除联系电子邮件。
• RemoveFriend 从本地用户的好友列表中移除指定用户。
• RemoveGenericID 从玩家的 PlayFab 账户中移除指定的通用服务标识符。
• RemoveSharedGroupMembers 从能够更新共享数据的用户集合以及组内用户集合中移除用户。只有组内用户可以移除成员。如果调用结果导致零用户拥有访问权限，则组及其相关数据将被删除。共享组适用于极少数玩家之间共享数据，见 使用共享组数据。
• ReportAdActivity 报告玩家的广告活动
• ReportDeviceInfo 写入 PlayStream 事件以描述所提供的玩家设备信息。此 API 方法不适合开发者直接调用。每个 PlayFab 客户端 SDK 最终会自动报告此信息。
• ReportPlayer 提交对另一玩家（因不当行为等）的举报，以便标题的客户服务代表可以对可能有害的玩家采取行动。
• RestoreIOSPurchases 基于给定的恢复凭据恢复所有应用内购买
• SetFriendTags 更新本地用户好友列表中指定用户的标签列表。
• SubtractUserVirtualCurrency 将用户指定虚拟货币的余额按所述数量递减。此 API 可使 VC 余额为负。
• UnlinkAndroidDeviceID 从用户的 PlayFab 账户取消相关 Android 设备标识符的链接。
• UnlinkCustomID 从用户的 PlayFab 账户取消相关自定义标识符的链接。
• UnlinkFacebookAccount 从用户的 PlayFab 账户取消相关 Facebook 账户的链接。
• UnlinkFacebookInstantGamesId 从用户的 PlayFab 账户取消相关 Facebook Instant Game Id 的链接。
• UnlinkGameCenterAccount 从用户的 PlayFab 账户取消相关 Game Center 账户的链接。
• UnlinkGoogleAccount 从用户的 PlayFab 账户取消相关 Google 账户的链接 (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods)。
• 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 账户的链接。
• UnlinkXboxAccount 从用户的 PlayFab 账户取消相关 XBOX Live 账户的链接。
• UnlockContainerInstance 使用指定密钥（如需）打开指定容器，并返回打开容器的内容。若容器（以及相关密钥）是可消耗的（RemainingUses > 0），其 RemainingUses 将被递减，行为与 ConsumeItem 保持一致。
• UnlockContainerItem 在目标库存中搜索匹配给定 CatalogItemId 的 ItemInstance，必要时使用合适的密钥解锁，并返回打开容器的内容。若容器（以及相关密钥）是可消耗的（RemainingUses > 0），其 RemainingUses 将被递减，行为与 ConsumeItem 保持一致。
• UpdateAvatarUrl 更新玩家的头像 URL。
• UpdateCharacterData 创建并更新用户角色可由客户端读写的标题特定自定义数据
• UpdateCharacterStatistics 更新指定角色的标题特定统计信息值。默认情况下，客户端不允许更新统计信息。开发者可以在 Game Manager > Settings > API Features 中覆盖此设置。
• UpdatePlayerStatistics 更新用户的标题特定统计信息值。默认情况下，客户端不允许更新统计信息。开发者可以在 Game Manager > Settings > API Features 中覆盖此设置。
• UpdateSharedGroupData 为共享组对象添加、更新和移除数据键。如果权限设置为 Public，则在此调用中更新或添加的所有字段都可以被非组成员读取。默认情况下，数据权限设置为 Private。无论权限设置如何，只有组内成员可以更新数据。共享组适用于极少数玩家之间共享数据，见 使用共享组数据。
• UpdateUserData 创建并更新用户可由客户端读写的标题特定自定义数据。
• UpdateUserPublisherData 创建并更新用户可由客户端读写的发布者特定自定义数据。
• UpdateUserTitleDisplayName 更新用户的标题特定显示名称

​

Data API

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

​

Groups API

• AcceptGroupApplication 接受加入组的未处理邀请
• AcceptGroupInvitation 接受加入组的邀请。
• AddMembers 向组或角色添加成员。
• ApplyToGroup 申请加入组。
• BlockEntity 阻止实体列表加入组。
• ChangeMemberRole 将实体列表的角色成员身份从一个角色更改为另一个角色。
• CreateGroup 创建新的组。
• CreateRole 创建新的组角色。
• DeleteGroup 删除组以及与之关联的所有角色、邀请、加入申请和阻止。
• DeleteRole 删除组中的现有角色。
• InviteToGroup 邀请玩家加入组。
• RemoveGroupApplication 移除加入组的申请。
• RemoveGroupInvitation 移除加入组的邀请。
• RemoveMembers 从组中移除成员。
• UnblockEntity 取消阻止实体列表加入组。
• UpdateGroup 更新组的非成员身份数据。
• UpdateRole 更新角色的元数据。

​

Profile API

• SetGlobalPolicy 设置全局标题访问策略。
• SetProfileLanguage 更新实体的语言。与玩家沟通的优先级层次为：Title Player Account 语言、Master Player Account 语言，然后是标题默认语言（若前两者未设置或不受支持）。
• SetProfilePolicy 设置配置文件访问策略。

​

Server API

• AddCharacterVirtualCurrency 将角色指定虚拟货币的余额按所述数量递增。
• AddFriend 将 Friend 用户添加到具有 PlayFabId 的用户的好友列表。至少需要初始化 FriendPlayFabId、FriendUsername、FriendEmail 或 FriendTitleDisplayName 之一。
• AddGenericID 将指定的通用服务标识符添加到玩家的 PlayFab 账户。这样做旨在允许对标题希望添加的任意服务标识符进行 PlayFab ID 查找。此标识符不应用作身份验证凭据，因为其目的是可被其他玩家轻松访问。
• AddPlayerTag 向玩家配置文件添加给定标签。标签的命名空间根据标签来源自动生成。
• AddSharedGroupMembers 将用户添加到能够更新共享数据以及组内成员集合的用户集合。只有组内用户（和服务器）可添加新成员。共享组适用于极少数玩家之间共享数据，见 使用共享组数据。
• AddUserVirtualCurrency 将用户指定虚拟货币的余额按所述数量递增。
• AwardSteamAchievement 向指定用户授予指定的 Steam 成就。
• BanUsers 通过 PlayFab ID 封禁用户，可为所提供的游戏提供可选的 IP 地址。
• ConsumeItem 消耗可消耗物品的使用次数。当所有使用次数用完时，将从玩家库存中移除。
• CreateSharedGroup 请求创建共享组对象，其中包含可由该组所有成员更新的键/值对。由服务器创建时，组最初没有成员。共享组适用于极少数玩家之间共享数据，见 使用共享组数据。
• DeleteCharacterFromUser 从指定用户中删除特定角色 ID。
• DeleteSharedGroup 删除共享组，释放共享组 ID 以供新组重用。共享组适用于极少数玩家之间共享数据，见 使用共享组数据。
• GrantCharacterToUser 向用户授予指定角色类型。CharacterIds 不是全局唯一的；必须结合父级 PlayFabId 评估 characterId 以保证唯一性。
• GrantItemsToCharacter 将指定物品添加到指定角色的库存。
• GrantItemsToUser 将指定物品添加到指定用户的库存。
• GrantItemsToUsers 将指定物品添加到指定用户库存。
• LinkServerCustomId 将由标题生成的自定义服务器标识符链接到用户的 PlayFab 账户。
• LinkXboxAccount 将与提供的访问代码关联的 XBOX Live 账户链接到用户的 PlayFab 账户。
• ModifyItemUses 修改玩家库存物品的剩余使用次数。
• MoveItemToCharacterFromCharacter 将物品从一个角色的库存移动到该用户的另一个角色的库存中。
• MoveItemToCharacterFromUser 将物品从用户的库存移动到其角色的库存中。
• MoveItemToUserFromCharacter 将物品从角色的库存移动到所属用户的库存中。
• RedeemCoupon 将与优惠券关联的虚拟商品添加到用户的库存。可通过 PlayFab Game Manager 中的 Economy->Catalogs 标签生成优惠券。
• RemoveFriend 从用户的好友列表中移除指定的好友。
• RemoveGenericID 从玩家的 PlayFab 账户中移除指定的通用服务标识符。
• RemovePlayerTag 从玩家配置文件中移除给定标签。标签的命名空间根据标签来源自动生成。
• RemoveSharedGroupMembers 从能够更新共享数据的用户集合以及组内用户集合中移除用户。只有组内用户可以移除成员。如果调用结果导致零用户拥有访问权限，则组及其相关数据将被删除。共享组适用于极少数玩家之间共享数据，见 使用共享组数据。
• RevokeAllBansForUser 撤销用户的所有活动封禁。
• RevokeBans 撤销所有以 BanId 指定的活动封禁。
• RevokeInventoryItem 撤销对用户库存中某项物品的访问权限。
• RevokeInventoryItems 撤销跨多个用户和角色最多 25 个物品的访问权限。
• SetFriendTags 更新另一用户好友列表中指定用户的标签列表。
• SetPlayerSecret 如果玩家密钥尚未设置，则设置它。玩家密钥用于签名 API 请求。要重置玩家密钥，请使用 Admin 或 Server API 方法 SetPlayerSecret。
• SetPublisherData 更新自定义发布者设置的键值存储。
• SetTitleData /rest/api/services/playfab/server/title-wide-data-management/setpublisherdata?
• SetTitleInternalData 更新自定义标题设置的键值存储
• SubtractCharacterVirtualCurrency 将角色指定虚拟货币的余额按所述数量递减。此 API 可使 VC 余额为负。
• SubtractUserVirtualCurrency 将用户指定虚拟货币的余额按所述数量递减。此 API 可使 VC 余额为负。
• UnlinkServerCustomId 从用户的 PlayFab 账户取消自定义服务器标识符的链接。
• UnlinkXboxAccount 从用户的 PlayFab 账户取消相关 XBOX Live 账户的链接。
• UnlockContainerInstance 使用指定密钥（KeyItemInstanceId，如需）打开特定容器（ContainerItemInstanceId），并返回打开容器的内容。若容器（以及相关密钥）是可消耗的（RemainingUses > 0），其 RemainingUses 将被递减，行为与 ConsumeItem 保持一致。
• UnlockContainerItem 在玩家或角色库存中搜索匹配给定 CatalogItemId 的任何 ItemInstance，必要时使用任何合适的密钥解锁，并返回打开容器的内容。若容器（以及相关密钥）是可消耗的（RemainingUses > 0），其 RemainingUses 将被递减，行为与 ConsumeItem 保持一致。
• UpdateAvatarUrl 更新指定玩家的头像 URL。
• UpdateBans 更新以 Ban Id 指定的现有封禁列表的信息。
• UpdateCharacterData 更新用户角色可由客户端读写的标题特定自定义数据。
• UpdateCharacterInternalData 更新用户角色的标题特定自定义数据，客户端无法访问。
• UpdateCharacterReadOnlyData 更新用户角色仅可由客户端读取的标题特定自定义数据。
• UpdateCharacterStatistics 更新指定角色的标题特定统计信息值。
• UpdatePlayerStatistics 更新用户的标题特定统计信息值。
• UpdateUserData 更新用户可由客户端读写的标题特定自定义数据。
• UpdateUserInternalData 更新用户的标题特定自定义数据，客户端无法访问。
• UpdateUserInventoryItemCustomData 更新标记到指定物品的键值对数据，该数据对客户端为只读。
• UpdateUserPublisherData 更新用户可由客户端读写的发布者特定自定义数据。
• UpdateUserPublisherInternalData 更新用户的发布者特定自定义数据，客户端无法访问。
• UpdateUserPublisherReadOnlyData 更新用户仅可由客户端读取的发布者特定自定义数据。
• UpdateUserReadOnlyData 更新用户仅可由客户端读取的标题特定自定义数据。