> ## 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 描述

> 玩家設定檔、實體、角色、群組和物品欄 KVP 之 PlayFab API 的參考清單，這些 API 會讓設定檔讀取計量遞增。

設定檔包括與玩家設定檔、實體設定檔、角色設定檔、群組和物品欄相關的任何儲存資料。設定檔資料是適用於個別玩家、玩家群組或物品的資訊，並由 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) 擷取玩家區段定義的陣列。其結果可用於後續的 API 呼叫，例如需要區段識別碼的 GetPlayersInSegment。雖然區段名稱可以變更，但該區段的識別碼不會變更。
* [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]\(Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier) 根據與所提供之唯一識別碼的比對，擷取指定使用者的相關詳細資料。
* [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) 從驗證權杖取得玩家識別碼。
* [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 測試區段。
* [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 並非全域唯一；必須將 characterId 與上層 PlayFabId 一起評估，才能保證唯一性。
* [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) 擷取指定統計資料的排名角色清單，以所要求的角色識別碼為中心。
* [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 識別碼集合 (在 Game Center 程式設計指南中稱為 Player Identifier) 的唯一 PlayFab 識別碼。
* [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 識別碼。一般識別碼是服務名稱加上玩家的服務特定識別碼，由遊戲在將一般識別碼新增至玩家帳戶時指定。
* [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 識別碼是使用者帳戶的識別碼，可在 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 識別碼是使用者帳戶的識別碼，可從 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 識別碼是使用者帳戶的設定檔識別碼，可在 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 識別碼是使用者帳戶的識別碼，可從 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) 擷取儲存在共用群組物件中的資料，以及群組成員清單。群組的非成員可以使用此項目擷取群組資料 (包括成員資格)，但不會收到標示為私人之索引鍵的資料。共用群組是為少數玩家之間共用資料而設計的。如需詳細資訊，請參閱[使用共用群組資料](/zh-TW/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 識別碼讓使用者登入，傳回可用於需要已驗證使用者之 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 裝置識別碼讓使用者登入，傳回可用於需要已驗證使用者之 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) 傳回隨機結果表的評估結果——如果透過套組或呼叫 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) 擷取玩家區段定義的陣列。其結果可用於後續的 API 呼叫，例如需要區段識別碼的 GetPlayersInSegment。雖然區段名稱可以變更，但該區段的識別碼不會變更。
* [GetAllUsersCharacters](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/get-all-users-characters?view=playfab-rest\&preserve-view=true) 列出屬於特定使用者的所有角色。CharacterId 並非全域唯一；必須將 characterId 與上層 PlayFabId 一起評估，才能保證唯一性。
* [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 識別碼等個人資料。所有參數預設為 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 測試區段。
* [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 識別碼。一般識別碼是服務名稱加上玩家的服務特定識別碼，由遊戲在將一般識別碼新增至玩家帳戶時指定。
* [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 裝置識別碼集合的唯一 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 識別碼是使用者帳戶的設定檔識別碼，可在 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) 擷取儲存在共用群組物件中的資料，以及群組成員清單。伺服器可以存取所有公用和私人群組資料。共用群組是為少數玩家之間共用資料而設計的。如需詳細資訊，請參閱[使用共用群組資料](/zh-TW/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) 使用玩家的自訂識別碼，從外部伺服器後端安全地登入遊戲用戶端。伺服器自訂識別碼和用戶端自訂識別碼互斥，無法用來擷取相同的玩家帳戶。
* [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 識別碼和沙箱識別碼讓使用者登入，傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。


## Related topics

- [內容和設定讀取計量 API 描述](/zh-TW/services/playfab/pricing/meters/file-reads.md)
- [物品欄讀取計量 API 描述](/zh-TW/services/playfab/pricing/meters/economy-reads.md)
- [設定檔寫入計量 API 描述](/zh-TW/services/playfab/pricing/meters/profile-writes.md)
- [定價計量](/zh-TW/services/playfab/pricing/meters/meters.md)
- [內容和設定寫入計量 API 描述](/zh-TW/services/playfab/pricing/meters/file-writes.md)