> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 配置文件读取计量 API 说明

> PlayFab API 参考列表：玩家配置文件、实体、角色、组和库存 KVP 等会累加配置文件读取计量。

Profile 包括与玩家配置文件、实体配置文件、角色配置文件、组和库存相关的任何存储数据。配置文件数据是适用于单个玩家、玩家组或物品的信息，由 PlayFab 以键/值对（KVP）形式存储。

以下 API 会累加配置文件读取计量。

## Admin API

* [CheckLimitedEditionItemAvailability](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/check-limited-edition-item-availability?view=playfab-rest\&preserve-view=true) 查询限量版物品的全局数量。
* [GetAllSegments](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/play-stream/get-all-segments?view=playfab-rest\&preserve-view=true) 检索玩家细分定义数组。其结果可用于后续需要细分 ID 的 API 调用（如 GetPlayersInSegment）。虽然细分名称可能会更改，但该细分的 ID 不会更改。
* [ExportMasterPlayerData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/export-master-player-data?view=playfab-rest\&preserve-view=true) 导出主玩家账户的所有关联数据。
* [GetCatalogItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/get-catalog-items?view=playfab-rest\&preserve-view=true) 检索标题虚拟商品目录的指定版本，包括所有已定义的属性。
* [GetContentList](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/content/get-content-list?view=playfab-rest\&preserve-view=true) 列出标题的所有内容并获取统计信息（如大小）。
* [GetDataReport](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/get-data-report?view=playfab-rest\&preserve-view=true) 检索所请求报告的下载 URL。
* [GetPlayerSegments](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/play-stream/get-player-segments?view=playfab-rest\&preserve-view=true) 列出玩家当前所属的所有细分。
* [GetPlayerTags](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/play-stream/get-player-tags?view=playfab-rest\&preserve-view=true) 从玩家配置文件中获取给定命名空间（可选）的所有标签。
* [GetPolicy](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/get-policy?view=playfab-rest\&preserve-view=true) 获取所请求的策略。
* [GetPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/get-publisher-data?view=playfab-rest\&preserve-view=true) 检索自定义发布者设置的键值存储。
* [GetRandomResultTables](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/get-random-result-tables?view=playfab-rest\&preserve-view=true) 检索标题的随机掉落表配置。
* [GetStoreItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/get-store-items?view=playfab-rest\&preserve-view=true) 检索为指定商店定义的物品集合，包括所有已定义的价格。
* [GetTitleData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/get-title-data?view=playfab-rest\&preserve-view=true) 检索客户端可读取的自定义标题设置的键值存储。
* \[GetUserAccountInfo]\(根据提供的唯一标识符匹配检索指定用户的相关详细信息) 根据提供的唯一标识符匹配检索指定用户的相关详细信息。
* [GetUserBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/get-user-bans?view=playfab-rest\&preserve-view=true) 获取用户的所有封禁记录。
* [GetUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/get-user-data?view=playfab-rest\&preserve-view=true) 检索用户可由客户端读写的标题特定自定义数据。
* [GetUserInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/get-user-internal-data?view=playfab-rest\&preserve-view=true) 检索用户的标题特定自定义数据，客户端无法访问。
* [GetUserInventory](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/get-user-inventory?view=playfab-rest\&preserve-view=true) 检索指定用户当前的虚拟商品库存
* [GetUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/get-user-publisher-data?view=playfab-rest\&preserve-view=true) 检索用户可由客户端读写的发布者特定自定义数据。
* [GetUserPublisherInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/get-user-publisher-internal-data?view=playfab-rest\&preserve-view=true) 检索用户的发布者特定自定义数据，客户端无法访问。
* [GetUserPublisherReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/get-user-publisher-read-only-data?view=playfab-rest\&preserve-view=true) 检索用户仅可由客户端读取的发布者特定自定义数据。
* [GetUserReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/get-user-read-only-data?view=playfab-rest\&preserve-view=true) 检索用户仅可由客户端读取的标题特定自定义数据。
* [ListVirtualCurrencyTypes](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/list-virtual-currency-types?view=playfab-rest\&preserve-view=true) 返回为标题定义的所有虚拟货币的列表
* [GetPlayerIdFromAuthToken](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/get-player-id-from-auth-token?view=playfab-rest\&preserve-view=true) 从身份验证令牌获取玩家的 ID。
* [GetPlayersInSegment](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/play-stream/get-players-in-segment?view=playfab-rest\&preserve-view=true) 允许对给定细分中的所有玩家进行分页浏览。该 API 会在创建时对匹配细分定义的所有玩家配置文件生成快照，并在 Total Seconds to Live 期间保留；每次使用 Continuation Token 后会刷新其生命周期。分页过程中变化的配置文件不会反映在结果中。此操作当前不支持 AB Test 细分。
* [GetExperiments](https://learn.microsoft.com/en-us/rest/api/services/playfab/experimentation/experimentation/get-experiments?view=playfab-rest\&preserve-view=true) 获取标题所有实验的详细信息。
* [GetLatestScorecard](https://learn.microsoft.com/en-us/rest/api/services/playfab/experimentation/experimentation/get-latest-scorecard?view=playfab-rest\&preserve-view=true) 获取标题实验的最新记分卡。
* [GetTreatmentAssignment](https://learn.microsoft.com/en-us/rest/api/services/playfab/experimentation/experimentation/get-treatment-assignment?view=playfab-rest\&preserve-view=true) 获取该标题下每个正在运行的实验为玩家分配的处理组

## Client API

* [GetAllUsersCharacters](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/get-all-users-characters?view=playfab-rest\&preserve-view=true) 列出属于特定用户的所有角色。CharacterId 不是全局唯一的；必须结合父级 PlayFabId 来评估 characterId 以保证唯一性。
* [GetCatalogItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/title-wide-data-management/get-catalog-items?view=playfab-rest\&preserve-view=true) 检索标题虚拟商品目录的指定版本，包括所有已定义的属性。
* [GetCharacterData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/character-data/get-character-data?view=playfab-rest\&preserve-view=true) 检索角色可由客户端读写的标题特定自定义数据。
* [GetCharacterInventory](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/get-character-inventory?view=playfab-rest\&preserve-view=true) 检索指定角色当前的虚拟商品库存。
* [GetCharacterLeaderboard](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/get-character-leaderboard?view=playfab-rest\&preserve-view=true) 从排行榜的指定位置起，检索给定统计数据的角色排名列表。
* [GetCharacterReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/character-data/get-character-read-only-data?view=playfab-rest\&preserve-view=true) 检索角色仅可由客户端读取的标题特定自定义数据。
* [GetCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/get-character-statistics?view=playfab-rest\&preserve-view=true) 检索用户所有标题特定统计信息的详细信息。
* [GetFriendLeaderboard](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/get-friend-leaderboard?view=playfab-rest\&preserve-view=true) 从排行榜指定位置起，检索当前玩家好友的给定统计数据的排名列表。
* [GetFriendLeaderboardAroundPlayer](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/get-friend-leaderboard-around-player?view=playfab-rest\&preserve-view=true) 以请求的 PlayFab 用户为中心，检索当前玩家好友的给定统计数据的排名列表。如果 PlayFabId 为空或 null，则返回当前登录用户的列表。
* [GetFriendsList](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/friend-list-management/get-friends-list?view=playfab-rest\&preserve-view=true) 检索本地用户当前的好友列表，仅限拥有 PlayFab 账户的用户。来自关联账户（Facebook、Steam）的好友也会包含在内。你可以选择排除某些关联服务的好友。
* [GetLeaderboard](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/get-leaderboard?view=playfab-rest\&preserve-view=true) 从排行榜指定位置起，检索给定统计数据的用户排名列表。
* [GetLeaderboardAroundCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/get-leaderboard-around-character?view=playfab-rest\&preserve-view=true) 以请求的角色 ID 为中心，检索给定统计数据的角色排名列表。
* [GetLeaderboardAroundPlayer](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/get-leaderboard-around-player?view=playfab-rest\&preserve-view=true) 以请求的玩家为中心，检索给定统计数据的用户排名列表。如果 PlayFabId 为空或 null，则返回当前登录用户。
* [GetLeaderboardForUserCharacters](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/get-leaderboard-for-user-characters?view=playfab-rest\&preserve-view=true) 检索用户所有角色的给定统计数据列表。
* [GetPaymentToken](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/get-payment-token?view=playfab-rest\&preserve-view=true) 用于支付流程，其中支付提供商要求由 PlayFab（履约方）发起交易，但客户端完成其余流程。在 Xsolla 情境中，此处返回的令牌将由客户端传给 Xsolla 以创建购物车。完成支付后使用返回的 OrderId 轮询 GetPurchase。
* [GetPlayerProfile](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-player-profile?view=playfab-rest\&preserve-view=true) 检索玩家的配置文件。
* [GetPlayerSegments](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/play-stream/get-player-segments?view=playfab-rest\&preserve-view=true) 列出玩家当前所属的所有细分。
* [GetPlayerStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/get-player-statistics?view=playfab-rest\&preserve-view=true) 为本地玩家检索指定的统计信息（如果未指定，则返回所有统计信息的当前版本和值）。
* [GetPlayerStatisticVersions](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/get-player-statistic-versions?view=playfab-rest\&preserve-view=true) 检索指定统计信息可用版本的信息。
* [GetPlayerTags](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/play-stream/get-player-tags?view=playfab-rest\&preserve-view=true) 从玩家配置文件中获取具有给定命名空间（可选）的所有标签。
* [GetPlayerTrades](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/trading/get-player-trades?view=playfab-rest\&preserve-view=true) 获取玩家开启或接受的所有交易，可按交易状态选择性过滤。
* [GetPlayFabIDsFromFacebookIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-facebook-ids?view=playfab-rest\&preserve-view=true) 检索给定 Facebook 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromFacebookInstantGamesIds](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-facebook-instant-games-ids?view=playfab-rest\&preserve-view=true) 检索给定 Facebook Instant Game 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromGameCenterIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-game-center-ids?view=playfab-rest\&preserve-view=true) 检索给定 Game Center 标识符集合的唯一 PlayFab 标识符（在 Game Center 编程指南中被称为 Player Identifier）。
* [GetPlayFabIDsFromGenericIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-generic-ids?view=playfab-rest\&preserve-view=true) 检索给定通用服务标识符集合的唯一 PlayFab 标识符。通用标识符是服务名称加上标题在将通用标识符添加到玩家账户时为该玩家指定的服务特定 ID。
* [GetPlayFabIDsFromGoogleIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-google-ids?view=playfab-rest\&preserve-view=true) 检索给定 Google 标识符集合的唯一 PlayFab 标识符。Google 标识符是用户账户的 ID，可通过 Google+ People API 调用中的 `id` 获得。
* [GetPlayFabIDsFromKongregateIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-kongregate-ids?view=playfab-rest\&preserve-view=true) 检索给定 Kongregate 标识符集合的唯一 PlayFab 标识符。Kongregate 标识符是用户账户的 ID，可从 Kongregate API 方法中的 `user_id` 获得（例如 [https://docs.kongregate.com/docs/concepts-handling-guests](https://docs.kongregate.com/docs/concepts-handling-guests)）。
* [GetPlayFabIDsFromNintendoSwitchDeviceIds](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-nintendo-switch-device-ids?view=playfab-rest\&preserve-view=true) 检索给定 Nintendo Switch 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromPSNAccountIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-psn-account-ids?view=playfab-rest\&preserve-view=true) 检索给定 PlayStation™ Network 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromSteamIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-steam-ids?view=playfab-rest\&preserve-view=true) 检索给定 Steam 标识符集合的唯一 PlayFab 标识符。Steam 标识符是用户账户的配置文件 ID，可从 Steamworks Community API 调用中的 SteamId 获得。
* [GetPlayFabIDsFromTwitchIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-twitch-ids?view=playfab-rest\&preserve-view=true) 检索给定 Twitch 标识符集合的唯一 PlayFab 标识符。Twitch 标识符是用户账户的 ID，可从 Twitch API 方法的 "\_id" 获得（例如：[https://github.com/justintv/Twitch-API/blob/master/v3\_resources/users.md#get-usersuser](https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser)）。
* [GetPlayFabIDsFromXboxLiveIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-playfab-ids-from-xbox-live-ids?view=playfab-rest\&preserve-view=true) 检索给定 XboxLive 标识符集合的唯一 PlayFab 标识符。
* [GetPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/title-wide-data-management/get-publisher-data?view=playfab-rest\&preserve-view=true) 检索自定义发布者设置的键值存储。
* [GetPurchase](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/get-purchase?view=playfab-rest\&preserve-view=true) 检索一次购买及其当前的 PlayFab 状态。返回购买中仍处于活动状态的库存物品。
* [GetSharedGroupData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/shared-group-data/get-shared-group-data?view=playfab-rest\&preserve-view=true) 检索存储在共享组对象中的数据以及组成员列表。组的非成员使用它来检索组数据（包括成员身份），但不会收到标记为私有的键的数据。共享组适用于少量玩家之间共享数据。更多信息请参阅 [使用共享组数据](/services/playfab/community/associations/groups/using-shared-group-data)。
* [GetStoreItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/title-wide-data-management/get-store-items?view=playfab-rest\&preserve-view=true) 检索为指定商店定义的物品集合，包括所有已定义的价格。
* [GetTitleData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/title-wide-data-management/get-title-data?view=playfab-rest\&preserve-view=true) 检索自定义标题设置的键值存储
* [GetAccountInfo](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-account-info?view=playfab-rest\&preserve-view=true) 检索用户的 PlayFab 账户详细信息。
* [LoginWithAndroidDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-android-device-id?view=playfab-rest\&preserve-view=true) 使用 Android 设备标识符登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [LoginWithCustomID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/loginwithcustomid?view=playfab-rest\&preserve-view=true) 使用标题生成的自定义唯一标识符登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符
* [LoginWithEmailAddress](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-email-address?view=playfab-rest\&preserve-view=true) 将用户登录到 PlayFab 账户，返回可用于后续需要身份验证的 API 调用的会话标识符。与大多数其他登录 API 调用不同，LoginWithEmailAddress 不允许通过 CreateAccountFlag 创建新账户。电子邮件地址可通过 RegisterPlayFabUser 用于创建账户。
* [LoginWithFacebook](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-facebook?view=playfab-rest\&preserve-view=true) 使用 Facebook 访问令牌登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [LoginWithFacebookInstantGamesId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-facebook-instant-games-id?view=playfab-rest\&preserve-view=true) 使用 Facebook Instant Games ID 登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。需要配置 Facebook Instant Games。
* [LoginWithGameCenter](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/loginwithgamecenter?view=playfab-rest\&preserve-view=true) 使用 iOS Game Center 玩家标识符登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [LoginWithGoogleAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-game-center?view=playfab-rest\&preserve-view=true) 使用 iOS Game Center 玩家标识符登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [LoginWithIOSDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-google-account?view=playfab-rest\&preserve-view=true) 使用用户的 Google 账户凭据登录用户。
* [LoginWithKongregate](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-kongregate?view=playfab-rest\&preserve-view=true) 使用 Kongregate 玩家账户登录用户。
* [LoginWithNintendoSwitchDeviceId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-nintendo-switch-device-id?view=playfab-rest\&preserve-view=true) 使用 Nintendo Switch Device ID 登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [LoginWithOpenIdConnect](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-openid-connect?view=playfab-rest\&preserve-view=true) 通过标题与 Open ID Connect 提供者之间已有关系创建的 Open ID Connect JWT 登录用户。
* [LoginWithPlayFab](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-playfab?view=playfab-rest\&preserve-view=true) 需要身份验证的用户。与大多数其他登录 API 调用不同，`LoginWithPlayFab` 不允许通过 `CreateAccountFlag` 创建新账户。用户名/密码凭据可通过 `RegisterPlayFabUser` 用于创建账户，或使用 `AddUsernamePassword` 添加到现有账户。
* [LoginWithPSN](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-psn?view=playfab-rest\&preserve-view=true)    将用户登录到 PlayFab 账户，返回可用于后续需要身份验证的 API 调用的会话标识符。与大多数其他登录 API 调用不同，`LoginWithPlayFab` 不允许通过 `CreateAccountFlag` 创建新账户。用户名/密码凭据通过 `RegisterPlayFabUser` 用于创建账户，或使用 `AddUsernamePassword` 添加到现有账户。
* [LoginWithSteam](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-steam?view=playfab-rest\&preserve-view=true) 使用 Steam 身份验证凭据登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [LoginWithTwitch](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/login-with-twitch?view=playfab-rest\&preserve-view=true) 使用 Twitch 访问令牌登录用户。
* [LoginWithXbox](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/loginwithxbox?view=playfab-rest\&preserve-view=true) 使用 XBOX Live 令牌登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [GetPlayerCombinedInfo](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/get-player-combined-info?view=playfab-rest\&preserve-view=true) 检索用户各种不同类型的信息。

"PlayStation" 是 Sony Interactive Entertainment Inc. 的注册商标或商标。

## Data API

* [GetObjects](https://learn.microsoft.com/en-us/rest/api/services/playfab/data/object/get-objects?view=playfab-rest\&preserve-view=true) 从实体的配置文件中检索对象。

## Groups API

* [GetGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/get-group?view=playfab-rest\&preserve-view=true) 获取组及其角色的信息。
* [IsMember](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/is-member?view=playfab-rest\&preserve-view=true) 检查实体是否为组的成员或组内角色的成员。
* [ListGroupApplications](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/list-group-applications?view=playfab-rest\&preserve-view=true) 列出所有未处理的加入组申请。
* [ListGroupBlocks](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/list-group-blocks?view=playfab-rest\&preserve-view=true) 列出所有被阻止加入组的实体。
* [ListGroupInvitations](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/list-group-invitations?view=playfab-rest\&preserve-view=true) 列出组的所有未处理邀请。
* [ListGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/list-group-members?view=playfab-rest\&preserve-view=true) 列出组的所有成员。
* [ListMembership](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/list-membership?view=playfab-rest\&preserve-view=true) 列出实体的所有组和角色。
* [ListMembershipOpportunities](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/list-membership-opportunities?view=playfab-rest\&preserve-view=true) 列出实体的所有未处理邀请和入组申请。

## Profile API

* [GetGlobalPolicy](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/get-global-policy?view=playfab-rest\&preserve-view=true) 获取全局标题访问策略。
* [GetProfile](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/get-profile?view=playfab-rest\&preserve-view=true) 检索实体的配置文件。
* [GetProfiles](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/get-profiles?view=playfab-rest\&preserve-view=true) 检索实体的配置文件。
* [GetTitlePlayersFromMasterPlayerAccountIds](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/get-title-players-from-master-player-account-ids?view=playfab-rest\&preserve-view=true) 检索与给定主玩家账户关联的标题玩家账户。

## Server API

* [EvaluateRandomResultTable](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/evaluate-random-result-table?view=playfab-rest\&preserve-view=true) 返回随机结果表评估的结果——如果通过 Bundle 或对 UnlockContainer 的调用添加了随机结果表，则会被添加到玩家库存的游戏目录中的 `ItemId`。
* [GetAllSegments](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/play-stream/get-all-segments?view=playfab-rest\&preserve-view=true) 检索玩家细分定义数组。其结果可用于后续需要细分 ID 的 API 调用（如 GetPlayersInSegment）。虽然细分名称可能会更改，但该细分的 ID 不会更改。
* [GetAllUsersCharacters](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/get-all-users-characters?view=playfab-rest\&preserve-view=true) 列出属于特定用户的所有角色。CharacterId 不是全局唯一的；必须结合父级 PlayFabId 来评估 characterId 以保证唯一性。
* [GetCatalogItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/get-catalog-items?view=playfab-rest\&preserve-view=true) 检索标题虚拟商品目录的指定版本，包括所有已定义的属性。
* [GetCharacterData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/get-character-data?view=playfab-rest\&preserve-view=true) 检索用户可由客户端读写的标题特定自定义数据。
* [GetCharacterInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/get-character-internal-data?view=playfab-rest\&preserve-view=true) 检索用户角色的标题特定自定义数据，客户端无法访问。
* [GetCharacterInventory](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/get-character-inventory?view=playfab-rest\&preserve-view=true) 检索指定角色当前的虚拟商品库存。
* [GetCharacterReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/get-character-leaderboard?view=playfab-rest\&preserve-view=true)
* [GetCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/get-character-statistics?view=playfab-rest\&preserve-view=true) 检索指定角色所有标题特定统计信息的详细信息。
* [GetFriendLeaderboard](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-friend-leaderboard?view=playfab-rest\&preserve-view=true) 从排行榜指定位置起，检索给定玩家好友的给定统计数据的排名列表。
* [GetFriendsList](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/friend-list-management/get-friends-list?view=playfab-rest\&preserve-view=true) 检索具有 `PlayFabId` 的用户的当前好友，仅限拥有 PlayFab 账户的用户。来自关联账户（Facebook、Steam）的好友也会包含在内。你可以选择排除某些关联服务的好友。
* [GetLeaderboard](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-leaderboard?view=playfab-rest\&preserve-view=true) 从排行榜指定位置起，检索给定统计数据的用户排名列表。
* [GetLeaderboardAroundCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/getleaderboardaroundcharacter?view=playfab-rest\&preserve-view=true) 以请求的用户为中心，检索给定统计数据的角色排名列表。
* [GetLeaderboardAroundUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/get-leaderboard-around-character?view=playfab-rest\&preserve-view=true) 以请求的用户为中心，检索给定统计数据的角色排名列表。
* [GetLeaderboardForUserCharacters](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/get-leaderboard-for-user-characters?view=playfab-rest\&preserve-view=true) 检索用户所有角色的给定统计数据列表。
* [GetPlayerCombinedInfo](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-player-combined-info?view=playfab-rest\&preserve-view=true) 返回响应中所请求的用户任何信息。注意，可能会返回个人数据，如电子邮件地址、Facebook ID。所有参数默认为 false。
* [GetPlayerProfile](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-player-profile?view=playfab-rest\&preserve-view=true) 检索玩家的配置文件。
* [GetPlayerSegments](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/play-stream/get-player-segments?view=playfab-rest\&preserve-view=true) 列出玩家当前所属的所有细分。
* [GetPlayersInSegment](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/play-stream/get-players-in-segment?view=playfab-rest\&preserve-view=true) 允许对给定细分中的所有玩家进行分页浏览。该 API 会在创建时对匹配细分定义的所有玩家配置文件生成快照，并在 Total Seconds to Live 期间保留；每次使用 Continuation Token 后会刷新其生命周期。分页过程中变化的配置文件不会反映在结果中。此操作当前不支持 AB Test 细分。
* [GetPlayerStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-player-statistics?view=playfab-rest\&preserve-view=true) 检索本地玩家指定统计信息的当前版本和值。
* [GetPlayerStatisticVersions](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-player-statistic-versions?view=playfab-rest\&preserve-view=true) 检索指定统计信息可用版本的信息。
* [GetPlayerTags](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/play-stream/get-player-tags?view=playfab-rest\&preserve-view=true) 从玩家配置文件中获取具有给定命名空间（可选）的所有标签。
* [GetPlayFabIDsFromFacebookIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/getplayfabidsfromfacebookids?view=playfab-rest\&preserve-view=true) 检索给定 Facebook 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromFacebookInstantGamesIds](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-playfab-ids-from-facebook-ids?view=playfab-rest\&preserve-view=true) 检索给定 Facebook 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromGenericIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-playfab-ids-from-generic-ids?view=playfab-rest\&preserve-view=true) 检索给定通用服务标识符集合的唯一 PlayFab 标识符。通用标识符是服务名称加上标题在将通用标识符添加到玩家账户时为该玩家指定的服务特定 ID。
* [GetPlayFabIDsFromNintendoSwitchDeviceIds](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-playfab-ids-from-nintendo-switch-device-ids?view=playfab-rest\&preserve-view=true) 检索给定 Nintendo Switch Device 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromPSNAccountIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-playfab-ids-from-psn-account-ids?view=playfab-rest\&preserve-view=true) 检索给定 PlayStation Network 标识符集合的唯一 PlayFab 标识符。
* [GetPlayFabIDsFromSteamIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-playfab-ids-from-steam-ids?view=playfab-rest\&preserve-view=true) 检索给定 Steam 标识符集合的唯一 PlayFab 标识符。Steam 标识符是用户账户的配置文件 ID，可从 Steamworks Community API 调用中的 SteamId 获得。
* [GetPlayFabIDsFromXboxLiveIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-playfab-ids-from-xbox-live-ids?view=playfab-rest\&preserve-view=true) 检索给定 XboxLive 标识符集合的唯一 PlayFab 标识符。
* [GetPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/get-publisher-data?view=playfab-rest\&preserve-view=true) 检索自定义发布者设置的键值存储。
* [GetRandomResultTables](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/get-random-result-tables?view=playfab-rest\&preserve-view=true) 检索标题指定随机结果表的配置信息，包括所有 ItemId 值和权重。
* [GetServerCustomIDsFromPlayFabIDs](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-server-custom-ids-from-playfab-ids?view=playfab-rest\&preserve-view=true) 检索给定服务器自定义标识符集合的关联 PlayFab 账户标识符。
* [GetSharedGroupData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/get-shared-group-data?view=playfab-rest\&preserve-view=true) 检索存储在共享组对象中的数据以及组成员列表。服务器可以访问所有公共和私有组数据。共享组适用于少量玩家之间共享数据。更多信息请参阅 [使用共享组数据](/services/playfab/community/associations/groups/using-shared-group-data)。
* [GetStoreItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/get-store-items?view=playfab-rest\&preserve-view=true) 检索为指定玩家在指定商店中定义的物品集合，包括所有已定义的价格。
* [GetTitleData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/get-title-data?view=playfab-rest\&preserve-view=true) 检索自定义标题设置的键值存储。
* [GetTitleInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/get-title-internal-data?view=playfab-rest\&preserve-view=true) 检索自定义内部标题设置的键值存储。
* [GetUserAccountInfo](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-user-account-info?view=playfab-rest\&preserve-view=true) 检索指定用户的相关详细信息。
* [GetUserBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/get-user-bans?view=playfab-rest\&preserve-view=true) 获取用户的所有封禁记录。
* [GetUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-user-data?view=playfab-rest\&preserve-view=true) 检索用户可由客户端读写的标题特定自定义数据。
* [GetUserInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-user-internal-data?view=playfab-rest\&preserve-view=true) 检索用户的标题特定自定义数据，客户端无法访问。
* [GetUserInventory](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/get-user-inventory?view=playfab-rest\&preserve-view=true) 检索指定用户当前的虚拟商品库存。
* [GetUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-user-publisher-data?view=playfab-rest\&preserve-view=true) 检索用户可由客户端读写的发布者特定自定义数据。
* [GetUserPublisherInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/getuserpublisherinternaldata?view=playfab-rest\&preserve-view=true) 检索用户的发布者特定自定义数据，客户端无法访问。
* [GetUserPublisherReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/get-user-publisher-internal-data?view=playfab-rest\&preserve-view=true)
* [GetUserReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/update-user-read-only-data?view=playfab-rest\&preserve-view=true) 更新用户仅可由客户端读取的标题特定自定义数据。
* [LoginWithServerCustomId](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/authentication/login-with-server-custom-id?view=playfab-rest\&preserve-view=true) 使用玩家的自定义标识符从外部服务器后端安全登录游戏客户端。Server Custom ID 与 Client Custom ID 互斥，无法用于检索同一玩家账户。
* [LoginWithXbox](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/authentication/login-with-xbox?view=playfab-rest\&preserve-view=true) 使用来自外部服务器后端的 XBOX Live 令牌登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。
* [LoginWithXboxId](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/authentication/login-with-xbox-id?view=playfab-rest\&preserve-view=true) 使用 XBOX ID 和 Sandbox ID 登录用户，返回可用于后续需要身份验证的 API 调用的会话标识符。