服务 C API 概述 - PFAuthenticationTypes.h

结构

结构 说明
PFAuthenticationAuthenticateCustomIdRequest PFAuthenticationAuthenticateCustomIdRequest 数据模型。 创建或返回 game_server 实体令牌。 调用方必须是游戏实体。
PFAuthenticationAuthenticateCustomIdResult PFAuthenticationAuthenticateCustomIdResult 数据模型。
PFAuthenticationDeleteRequest PFAuthenticationDeleteRequest 数据模型。 删除 game_server 实体。 调用方可以是尝试删除其自身的 game_server 实体。 或者是尝试删除此游戏的 game_server 实体的游戏实体。
PFAuthenticationEntityTokenResponse PFAuthenticationEntityTokenResponse 数据模型。
PFAuthenticationGetEntityRequest PFAuthenticationGetEntityRequest 数据模型。 必须使用 X-SecretKey、X-Authentication 或 X-EntityToken 标头调用此 API。 可以包含可选的 EntityKey 来尝试将生成的 EntityToken 设置为特定实体,但该实体必须是调用方的关系,例如角色的 master_player_account。 如果发送 X-EntityToken,帐户将标记为新登录,并将颁发新令牌。 如果使用 X-Authentication 或 X-EntityToken,标头必须仍然有效,并且不能过期或已吊销。
PFAuthenticationLoginResult PFAuthenticationLoginResult 数据模型。
PFAuthenticationLoginWithAppleRequest PFAuthenticationLoginWithAppleRequest 数据模型。
PFAuthenticationLoginWithCustomIDRequest PFAuthenticationLoginWithCustomIDRequest 数据模型。 强烈建议开发人员确保客户极不可能生成已由其他客户使用的 ID。 如果这是用户首次使用自定义 ID 登录,并且 CreateAccount 设置为 true,则将创建新的 PlayFab 帐户并将其链接到自定义 ID。 在这种情况下,不会将任何电子邮件或用户名与 PlayFab 帐户关联。 否则,如果没有 PlayFab 帐户链接到自定义 ID,则会返回一个错误,指示将返回此帐户,以便游戏可以指导用户完成 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 游戏 ID 之间重复使用相同的 Facebook 应用程序,因为 Facebook 为每个应用程序提供唯一的用户 ID,这样做可能会导致用户在 PlayFab 帐户信息中的 Facebook ID 出现问题。 如果必须在新的 PlayFab 游戏 ID 中重复使用应用程序,请确保首先取消所有帐户与 Facebook 的链接,或删除第一个游戏 ID 中的所有用户。
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 登录是通过使用设备上 Android API 的 Google 登录获取 Google OAuth 2.0 凭据并将其传递给此 API 来实现的。 如果这是用户首次使用 Google 帐户登录,并且 CreateAccount 设置为 true,则将创建新的 PlayFab 帐户并将其链接到 Google 帐户。 否则,如果没有 PlayFab 帐户链接到 Google 帐户,则会返回一个错误,指示将返回此帐户,以便游戏可以指导用户完成 PlayFab 帐户的创建。 在 Android 应用程序中获取 Google 帐户凭据的当前(推荐)方法是调用 GoogleSignInAccount.getServerAuthCode(),并将身份验证代码作为此 API 的 ServerAuthCode 参数发送。 执行此操作之前,必须在 Google API 控制台中创建 OAuth 2.0 Web 应用程序客户端 ID,并在 PlayFab Game Manager Google 加载项中为游戏配置其客户端 ID 和机密。 此方法不需要提示用户提供其他 Google 帐户权限,从而使得用户体验出现尽可能少的摩擦。 有关获取服务器身份验证代码的详细信息,请参阅 https://developers.google.com/identity/sign-in/android/offline-access。 上一个(已弃用)方法是在客户端上调用 GetAccessToken() 并将其作为 AccessToken 参数传递给此 API 来获取 OAuth 访问令牌。 使用 Google OAuth 2.0 访问令牌。 有关此更改的详细信息,请参阅 Google 开发人员文档 (https://android-developers.googleblog.com/2016/01/play-games-permissions-are-changing-in.html)。
PFAuthenticationLoginWithGooglePlayGamesServicesRequest PFAuthenticationLoginWithGooglePlayGamesServicesRequest 数据模型。 Google Play Games 登录是通过使用设备上 Android API 的 Google Play Games 登录获取 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 控制台中创建 OAuth 2.0 Web 应用程序客户端 ID,并在 PlayFab Game Manager Google 加载项中为游戏配置其客户端 ID 和机密。 此方法不需要提示用户提供其他 Google 帐户权限,从而使得用户体验出现尽可能少的摩擦。 有关获取服务器身份验证代码的详细信息,请参阅 https://developers.google.com/games/services/android/signin
PFAuthenticationLoginWithNintendoServiceAccountRequest PFAuthenticationLoginWithNintendoServiceAccountRequest 数据模型。
PFAuthenticationLoginWithOpenIdConnectRequest PFAuthenticationLoginWithOpenIdConnectRequest 数据模型。
PFAuthenticationLoginWithPSNRequest PFAuthenticationLoginWithPSNRequest 数据模型。 如果这是用户首次使用 PlayStation ™️ Network 帐户登录,并且 CreateAccount 设置为 true,则将创建新的 PlayFab 帐户并将其链接到 PlayStation ™️ Network 帐户。 在这种情况下,不会将任何电子邮件或用户名与 PlayFab 帐户关联。 否则,如果没有 PlayFab 帐户链接到 PlayStation ™️ 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 应用程序 ID 和 Web API 密钥配置游戏。 可以从 Steamworks 网站中与应用 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 帐户的创建。
PFAuthenticationLoginWithXUserRequest PFAuthenticationLoginWithXUserRequest 数据模型。 如果这是用户首次使用 Xbox Live 帐户登录,并且 CreateAccount 设置为 true,则将创建新的 PlayFab 帐户并将其链接到 Xbox Live 帐户。 在这种情况下,不会将任何电子邮件或用户名与 PlayFab 帐户关联。 否则,如果没有 PlayFab 帐户链接到 Xbox Live 帐户,则会返回一个错误,指示将返回此帐户,以便游戏可以指导用户完成 PlayFab 帐户的创建。 PFAuthenticationLoginWithXUserAsync 的请求对象。
PFAuthenticationServerLoginWithXboxRequest PFAuthenticationServerLoginWithXboxRequest 数据模型。 如果这是用户首次使用 Xbox Live 帐户登录,并且 CreateAccount 设置为 true,则将创建新的 PlayFab 帐户并将其链接到 Xbox Live 帐户。 在这种情况下,不会将任何电子邮件或用户名与 PlayFab 帐户关联。 否则,如果没有 PlayFab 帐户链接到 Xbox Live 帐户,则会返回一个错误,指示将返回此帐户,以便游戏可以指导用户完成 PlayFab 帐户的创建。
PFAuthenticationUserSettings PFAuthenticationUserSettings 数据模型。
PFAuthenticationValidateEntityTokenRequest PFAuthenticationValidateEntityTokenRequest 数据模型。 给定实体令牌,验证它是否未过期或尚未撤销,并将返回所有者的详细信息。
PFAuthenticationValidateEntityTokenResponse PFAuthenticationValidateEntityTokenResponse 数据模型。

状态更改

状态更改 说明

枚举

枚举 说明
PFAuthenticationIdentifiedDeviceType IdentifiedDeviceType 枚举。