Admin API
- CheckLimitedEditionItemAvailability 檢查限量版物品的全域計數。
- GetAllSegments 擷取玩家區段定義的陣列。其結果可用於後續的 API 呼叫,例如需要區段識別碼的 GetPlayersInSegment。雖然區段名稱可以變更,但該區段的識別碼不會變更。
- ExportMasterPlayerData 匯出主要玩家帳戶的所有相關資料。
- GetCatalogItems 擷取遊戲虛擬商品目錄的指定版本,包括所有已定義的屬性。
- GetContentList 列出遊戲的所有內容並取得大小等統計資料。
- GetDataReport 擷取所要求報告的下載 URL。
- GetPlayerSegments 列出玩家在此時此刻所屬的所有區段。
- GetPlayerTags 從玩家設定檔取得具有指定命名空間 (選用) 的所有標籤。
- GetPolicy 取得所要求的原則。
- GetPublisherData 擷取自訂發行者設定的索引鍵值存放區。
- GetRandomResultTables 擷取遊戲的隨機掉落表設定。
- GetStoreItems 擷取為指定商店定義的物品集合,包括所有已定義的價格。
- GetTitleData 擷取用戶端可讀取之自訂遊戲設定的索引鍵值存放區。
- [GetUserAccountInfo](Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier) 根據與所提供之唯一識別碼的比對,擷取指定使用者的相關詳細資料。
- GetUserBans 取得使用者的所有禁止。
- GetUserData 擷取使用者的遊戲特定自訂資料,用戶端可讀取和寫入此資料。
- GetUserInternalData 擷取使用者的遊戲特定自訂資料,用戶端無法存取此資料。
- GetUserInventory 擷取指定使用者目前的虛擬商品物品欄
- GetUserPublisherData 擷取使用者的發行者特定自訂資料,用戶端可讀取和寫入此資料。
- GetUserPublisherInternalData 擷取使用者的發行者特定自訂資料,用戶端無法存取此資料。
- GetUserPublisherReadOnlyData 擷取使用者的發行者特定自訂資料,用戶端只能讀取此資料。
- GetUserReadOnlyData 擷取使用者的遊戲特定自訂資料,用戶端只能讀取此資料。
- ListVirtualCurrencyTypes 傳回遊戲所有已定義之虛擬貨幣的清單
- GetPlayerIdFromAuthToken 從驗證權杖取得玩家識別碼。
- GetPlayersInSegment 允許逐頁瀏覽指定區段中的所有玩家。此 API 會建立所有在建立時符合區段定義之玩家設定檔的快照,並在 Total Seconds to Live 期間存留,每次後續使用 Continuation Token 時都會重新整理其存留期。分頁期間變更的設定檔不會反映在結果中。此作業目前不支援 AB 測試區段。
- GetExperiments 取得遊戲所有實驗的詳細資料。
- GetLatestScorecard 取得遊戲實驗的最新計分卡。
- GetTreatmentAssignment 取得玩家在遊戲中每個執行中實驗的處理指派
Client API
- GetAllUsersCharacters 列出屬於特定使用者的所有角色。CharacterId 並非全域唯一;必須將 characterId 與上層 PlayFabId 一起評估,才能保證唯一性。
- GetCatalogItems 擷取遊戲虛擬商品目錄的指定版本,包括所有已定義的屬性。
- GetCharacterData 擷取角色的遊戲特定自訂資料,用戶端可讀取和寫入此資料。
- GetCharacterInventory 擷取指定角色目前的虛擬商品物品欄。
- GetCharacterLeaderboard 擷取指定統計資料的排名角色清單,從排行榜中指定的位置開始。
- GetCharacterReadOnlyData 擷取角色的遊戲特定自訂資料,用戶端只能讀取此資料。
- GetCharacterStatistics 擷取使用者所有遊戲特定統計資料的詳細資料。
- GetFriendLeaderboard 擷取目前玩家在指定統計資料上的排名好友清單,從排行榜中指定的位置開始。
- GetFriendLeaderboardAroundPlayer 擷取目前玩家在指定統計資料上的排名好友清單,以所要求的 PlayFab 使用者為中心。如果 PlayFabId 為空白或 null,則會傳回目前登入的使用者。
- GetFriendsList 擷取本機使用者目前的好友清單,僅限擁有 PlayFab 帳戶的使用者。也會包含來自連結帳戶 (Facebook、Steam) 的好友。您可以選擇性地排除某些連結服務的好友。
- GetLeaderboard 擷取指定統計資料的排名使用者清單,從排行榜中指定的位置開始。
- GetLeaderboardAroundCharacter 擷取指定統計資料的排名角色清單,以所要求的角色識別碼為中心。
- GetLeaderboardAroundPlayer 擷取指定統計資料的排名使用者清單,以所要求的玩家為中心。如果 PlayFabId 為空白或 null,則會傳回目前登入的使用者。
- GetLeaderboardForUserCharacters 擷取使用者所有角色在指定統計資料上的清單。
- GetPaymentToken 適用於提供者要求 PlayFab (履行者) 起始交易、但由用戶端完成其餘流程的付款流程。在 Xsolla 的案例中,用戶端會將此處傳回的權杖傳遞給 Xsolla 以建立購物車。完成付款後,請使用傳回的 OrderId 輪詢 GetPurchase。
- GetPlayerProfile 擷取玩家的設定檔。
- GetPlayerSegments 列出玩家在此時此刻所屬的所有區段。
- GetPlayerStatistics 擷取本機玩家的指定統計資料 (如果未指定任何統計資料,則為所有統計資料的目前版本和值)。
- GetPlayerStatisticVersions 擷取指定統計資料之可用版本的資訊。
- GetPlayerTags 從玩家設定檔取得具有指定命名空間 (選用) 的所有標籤。
- GetPlayerTrades 取得玩家開啟或接受的所有交易,可選擇依交易狀態篩選。
- GetPlayFabIDsFromFacebookIDs 擷取指定 Facebook 識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromFacebookInstantGamesIds 擷取指定 Facebook Instant Game 識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromGameCenterIDs 擷取指定 Game Center 識別碼集合 (在 Game Center 程式設計指南中稱為 Player Identifier) 的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromGenericIDs 擷取指定一般服務識別碼集合的唯一 PlayFab 識別碼。一般識別碼是服務名稱加上玩家的服務特定識別碼,由遊戲在將一般識別碼新增至玩家帳戶時指定。
- GetPlayFabIDsFromGoogleIDs 擷取指定 Google 識別碼集合的唯一 PlayFab 識別碼。Google 識別碼是使用者帳戶的識別碼,可在 Google+ People API 呼叫中以
id取得。 - GetPlayFabIDsFromKongregateIDs 擷取指定 Kongregate 識別碼集合的唯一 PlayFab 識別碼。Kongregate 識別碼是使用者帳戶的識別碼,可從 Kongregate API 方法以
user_id取得 (例如 https://docs.kongregate.com/docs/concepts-handling-guests)。 - GetPlayFabIDsFromNintendoSwitchDeviceIds 擷取指定 Nintendo Switch 識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromPSNAccountIDs 擷取指定 PlayStation™ Network 識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromSteamIDs 擷取指定 Steam 識別碼集合的唯一 PlayFab 識別碼。Steam 識別碼是使用者帳戶的設定檔識別碼,可在 Steamworks Community API 呼叫中以 SteamId 取得。
- GetPlayFabIDsFromTwitchIDs 擷取指定 Twitch 識別碼集合的唯一 PlayFab 識別碼。Twitch 識別碼是使用者帳戶的識別碼,可從 Twitch API 方法以 “_id” 取得 (例如:https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser)。
- GetPlayFabIDsFromXboxLiveIDs 擷取指定 XboxLive 識別碼集合的唯一 PlayFab 識別碼。
- GetPublisherData 擷取自訂發行者設定的索引鍵值存放區。
- GetPurchase 擷取購買及其目前的 PlayFab 狀態。傳回購買中仍為作用中的物品欄物品。
- GetSharedGroupData 擷取儲存在共用群組物件中的資料,以及群組成員清單。群組的非成員可以使用此項目擷取群組資料 (包括成員資格),但不會收到標示為私人之索引鍵的資料。共用群組是為少數玩家之間共用資料而設計的。如需詳細資訊,請參閱使用共用群組資料。
- GetStoreItems 擷取為指定商店定義的物品集合,包括所有已定義的價格。
- GetTitleData 擷取自訂遊戲設定的索引鍵值存放區
- GetAccountInfo 擷取使用者的 PlayFab 帳戶詳細資料。
- LoginWithAndroidDeviceID 使用 Android 裝置識別碼讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- LoginWithCustomID 使用遊戲產生的自訂唯一識別碼讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼
- LoginWithEmailAddress 讓使用者登入 PlayFab 帳戶,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。與大多數其他登入 API 呼叫不同,LoginWithEmailAddress 不允許透過 CreateAccountFlag 建立新帳戶。可以透過 RegisterPlayFabUser 使用電子郵件地址建立帳戶。
- LoginWithFacebook 使用 Facebook 存取權杖讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- LoginWithFacebookInstantGamesId 使用 Facebook Instant Games 識別碼讓使用者登入,傳回可用於需要已驗證使用者之 API 呼叫的工作階段識別碼。需要設定 Facebook Instant Games。
- LoginWithGameCenter 使用 iOS Game Center 玩家識別碼讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- LoginWithGoogleAccount 使用 iOS Game Center 玩家識別碼讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- LoginWithIOSDeviceID 使用使用者的 Google 帳戶認證讓使用者登入。
- LoginWithKongregate 使用 Kongregate 玩家帳戶讓使用者登入。
- LoginWithNintendoSwitchDeviceId 使用 Nintendo Switch 裝置識別碼讓使用者登入,傳回可用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- LoginWithOpenIdConnect 使用由遊戲與 Open ID Connect 提供者之間現有關係所建立的 Open ID Connect JWT 讓使用者登入。
- LoginWithPlayFab 需要已驗證的使用者。與大多數其他登入 API 呼叫不同,
LoginWithPlayFab不允許透過CreateAccountFlag建立新帳戶。使用者名稱/密碼認證可用於透過RegisterPlayFabUser建立帳戶,或使用AddUsernamePassword新增至現有帳戶。 - LoginWithPSN 讓使用者登入 PlayFab 帳戶,傳回可用於需要已驗證使用者之 API 呼叫的工作階段識別碼。與大多數其他登入 API 呼叫不同,
LoginWithPlayFab不允許透過CreateAccountFlag建立新帳戶。使用者名稱/密碼認證用於透過RegisterPlayFabUser建立帳戶,或使用AddUsernamePassword新增至現有帳戶。 - LoginWithSteam 使用 Steam 驗證票證讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- LoginWithTwitch 使用 Twitch 存取權杖讓使用者登入。
- LoginWithXbox 使用 XBOX Live 權杖讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- GetPlayerCombinedInfo 擷取使用者所有不同類型的資訊。
Data API
- GetObjects 從實體的設定檔擷取物件。
Groups API
- GetGroup 取得群組及其角色的相關資訊。
- IsMember 檢查實體是否為群組或群組內角色的成員。
- ListGroupApplications 列出所有尚未處理的加入群組要求。
- ListGroupBlocks 列出所有被封鎖而無法加入群組的實體。
- ListGroupInvitations 列出群組所有尚未處理的邀請。
- ListGroupMembers 列出群組的所有成員。
- ListMembership 列出實體的所有群組和角色。
- ListMembershipOpportunities 列出實體所有尚未處理的邀請和群組申請。
Profile API
- GetGlobalPolicy 取得全域遊戲存取原則。
- GetProfile 擷取實體的設定檔。
- GetProfiles 擷取實體的設定檔。
- GetTitlePlayersFromMasterPlayerAccountIds 擷取與指定主要玩家帳戶相關聯的遊戲玩家帳戶。
Server API
- EvaluateRandomResultTable 傳回隨機結果表的評估結果——如果透過套組或呼叫 UnlockContainer 新增隨機結果表,則會新增至玩家物品欄之遊戲目錄中的
ItemId。 - GetAllSegments 擷取玩家區段定義的陣列。其結果可用於後續的 API 呼叫,例如需要區段識別碼的 GetPlayersInSegment。雖然區段名稱可以變更,但該區段的識別碼不會變更。
- GetAllUsersCharacters 列出屬於特定使用者的所有角色。CharacterId 並非全域唯一;必須將 characterId 與上層 PlayFabId 一起評估,才能保證唯一性。
- GetCatalogItems 擷取遊戲虛擬商品目錄的指定版本,包括所有已定義的屬性。
- GetCharacterData 擷取使用者的遊戲特定自訂資料,用戶端可讀取和寫入此資料。
- GetCharacterInternalData 擷取使用者角色的遊戲特定自訂資料,用戶端無法存取此資料。
- GetCharacterInventory 擷取指定角色目前的虛擬商品物品欄。
- GetCharacterReadOnlyData
- GetCharacterStatistics 擷取特定角色所有遊戲特定統計資料的詳細資料。
- GetFriendLeaderboard 擷取指定玩家在指定統計資料上的排名好友清單,從排行榜中指定的位置開始。
- GetFriendsList 擷取具有
PlayFabId之使用者目前的好友,僅限擁有 PlayFab 帳戶的使用者。也會包含來自連結帳戶 (Facebook、Steam) 的好友。您可以選擇性地排除某些連結服務的好友。 - GetLeaderboard 擷取指定統計資料的排名使用者清單,從排行榜中指定的位置開始。
- GetLeaderboardAroundCharacter 擷取指定統計資料的排名角色清單,以所要求的使用者為中心。
- GetLeaderboardAroundUser 擷取指定統計資料的排名角色清單,以所要求的使用者為中心。
- GetLeaderboardForUserCharacters 擷取使用者所有角色在指定統計資料上的清單。
- GetPlayerCombinedInfo 傳回回應中為使用者要求的任何資訊。請注意,可能會傳回電子郵件地址、Facebook 識別碼等個人資料。所有參數預設為 false。
- GetPlayerProfile 擷取玩家的設定檔。
- GetPlayerSegments 列出玩家在此時此刻所屬的所有區段。
- GetPlayersInSegment 允許逐頁瀏覽指定區段中的所有玩家。此 API 會建立所有在建立時符合區段定義之玩家設定檔的快照,並在 Total Seconds to Live 期間存留,每次後續使用 Continuation Token 時都會重新整理其存留期。分頁期間變更的設定檔不會反映在結果中。此作業目前不支援 AB 測試區段。
- GetPlayerStatistics 擷取本機玩家之指定統計資料的目前版本和值。
- GetPlayerStatisticVersions 擷取指定統計資料之可用版本的資訊。
- GetPlayerTags 從玩家設定檔取得具有指定命名空間 (選用) 的所有標籤。
- GetPlayFabIDsFromFacebookIDs 擷取指定 Facebook 識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromFacebookInstantGamesIds 擷取指定 Facebook 識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromGenericIDs 擷取指定一般服務識別碼集合的唯一 PlayFab 識別碼。一般識別碼是服務名稱加上玩家的服務特定識別碼,由遊戲在將一般識別碼新增至玩家帳戶時指定。
- GetPlayFabIDsFromNintendoSwitchDeviceIds 擷取指定 Nintendo Switch 裝置識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromPSNAccountIDs 擷取指定 PlayStation Network 識別碼集合的唯一 PlayFab 識別碼。
- GetPlayFabIDsFromSteamIDs 擷取指定 Steam 識別碼集合的唯一 PlayFab 識別碼。Steam 識別碼是使用者帳戶的設定檔識別碼,可在 Steamworks Community API 呼叫中以 SteamId 取得。
- GetPlayFabIDsFromXboxLiveIDs 擷取指定 XboxLive 識別碼集合的唯一 PlayFab 識別碼。
- GetPublisherData 擷取自訂發行者設定的索引鍵值存放區。
- GetRandomResultTables 擷取遊戲指定隨機結果表的設定資訊,包括所有 ItemId 值和權重。
- GetServerCustomIDsFromPlayFabIDs 擷取指定伺服器自訂識別碼集合的相關聯 PlayFab 帳戶識別碼。
- GetSharedGroupData 擷取儲存在共用群組物件中的資料,以及群組成員清單。伺服器可以存取所有公用和私人群組資料。共用群組是為少數玩家之間共用資料而設計的。如需詳細資訊,請參閱使用共用群組資料。
- GetStoreItems 擷取為指定玩家之指定商店定義的物品集合,包括所有已定義的價格。
- GetTitleData 擷取自訂遊戲設定的索引鍵值存放區。
- GetTitleInternalData 擷取自訂內部遊戲設定的索引鍵值存放區。
- GetUserAccountInfo 擷取指定使用者的相關詳細資料。
- GetUserBans 取得使用者的所有禁止。
- GetUserData 擷取使用者的遊戲特定自訂資料,用戶端可讀取和寫入此資料。
- GetUserInternalData 擷取使用者的遊戲特定自訂資料,用戶端無法存取此資料。
- GetUserInventory 擷取指定使用者目前的虛擬商品物品欄。
- GetUserPublisherData 擷取使用者的發行者特定自訂資料,用戶端可讀取和寫入此資料。
- GetUserPublisherInternalData 擷取使用者的發行者特定自訂資料,用戶端無法存取此資料。
- GetUserPublisherReadOnlyData
- GetUserReadOnlyData 更新使用者的遊戲特定自訂資料,用戶端只能讀取此資料。
- LoginWithServerCustomId 使用玩家的自訂識別碼,從外部伺服器後端安全地登入遊戲用戶端。伺服器自訂識別碼和用戶端自訂識別碼互斥,無法用來擷取相同的玩家帳戶。
- LoginWithXbox 從外部伺服器後端使用 XBOX Live 權杖讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
- LoginWithXboxId 使用 XBOX 識別碼和沙箱識別碼讓使用者登入,傳回可在之後用於需要已驗證使用者之 API 呼叫的工作階段識別碼。
