> ## 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 的參考清單，包括 AddPlayerTag 和虛擬貨幣更新，這些 API 會讓玩家和實體資料的設定檔寫入計量遞增。

設定檔包括與玩家設定檔、實體設定檔、角色設定檔、群組和物品欄相關的任何儲存資料。設定檔資料是適用於個別玩家、玩家群組或物品的資訊，並由 PlayFab 儲存為索引鍵/值組 (KVP)。

下列 API 會讓設定檔寫入計量遞增。

## Admin API

* [AddPlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/playstream/addplayertag?) 將指定的標籤新增至玩家設定檔。標籤的命名空間會根據標籤的來源自動產生。
* [AddUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/adduservirtualcurrency?) 將指定的虛擬貨幣遞增所述的數量
* [AddVirtualCurrencyTypes](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/addvirtualcurrencytypes?) 將一或多種虛擬貨幣新增至為遊戲定義的集合。授與玩家時，虛擬貨幣的最大值為 2,147,483,647。超過該值的任何值都會被捨棄。
* [BanUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/banusers?) 針對所提供的遊戲，依 PlayFab 識別碼 (可選擇搭配 IP 位址) 禁止使用者。
* [CreateActionsOnPlayersInSegmentTask](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask?) 建立 ActionsOnPlayersInSegment 工作，此工作會逐一查看區段中的所有玩家以執行動作。
* [CreatePlayerSharedSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/createplayersharedsecret?) 建立新的玩家共用秘密金鑰。此 API 傳回後，此金鑰可能需要最多 5 分鐘才會普遍可用。
* [CreatePlayerStatisticDefinition](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/createplayerstatisticdefinition?) 將新的玩家統計資料設定新增至遊戲，可選擇讓開發人員指定重設間隔和彙總方法。
* [DeleteMasterPlayerAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/deletemasterplayeraccount?) 從所有遊戲中完全移除主要玩家帳戶，並刪除所有相關資料。
* [DeletePlayer](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/deleteplayer?) 從遊戲中移除使用者的玩家帳戶，並刪除所有相關資料
* [DeletePlayerSharedSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/deleteplayersharedsecret?) 刪除現有的玩家共用秘密金鑰。此 API 傳回後，此刪除可能需要最多 5 分鐘才會反映出來。
* [DeleteStore](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/deletestore?) 刪除現有的虛擬物品商店。
* [DeleteTitle](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/deletetitle?) 永久刪除遊戲及所有相關設定。
* [GrantItemsToUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/grantitemstousers?) 將指定的物品新增至指定的使用者物品欄
* [IncrementLimitedEditionItemAvailability](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/incrementlimitededitionitemavailability?) 增加指定稀有資源的全域計數。
* [IncrementPlayerStatisticVersion](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/incrementplayerstatisticversion?) 重設指定的統計資料，移除其所有玩家項目並備份舊值。
* [RefundPurchase](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/refundpurchase?) 嘗試透過原始真實貨幣付款提供者處理訂單退款。""
* [RemovePlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/playstream/removeplayertag?) 從玩家設定檔移除指定的標籤。標籤的命名空間會根據標籤的來源自動產生。
* [RemoveVirtualCurrencyTypes](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/removevirtualcurrencytypes?) 從為遊戲定義的集合中移除一或多種虛擬貨幣。
* [ResetCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/characters/resetcharacterstatistics?) 完全移除指定角色在目前遊戲中的所有統計資料。
* [ResetUserStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/resetuserstatistics?) 完全移除指定使用者在目前遊戲中的所有統計資料。
* [ResolvePurchaseDispute](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/resolvepurchasedispute?) 嘗試與原始訂單的付款提供者解決爭議。
* [RevokeAllBansForUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/revokeallbansforuser?) 撤銷使用者的所有作用中禁止。
* [RevokeBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/revokebans?) 撤銷以 BanId 指定的所有作用中禁止。
* [RevokeInventoryItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/revokeinventoryitem?) 撤銷使用者物品欄中物品的存取權
* [RevokeInventoryItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/revokeinventoryitems?) 撤銷多位使用者和角色之間最多 25 個物品的存取權。
* [SetCatalogItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/setcatalogitems?) 為指定的目錄版本建立所有虛擬商品的目錄設定。
* [SetPlayerSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/setplayersecret?) 設定或重設玩家的秘密。玩家秘密用於簽署 API 要求。
* [SetPublishedRevision](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/server-side-cloud-script/setpublishedrevision?) 設定遊戲 Cloud Script 目前發佈的修訂。
* [SetPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/shared-group-data/setpublisherdata?) 更新自訂發行者設定的索引鍵值存放區
* [SetStoreItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/setstoreitems?) 設定一個虛擬商店中的所有物品。
* [SetTitleData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/settitledata?) 建立和更新用戶端可讀取之自訂遊戲設定的索引鍵值存放區。
* [SetTitleInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/settitleinternaldata?) 更新用戶端無法讀取之自訂遊戲設定的索引鍵值存放區。
* [SubtractUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/subtractuservirtualcurrency?) 將指定的虛擬貨幣遞減所述的數量。
* [UpdateBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/updatebans?) 更新以 Ban Id 指定之現有禁止清單的資訊。
* [UpdateCatalogItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/updatecatalogitems?) 更新指定目錄版本中虛擬商品的目錄設定。
* [UpdatePlayerSharedSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/updateplayersharedsecret?) 更新現有的玩家共用秘密金鑰。此 API 傳回後，此更新可能需要最多 5 分鐘才會普遍可用。
* [UpdatePlayerStatisticDefinition](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateplayerstatisticdefinition?) 更新遊戲的玩家統計資料設定，可選擇讓開發人員指定重設間隔。
* [UpdateRandomResultTables](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/updaterandomresulttables?) 更新遊戲的隨機掉落表設定
* [UpdateStoreItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/updatestoreitems?) 以新的或修改過的物品更新現有的虛擬物品商店。
* [UpdateUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserdata?) 更新使用者的遊戲特定自訂資料，用戶端可讀取和寫入此資料。
* [UpdateUserInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserinternaldata?) 更新使用者的遊戲特定自訂資料，用戶端無法存取此資料。
* [UpdateUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserpublisherdata?) 更新使用者的發行者特定自訂資料，用戶端可讀取和寫入此資料。
* [UpdateUserPublisherInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserpublisherinternaldata?) 更新使用者的發行者特定自訂資料，用戶端無法存取此資料。
* [UpdateUserPublisherReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserpublisherreadonlydata?) 更新使用者的發行者特定自訂資料，用戶端只能讀取此資料。
* [UpdateUserReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserreadonlydata?) 更新使用者的遊戲特定自訂資料，用戶端只能讀取此資料。
* [UpdateUserTitleDisplayName](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/updateusertitledisplayname?) 更新使用者的遊戲特定顯示名稱。

## Client API

* [AcceptTrade](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/trading/accepttrade?) 如果本機登入的玩家在交易的允許玩家清單中，或交易對所有玩家開放，則接受一筆開放的交易 (尚未被接受或取消的交易)。如果呼叫成功，提供和接受的物品將在兩位玩家的物品欄之間交換。
* [AddFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/friend-list-management/addfriend?) 根據與所提供之唯一識別碼的比對，將 PlayFab 使用者新增至本機使用者的好友清單。FriendPlayFabId、FriendUsername、FriendEmail 或 FriendTitleDisplayName 中至少應初始化一個。
* [AddGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/addgenericid?) 將指定的一般服務識別碼新增至玩家的 PlayFab 帳戶。此功能的設計目的是允許針對遊戲想要新增的任意服務識別碼查詢 PlayFab 識別碼。此識別碼永遠不應作為驗證認證使用，因為其目的是讓其他玩家能輕鬆存取。
* [AddOrUpdateContactEmail](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/addorupdatecontactemail?) 在玩家的設定檔中新增或更新連絡電子郵件。
* [AddSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/addsharedgroupmembers?) 將使用者新增至能夠更新共用資料以及群組中使用者集合的使用者集合。只有群組中的使用者 (和伺服器) 可以新增成員。共用群組是為極少數玩家之間共用資料而設計的，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [AddUsernamePassword](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/addusernamepassword?) 將 PlayFab 使用者名稱/密碼驗證新增至透過匿名驗證方法 (例如自動裝置識別碼登入) 建立的現有帳戶。
* [AndroidDevicePushNotificationRegistration](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration?) 註冊 Android 裝置以接收推播通知
* [ConsumePSNEntitlements](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/consumepsnentitlements?) 檢查是否有任何新的可消耗權利。如果找到任何權利，就會將其消耗並新增為 PlayFab 物品。
* [ConsumeXboxEntitlements](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/consumexboxentitlements?) 從 XBOX Live 授與玩家目前的權利，消耗 XBOX 中所有可用的物品，並將它們授與至玩家的 PlayFab 物品欄。此呼叫具有等冪性，不會將先前授與的物品再次授與玩家。
* [CreateSharedGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/shared-group-data/createsharedgroup?) 要求建立共用群組物件，其中包含群組所有成員都可以更新的索引鍵/值組。建立時，目前的使用者將是群組的唯一成員。共用群組是為極少數玩家之間共用資料而設計的。如需詳細資訊，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [GrantCharacterToUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/grantcharactertouser?) 將指定的角色類型授與使用者。CharacterId 並非全域唯一；必須將 characterId 與上層 PlayFabId 一起評估，才能保證唯一性。
* [LinkAndroidDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkandroiddeviceid?) 將 Android 裝置識別碼連結至使用者的 PlayFab 帳戶
* [LinkCustomID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkcustomid?) 將遊戲產生的自訂識別碼連結至使用者的 PlayFab 帳戶。
* [LinkFacebookAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkfacebookaccount?) 將與所提供之 Facebook 存取權杖相關聯的 Facebook 帳戶連結至使用者的 PlayFab 帳戶。
* [LinkFacebookInstantGamesId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkfacebookinstantgamesid?) 將 Facebook Instant Games 識別碼連結至使用者的 PlayFab 帳戶。
* [LinkGameCenterAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkgamecenteraccount?) 將與所提供之 Game Center 識別碼相關聯的 Game Center 帳戶連結至使用者的 PlayFab 帳戶。
* [LinkGoogleAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkgoogleaccount?) 使用 Google 帳戶認證，將目前登入的使用者帳戶連結至其 Google 帳戶。
* [LinkIOSDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkiosdeviceid?) 將廠商特定的 iOS 裝置識別碼連結至使用者的 PlayFab 帳戶。
* [LinkKongregate](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkkongregate?) 將 Kongregate 識別碼連結至使用者的 PlayFab 帳戶。
* [LinkNintendoSwitchDeviceId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linknintendoswitchdeviceid?) 將 NintendoSwitchDeviceId 連結至使用者的 PlayFab 帳戶。
* [LinkOpenIdConnect](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkopenidconnect?) 根據遊戲與 Open ID Connect 提供者之間現有的關係，以及來自該提供者的 OpenId Connect JWT，將 OpenID Connect 帳戶連結至使用者的 PlayFab 帳戶。
* [LinkPSNAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkpsnaccount?) 將與所提供之存取碼相關聯的 PlayStation™Network 帳戶連結至使用者的 PlayFab 帳戶。
* [LinkSteamAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linksteamaccount?) 將與所提供之 Steam 驗證票證相關聯的 Steam 帳戶連結至使用者的 PlayFab 帳戶。
* [LinkTwitch](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linktwitch?) 將與權杖相關聯的 Twitch 帳戶連結至使用者的 PlayFab 帳戶。
* [LinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkxboxaccount?) 將與所提供之存取碼相關聯的 XBOX Live 帳戶連結至使用者的 PlayFab 帳戶。
* [OpenTrade](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/trading/opentrade?) 開啟新的未完成交易。請注意，一個指定的物品執行個體一次只能位於一筆開放的交易中。
* [PurchaseItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/purchaseitem?) 使用虛擬貨幣購買單一物品。您必須同時指定用於購買的虛擬貨幣，以及用戶端認為的價格。這可讓伺服器在價格已變更時讓購買失敗。
* [PayForPurchase](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/payforpurchase?) 為透過 StartPurchase 建立的採購訂單選取付款選項
* [RegisterForIOSPushNotification](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/registerforiospushnotification?) 註冊 iOS 裝置以接收推播通知
* [RegisterPlayFabUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/registerplayfabuser?) 註冊新的 PlayFab 使用者帳戶，傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。您必須提供使用者名稱或電子郵件地址。
* [RemoveContactEmail](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/removecontactemail?) 從玩家的設定檔移除連絡電子郵件。
* [RemoveFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/friend-list-management/removefriend?) 從本機使用者的好友清單中移除指定的使用者。
* [RemoveGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/removegenericid?) 從玩家的 PlayFab 帳戶移除指定的一般服務識別碼。
* [RemoveSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/shared-group-data/removesharedgroupmembers?) 將使用者從能夠更新共用資料以及群組中使用者集合的使用者集合中移除。只有群組中的使用者可以移除成員。如果呼叫後沒有任何使用者保有存取權，群組及其相關資料將被刪除。共用群組是為極少數玩家之間共用資料而設計的，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [ReportAdActivity](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/advertising/reportadactivity?) 回報玩家的廣告活動
* [ReportDeviceInfo](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/analytics/reportdeviceinfo?) 撰寫 PlayStream 事件來描述所提供的玩家裝置資訊。此 API 方法並非設計供開發人員直接呼叫。每個 PlayFab 用戶端 SDK 最終都會自動回報此資訊。
* [ReportPlayer](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/reportplayer?) 提交另一位玩家的檢舉 (由於不良行為等)，讓遊戲的客戶服務代表可以對潛在的有害玩家採取行動。
* [RestoreIOSPurchases](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/restoreiospurchases?) 根據指定的還原收據還原所有應用程式內購買
* [SetFriendTags](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/friend-list-management/setfriendtags?) 更新本機使用者好友清單中指定使用者的標籤清單。
* [SubtractUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/subtractuservirtualcurrency?) 將使用者指定虛擬貨幣的餘額遞減所述的數量。使用此 API 可以讓 VC 餘額變成負數。
* [UnlinkAndroidDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkandroiddeviceid?) 從使用者的 PlayFab 帳戶取消連結相關的 Android 裝置識別碼。
* [UnlinkCustomID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkcustomid?) 從使用者的 PlayFab 帳戶取消連結相關的自訂識別碼。
* [UnlinkFacebookAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkfacebookaccount?) 從使用者的 PlayFab 帳戶取消連結相關的 Facebook 帳戶。
* [UnlinkFacebookInstantGamesId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkfacebookinstantgamesid?) 從使用者的 PlayFab 帳戶取消連結相關的 Facebook Instant Game 識別碼。
* [UnlinkGameCenterAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkgoogleaccount?) 從使用者的 PlayFab 帳戶取消連結相關的 Game Center 帳戶。
* [UnlinkGoogleAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkiosdeviceid?) 從使用者的 PlayFab 帳戶取消連結相關的 Google 帳戶 ([https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods](https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods))。
* [UnlinkIOSDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkiosdeviceid?) 從使用者的 PlayFab 帳戶取消連結相關的 iOS 裝置識別碼。
* [UnlinkKongregate](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkkongregate?) 從使用者的 PlayFab 帳戶取消連結相關的 Kongregate 識別碼。
* [UnlinkNintendoSwitchDeviceId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinknintendoswitchdeviceid?) 從使用者的 PlayFab 帳戶取消連結相關的 NintendoSwitchDeviceId。
* [UnlinkOpenIdConnect](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkopenidconnect?) 根據遊戲與 Open ID Connect 提供者之間現有關係的連線識別碼，從使用者的 PlayFab 帳戶取消連結 OpenID Connect 帳戶。
* [UnlinkPSNAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkpsnaccount?) 從使用者的 PlayFab 帳戶取消連結相關的 PSN™ 帳戶。
* [UnlinkSteamAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinksteamaccount?) 從使用者的 PlayFab 帳戶取消連結相關的 Steam 帳戶。
* [UnlinkTwitch](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinktwitch?) 從使用者的 PlayFab 帳戶取消連結相關的 Twitch 帳戶。
* [UnlinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkxboxaccount?) 從使用者的 PlayFab 帳戶取消連結相關的 XBOX Live 帳戶。
* [UnlockContainerInstance](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/unlockcontainerinstance?) 以指定的鑰匙 (需要時) 開啟指定的容器，並傳回已開啟容器的內容。如果容器 (以及相關時的鑰匙) 是可消耗的 (RemainingUses > 0)，其 RemainingUses 將會遞減，與 ConsumeItem 的作業一致。
* [UnlockContainerItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/unlockcontaineritem?) 在目標物品欄中搜尋符合指定 CatalogItemId 的 ItemInstance，必要時使用適當的鑰匙解鎖它，並傳回已開啟容器的內容。如果容器 (以及相關時的鑰匙) 是可消耗的 (RemainingUses > 0)，其 RemainingUses 將會遞減，與 ConsumeItem 的作業一致。
* [UpdateAvatarUrl](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/updateavatarurl?) 更新玩家的虛擬人偶 URL。
* [UpdateCharacterData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/character-data/updatecharacterdata?) 建立和更新使用者角色的遊戲特定自訂資料，用戶端可讀取和寫入此資料
* [UpdateCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/updatecharacterstatistics?) 更新特定角色之指定遊戲特定統計資料的值。根據預設，不允許用戶端更新統計資料。開發人員可以在 Game Manager > Settings > API Features 中覆寫此設定。
* [UpdatePlayerStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/updateplayerstatistics?) 更新使用者之指定遊戲特定統計資料的值。根據預設，不允許用戶端更新統計資料。開發人員可以在 Game Manager > Settings > API Features 中覆寫此設定。
* [UpdateSharedGroupData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/shared-group-data/updatesharedgroupdata?) 新增、更新和移除共用群組物件的資料索引鍵。如果權限設定為 Public，則在此呼叫中更新或新增的所有欄位都可供不在群組中的使用者讀取。根據預設，資料權限設定為 Private。無論權限設定為何，只有群組成員可以更新資料。共用群組是為極少數玩家之間共用資料而設計的，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [UpdateUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/updateuserdata?) 建立和更新使用者的遊戲特定自訂資料，用戶端可讀取和寫入此資料。
* [UpdateUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/updateuserpublisherdata?) 建立和更新使用者的發行者特定自訂資料，用戶端可讀取和寫入此資料。
* [UpdateUserTitleDisplayName](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/updateusertitledisplayname?) 更新使用者的遊戲特定顯示名稱

"PlayStation" 是 Sony Interactive Entertainment Inc. 的註冊商標或商標。

"PSN" 是 Sony Interactive Entertainment Inc. 的註冊商標或商標。

## Data API

* [SetObjects](https://learn.microsoft.com/en-us/rest/api/services/playfab/data/object/setobjects?) 在實體的設定檔上設定物件。

## Groups API

* [AcceptGroupApplication](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/acceptgroupapplication?) 接受加入群組的未處理邀請
* [AcceptGroupInvitation](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/acceptgroupinvitation?) 接受加入群組的邀請。
* [AddMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/addmembers?) 將成員新增至群組或角色。
* [ApplyToGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/applytogroup?) 申請加入群組。
* [BlockEntity](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/blockentity?) 封鎖實體清單，使其無法加入群組。
* [ChangeMemberRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/changememberrole?) 將實體清單的角色成員資格從一個角色變更為另一個角色。
* [CreateGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/creategroup?) 建立新的群組。
* [CreateRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/createrole?) 建立新的群組角色。
* [DeleteGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/deletegroup?) 刪除群組及其相關的所有角色、邀請、加入要求和封鎖。
* [DeleteRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/deleterole?) 刪除群組中的現有角色。
* [InviteToGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/invitetogroup?) 邀請玩家加入群組，
* [RemoveGroupApplication](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/removegroupapplication?) 移除加入群組的申請。
* [RemoveGroupInvitation](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/removegroupinvitation?) 移除加入群組的邀請。
* [RemoveMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/removemembers?) 從群組移除成員。
* [UnblockEntity](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/unblockentity?) 解除封鎖實體清單，使其可以加入群組。
* [UpdateGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/updategroup?) 更新群組的非成員資格資料。
* [UpdateRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/updaterole?) 更新角色的中繼資料。

## Profile API

* [SetGlobalPolicy](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/setglobalpolicy?) 設定全域遊戲存取原則。
* [SetProfileLanguage](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/setprofilelanguage?) 更新實體的語言。與玩家溝通的優先順序階層為遊戲玩家帳戶語言、主要玩家帳戶語言，如果前兩者未設定或不受支援，則為遊戲預設語言。
* [SetProfilePolicy](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/setprofilepolicy?) 設定設定檔存取原則。

## Server API

* [AddCharacterVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/addcharactervirtualcurrency?) 將角色指定虛擬貨幣的餘額遞增所述的數量。
* [AddFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/friend-list-management/addfriend?) 將好友使用者新增至具有 PlayFabId 之使用者的好友清單。FriendPlayFabId、FriendUsername、FriendEmail 或 FriendTitleDisplayName 中至少應初始化一個。
* [AddGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/addgenericid?) 將指定的一般服務識別碼新增至玩家的 PlayFab 帳戶。此功能的設計目的是允許針對遊戲想要新增的任意服務識別碼查詢 PlayFab 識別碼。此識別碼永遠不應作為驗證認證使用，因為其目的是讓其他玩家能輕鬆存取。
* [AddPlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/playstream/addplayertag?) 將指定的標籤新增至玩家設定檔。標籤的命名空間會根據標籤的來源自動產生。
* [AddSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/addsharedgroupmembers?) 將使用者新增至能夠更新共用資料以及群組中使用者集合的使用者集合。只有群組中的使用者 (和伺服器) 可以新增成員。共用群組是為極少數玩家之間共用資料而設計的，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [AddUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/adduservirtualcurrency?) 將使用者指定虛擬貨幣的餘額遞增所述的數量。
* [AwardSteamAchievement](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/platform-specific-methods/awardsteamachievement?) 將指定的 Steam 成就頒發給指定的使用者。
* [BanUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/banusers?) 針對所提供的遊戲，依 PlayFab 識別碼 (可選擇搭配 IP 位址) 禁止使用者。
* [ConsumeItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/consumeitem?) 消耗可消耗物品的使用次數。當所有使用次數都消耗完畢時，它將從玩家的物品欄中移除。
* [CreateSharedGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/createsharedgroup?) 要求建立共用群組物件，其中包含群組所有成員都可以更新的索引鍵/值組。由伺服器建立時，群組一開始不會有任何成員。共用群組是為極少數玩家之間共用資料而設計的，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [DeleteCharacterFromUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/deletecharacterfromuser?) 從指定使用者刪除特定的角色識別碼。
* [DeleteSharedGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/deletesharedgroup?) 刪除共用群組，釋出共用群組識別碼以供新群組重複使用。共用群組是為極少數玩家之間共用資料而設計的，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [GrantCharacterToUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/grantcharactertouser?) 將指定的角色類型授與使用者。CharacterId 並非全域唯一；必須將 characterId 與上層 PlayFabId 一起評估，才能保證唯一性。
* [GrantItemsToCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/grantitemstocharacter?) 將指定的物品新增至指定角色的物品欄。
* [GrantItemsToUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/grantitemstouser?) 將指定的物品新增至指定使用者的物品欄。
* [GrantItemsToUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/grantitemstousers?) 將指定的物品新增至指定的使用者物品欄，
* [LinkServerCustomId](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/linkservercustomid?) 將遊戲產生的自訂伺服器識別碼連結至使用者的 PlayFab 帳戶。
* [LinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/linkxboxaccount?) 將與所提供之存取碼相關聯的 XBOX Live 帳戶連結至使用者的 PlayFab 帳戶。
* [ModifyItemUses](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/modifyitemuses?) 修改玩家物品欄物品的剩餘使用次數。
* [MoveItemToCharacterFromCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/moveitemtocharacterfromcharacter?) 將物品從某個角色的物品欄移至該使用者另一個角色的物品欄。
* [MoveItemToCharacterFromUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/moveitemtocharacterfromuser?) 將物品從使用者的物品欄移至其角色的物品欄。
* [MoveItemToUserFromCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/moveitemtouserfromcharacter?) 將物品從角色的物品欄移至擁有該角色之使用者的物品欄。
* [RedeemCoupon](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/redeemcoupon?) 將與優惠券相關聯的虛擬商品新增至使用者的物品欄。可以透過 PlayFab Game Manager 中的 Economy->Catalogs 索引標籤產生優惠券。
* [RemoveFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/friend-list-management/removefriend?) 從使用者的好友清單中移除指定的好友。
* [RemoveGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/removegenericid?) 從玩家的 PlayFab 帳戶移除指定的一般服務識別碼。
* [RemovePlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/playstream/removeplayertag?) 從玩家設定檔移除指定的標籤。標籤的命名空間會根據標籤的來源自動產生。
* [RemoveSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/removesharedgroupmembers?) 將使用者從能夠更新共用資料以及群組中使用者集合的使用者集合中移除。只有群組中的使用者可以移除成員。如果呼叫後沒有任何使用者保有存取權，群組及其相關資料將被刪除。共用群組是為極少數玩家之間共用資料而設計的，請參閱[使用共用群組資料](/zh-TW/services/playfab/community/associations/groups/using-shared-group-data)。
* [RevokeAllBansForUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/revokeallbansforuser?) 撤銷使用者的所有作用中禁止。
* [RevokeBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/revokebans?) 撤銷以 BanId 指定的所有作用中禁止。
* [RevokeInventoryItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/revokeinventoryitem?) 撤銷使用者物品欄中物品的存取權。
* [RevokeInventoryItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/revokeinventoryitems?) 撤銷多位使用者和角色之間最多 25 個物品的存取權。
* [SetFriendTags](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/friend-list-management/setfriendtags?) 更新另一位使用者好友清單中指定使用者的標籤清單。
* [SetPlayerSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/authentication/setplayersecret?) 如果尚未設定玩家的秘密，則設定之。玩家秘密用於簽署 API 要求。若要重設玩家的秘密，請使用 Admin 或 Server API 方法 SetPlayerSecret。
* [SetPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/setpublisherdata?) 更新自訂發行者設定的索引鍵值存放區。
* [SetTitleData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/settitledata?) /rest/api/services/playfab/server/title-wide-data-management/setpublisherdata?
* [SetTitleInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/settitleinternaldata?) 更新自訂遊戲設定的索引鍵值存放區
* [SubtractCharacterVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/subtractcharactervirtualcurrency?) 將角色指定虛擬貨幣的餘額遞減所述的數量。使用此 API 可以讓 VC 餘額變成負數。
* [SubtractUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/subtractuservirtualcurrency?) 將使用者指定虛擬貨幣的餘額遞減所述的數量。使用此 API 可以讓 VC 餘額變成負數。
* [UnlinkServerCustomId](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/unlinkservercustomid?) 從使用者的 PlayFab 帳戶取消連結自訂伺服器識別碼。
* [UnlinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/unlinkxboxaccount?) 從使用者的 PlayFab 帳戶取消連結相關的 XBOX Live 帳戶。
* [UnlockContainerInstance](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/unlockcontainerinstance?) 以特定的鑰匙 (KeyItemInstanceId，需要時) 開啟特定的容器 (ContainerItemInstanceId)，並傳回已開啟容器的內容。如果容器 (以及相關時的鑰匙) 是可消耗的 (RemainingUses > 0)，其 RemainingUses 將會遞減，與 ConsumeItem 的作業一致。
* [UnlockContainerItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/unlockcontaineritem?) 在玩家或角色物品欄中搜尋任何符合指定 CatalogItemId 的 ItemInstance，必要時使用任何適當的鑰匙解鎖它，並傳回已開啟容器的內容。如果容器 (以及相關時的鑰匙) 是可消耗的 (RemainingUses > 0)，其 RemainingUses 將會遞減，與 ConsumeItem 的作業一致。
* [UpdateAvatarUrl](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/updateavatarurl?) 更新指定玩家的虛擬人偶 URL。
* [UpdateBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/updatebans?) 更新以 Ban Id 指定之現有禁止清單的資訊。
* [UpdateCharacterData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/updatecharacterdata?) 更新使用者角色的遊戲特定自訂資料，用戶端可讀取和寫入此資料。
* [UpdateCharacterInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/updatecharacterinternaldata?) 更新使用者角色的遊戲特定自訂資料，用戶端無法存取此資料。
* [UpdateCharacterReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/updatecharacterreadonlydata?) 更新使用者角色的遊戲特定自訂資料，用戶端只能讀取此資料。
* [UpdateCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/updatecharacterstatistics?) 更新特定角色之指定遊戲特定統計資料的值。
* [UpdatePlayerStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateplayerstatistics?) 更新使用者之指定遊戲特定統計資料的值。
* [UpdateUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserdata?) 更新使用者的遊戲特定自訂資料，用戶端可讀取和寫入此資料。
* [UpdateUserInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserinternaldata?) 更新使用者的遊戲特定自訂資料，用戶端無法存取此資料。
* [UpdateUserInventoryItemCustomData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/updateuserinventoryitemcustomdata?) 更新標記至指定物品的索引鍵值組資料，用戶端只能讀取此資料。
* [UpdateUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserpublisherdata?) 更新使用者的發行者特定自訂資料，用戶端可讀取和寫入此資料。
* [UpdateUserPublisherInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserpublisherinternaldata?) 更新使用者的發行者特定自訂資料，用戶端無法存取此資料。
* [UpdateUserPublisherReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserpublisherreadonlydata?) 更新使用者的發行者特定自訂資料，用戶端只能讀取此資料。
* [UpdateUserReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserreadonlydata?) 更新使用者的遊戲特定自訂資料，用戶端只能讀取此資料。


## Related topics

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