服務 C API 概觀 - PFAuthenticationTypes.h - XBOX Game Development Documentation

結構

結構	說明
PFAuthenticationLoginWithXUserRequest	PFAuthenticationLoginWithXUserRequest 資料模型。如果這是使用者第一次使用 XBOX Live 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 XBOX Live 帳戶。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 XBOX Live 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。PFAuthenticationLoginWithXUserAsync 的要求物件。
PFAuthenticationAuthenticateCustomIdRequest	PFAuthenticationAuthenticateCustomIdRequest 資料模型。建立或傳回 game_server 實體權杖。呼叫者必須是 title 實體。
PFAuthenticationAuthenticateCustomIdResult	PFAuthenticationAuthenticateCustomIdResult 資料模型。
PFAuthenticationDeleteRequest	PFAuthenticationDeleteRequest 資料模型。刪除 game_server 實體。呼叫者可以是嘗試刪除自身的 game_server 實體，或是嘗試刪除此 title 之 game_server 實體的 title 實體。
PFAuthenticationEntityTokenResponse	PFAuthenticationEntityTokenResponse 資料模型。
PFAuthenticationGetEntityRequest	PFAuthenticationGetEntityRequest 資料模型。呼叫此 API 時必須使用 X-SecretKey、X-Authentication 或 X-EntityToken 標頭。標頭必須仍然有效，且不得已過期或已撤銷。如果成功，將會發出新的實體權杖，並發出 “entity_logged_in” PlayStream 事件。
PFAuthenticationLoginResult	PFAuthenticationLoginResult 資料模型。
PFAuthenticationLoginWithAppleRequest	PFAuthenticationLoginWithAppleRequest 資料模型。
PFAuthenticationLoginWithBattleNetRequest	PFAuthenticationLoginWithBattleNetRequest 資料模型。
PFAuthenticationLoginWithCustomIDRequest	PFAuthenticationLoginWithCustomIDRequest 資料模型。強烈建議開發人員確保客戶極不可能產生已被其他客戶使用的識別碼。如果這是使用者第一次使用自訂識別碼登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至自訂識別碼。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至自訂識別碼，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationLoginWithFacebookRequest	PFAuthenticationLoginWithFacebookRequest 資料模型。Facebook 登入是使用 Facebook 使用者存取權杖來完成。如需權杖的詳細資訊，請參閱 Facebook 開發人員文件 (https://developers.facebook.com/docs/facebook-login/access-tokens/). 例如，在 Unity 中，權杖可透過 Facebook SDK ScriptableObject FB 中的 AccessToken 取得。如果這是使用者第一次使用 Facebook 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至所提供帳戶的 Facebook ID。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 Facebook 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。請注意，遊戲絕對不應在不同的 PlayFab Title ID 之間重複使用相同的 Facebook 應用程式，因為 Facebook 會為每個應用程式提供唯一的使用者識別碼，這麼做可能會導致使用者 PlayFab 帳戶資訊中的 Facebook ID 發生問題。如果您必須在新的 PlayFab Title ID 中重複使用應用程式，請務必先將所有帳戶與 Facebook 取消連結，或刪除第一個 Title ID 中的所有使用者。注意：如果使用者是使用 AuthenticationToken 而非 AccessToken 進行驗證，GetFriendsList API 將會傳回空白清單。
PFAuthenticationLoginWithGameCenterRequest	PFAuthenticationLoginWithGameCenterRequest 資料模型。Game Center 玩家識別碼 (https://developer.apple.com/library/ios/documentation/Accounts/Reference/ACAccountClassRef/index.html# // apple_ref/occ/instp/ACAccount/identifier) 是儲存在本機裝置上的產生字串。與裝置識別碼一樣，必須小心絕不向終端使用者公開玩家的 Game Center 識別碼，因為這可能導致使用者的帳戶遭到入侵。如果這是使用者第一次使用 Game Center 登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 Game Center 識別碼。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 Game Center 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。如果使用無效的 iOS Game Center 玩家識別碼，將會傳回指出此情況的錯誤。
PFAuthenticationLoginWithGoogleAccountRequest	PFAuthenticationLoginWithGoogleAccountRequest 資料模型。Google 登入的完成方式是在裝置上使用 Google sign-in for Android API 取得 Google OAuth 2.0 認證，並將其傳遞給此 API。如果這是使用者第一次使用 Google 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 Google 帳戶。否則，如果沒有任何 PlayFab 帳戶連結至 Google 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。目前 (建議) 在 Android 應用程式中取得 Google 帳戶認證的方法，是呼叫 GoogleSignInAccount.getServerAuthCode()，並將驗證碼作為此 API 的 ServerAuthCode 參數傳送。在執行此動作之前，您必須在 Google API Console 中建立 OAuth 2.0 Web 應用程式用戶端識別碼，並在您遊戲的 PlayFab Game Manager Google 附加元件中設定其用戶端識別碼和密碼。此方法不需要提示使用者授與額外的 Google 帳戶權限，因此能提供最順暢的使用者體驗。如需取得伺服器驗證碼的詳細資訊，請參閱 https://developers.google.com/identity/sign-in/android/offline-access. 先前 (已淘汰) 的方法是在用戶端呼叫 GetAccessToken() 取得 OAuth 存取權杖，並將其作為 AccessToken 參數傳遞給此 API。使用 Google OAuth 2.0 存取權杖。如需此變更的詳細資訊，請參閱 Google 開發人員文件 (https://android-developers.googleblog.com/2016/01/play-games-permissions-are-changing-in.html).
PFAuthenticationLoginWithGooglePlayGamesServicesRequest	PFAuthenticationLoginWithGooglePlayGamesServicesRequest 資料模型。Google Play Games 登入的完成方式是在裝置上使用 Google Play Games sign-in for Android API 取得 Google OAuth 2.0 認證，並將其傳遞給此 API。如果這是使用者第一次使用 Google Play Games 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 Google Play Games 帳戶。否則，如果沒有任何 PlayFab 帳戶連結至 Google Play Games 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。目前 (建議) 在 Android 應用程式中取得 Google Play Games 帳戶認證的方法，是呼叫 GamesSignInClient.requestServerSideAccess()，並將驗證碼作為此 API 的 ServerAuthCode 參數傳送。在執行此動作之前，您必須在 Google API Console 中建立 OAuth 2.0 Web 應用程式用戶端識別碼，並在您遊戲的 PlayFab Game Manager Google 附加元件中設定其用戶端識別碼和密碼。此方法不需要提示使用者授與額外的 Google 帳戶權限，因此能提供最順暢的使用者體驗。如需取得伺服器驗證碼的詳細資訊，請參閱 https://developers.google.com/games/services/android/signin.
PFAuthenticationLoginWithNintendoServiceAccountRequest	PFAuthenticationLoginWithNintendoServiceAccountRequest 資料模型。
PFAuthenticationLoginWithOpenIdConnectRequest	PFAuthenticationLoginWithOpenIdConnectRequest 資料模型。
PFAuthenticationLoginWithPSNRequest	PFAuthenticationLoginWithPSNRequest 資料模型。如果這是使用者第一次使用 PlayStation :tm: Network 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 PlayStation :tm: Network 帳戶。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 PlayStation :tm: Network 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationLoginWithServerCustomIdRequest	PFAuthenticationLoginWithServerCustomIdRequest 資料模型。
PFAuthenticationLoginWithSteamIdRequest	PFAuthenticationLoginWithSteamIdRequest 資料模型。如果這是使用者第一次使用 Steam ID 登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 Steam 帳戶。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 Steam 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。未登入 Steam 用戶端應用程式的 Steam 使用者只會同步其 Steam 使用者名稱，其他資料 (例如貨幣和國家/地區) 要等到他們在用戶端開啟時登入後才可使用。
PFAuthenticationLoginWithSteamRequest	PFAuthenticationLoginWithSteamRequest 資料模型。Steam 登入是使用 Steam 工作階段票證來完成。如需票證的詳細資訊，請參閱 Steamworks SDK：https://partner.steamgames.com/documentation/auth. 注意：若要讓 Steam 驗證正常運作，必須在 PlayFab Game Manager 中 (於附加元件市集的 Steam 下) 為遊戲設定 Steam 應用程式識別碼和 Web API 金鑰。您可以從 Steamworks 網站中與您的 App ID 相關聯之任何群組的 [權限] 頁面取得 Web API 金鑰。如果這是使用者第一次使用 Steam 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至所提供帳戶的 Steam ID。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 Steam 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationLoginWithXboxIdRequest	PFAuthenticationLoginWithXboxIdRequest 資料模型。如果這是使用者第一次使用 XBOX ID 登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 XBOX Live 帳戶。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 XBOX Live 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationLoginWithXboxRequest	PFAuthenticationLoginWithXboxRequest 資料模型。如果這是使用者第一次使用 XBOX Live 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 XBOX Live 帳戶。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 XBOX Live 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationServerLoginWithAndroidDeviceIDRequest	PFAuthenticationServerLoginWithAndroidDeviceIDRequest 資料模型。在 Android 裝置上，建議使用 Settings.Secure.ANDROID_ID 作為 AndroidDeviceId，如這篇部落格文章所述 (http://android-developers.blogspot.com/2011/03/identifying-app-installations.html). 如需此識別碼的詳細資訊，請參閱 Android 文件 (http://developer.android.com/reference/android/provider/Settings.Secure.html). 如果這是使用者第一次使用 Android 裝置登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 Android 裝置識別碼。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 Android 裝置，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。請注意，雖然可以將多個此類型的裝置連結至單一使用者帳戶，但只有最近一次用來登入 (或最近一次連結) 的裝置會反映在使用者的帳戶資訊中。我們將在未來的版本中更新為顯示所有已連結的裝置。
PFAuthenticationServerLoginWithBattleNetRequest	PFAuthenticationServerLoginWithBattleNetRequest 資料模型。
PFAuthenticationServerLoginWithCustomIDRequest	PFAuthenticationServerLoginWithCustomIDRequest 資料模型。強烈建議開發人員確保客戶極不可能產生已被其他客戶使用的識別碼。如果這是使用者第一次使用自訂識別碼登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至自訂識別碼。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至自訂識別碼，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationServerLoginWithIOSDeviceIDRequest	PFAuthenticationServerLoginWithIOSDeviceIDRequest 資料模型。在 iOS 裝置上，必須使用 identifierForVendor (https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/index.html# // apple_ref/occ/instp/UIDevice/identifierForVendor) 作為 DeviceId，因為 UIDevice uniqueIdentifier 自 iOS 5 起已淘汰，而將 advertisingIdentifier 用於此用途會導致無法通過 Apple 的認證程序。如果這是使用者第一次使用 iOS 裝置登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至廠商專屬的 iOS 裝置識別碼。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 iOS 裝置，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationServerLoginWithPSNRequest	PFAuthenticationServerLoginWithPSNRequest 資料模型。如果這是使用者第一次使用 PlayStation :tm: Network 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 PlayStation :tm: Network 帳戶。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 PlayStation :tm: Network 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationServerLoginWithXboxRequest	PFAuthenticationServerLoginWithXboxRequest 資料模型。如果這是使用者第一次使用 XBOX Live 帳戶登入，且 CreateAccount 設定為 true，系統將會建立新的 PlayFab 帳戶，並將其連結至 XBOX Live 帳戶。在此情況下，不會有任何電子郵件或使用者名稱與該 PlayFab 帳戶相關聯。否則，如果沒有任何 PlayFab 帳戶連結至 XBOX Live 帳戶，將會傳回指出此情況的錯誤，讓遊戲可以引導使用者建立 PlayFab 帳戶。
PFAuthenticationUserSettings	PFAuthenticationUserSettings 資料模型。
PFAuthenticationValidateEntityTokenRequest	PFAuthenticationValidateEntityTokenRequest 資料模型。根據指定的實體權杖，驗證其未過期或未遭撤銷，並傳回擁有者的詳細資料。
PFAuthenticationValidateEntityTokenResponse	PFAuthenticationValidateEntityTokenResponse 資料模型。

狀態變更

狀態變更	說明

列舉

列舉	說明
PFAuthenticationIdentifiedDeviceType	IdentifiedDeviceType 列舉。

最後修改於 2026年10月6日

相關主題

PFAuthenticationIdentifiedDeviceType PFAuthenticationLoginResult PFAuthenticationUserSettings PFAuthenticationDeleteRequest PFAuthenticationLoginWithPSNRequest

⌘I