Vue d'ensemble de l'API C Services - PFAuthenticationTypes.h - XBOX Game Development Documentation

Structures

Structure	Description
PFAuthenticationLoginWithXUserRequest	Modèle de données PFAuthenticationLoginWithXUserRequest. Si c’est la première fois qu’un utilisateur se connecte avec le compte XBOX Live et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte XBOX Live. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte XBOX Live, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab. Objet de requête pour PFAuthenticationLoginWithXUserAsync.
PFAuthenticationAuthenticateCustomIdRequest	Modèle de données PFAuthenticationAuthenticateCustomIdRequest. Crée ou retourne un jeton d’entité game_server. L’appelant doit être une entité de titre.
PFAuthenticationAuthenticateCustomIdResult	Modèle de données PFAuthenticationAuthenticateCustomIdResult.
PFAuthenticationDeleteRequest	Modèle de données PFAuthenticationDeleteRequest. Supprime une entité game_server. L’appelant peut être l’entité game_server qui tente de se supprimer elle-même. Ou une entité de titre qui tente de supprimer des entités game_server de ce titre.
PFAuthenticationEntityTokenResponse	Modèle de données PFAuthenticationEntityTokenResponse.
PFAuthenticationGetEntityRequest	Modèle de données PFAuthenticationGetEntityRequest. Cette API doit être appelée avec les en-têtes X-SecretKey, X-Authentication ou X-EntityToken. L’en-tête doit toujours être valide et ne peut pas être expiré ni révoqué. En cas de réussite, elle émettra un nouveau jeton d’entité et déclenchera l’événement PlayStream “entity_logged_in”.
PFAuthenticationLoginResult	Modèle de données PFAuthenticationLoginResult.
PFAuthenticationLoginWithAppleRequest	Modèle de données PFAuthenticationLoginWithAppleRequest.
PFAuthenticationLoginWithBattleNetRequest	Modèle de données PFAuthenticationLoginWithBattleNetRequest.
PFAuthenticationLoginWithCustomIDRequest	Modèle de données PFAuthenticationLoginWithCustomIDRequest. Il est fortement recommandé aux développeurs de s’assurer qu’il est extrêmement improbable qu’un client puisse générer un ID déjà utilisé par un autre client. Si c’est la première fois qu’un utilisateur se connecte avec l’ID personnalisé et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié à l’ID personnalisé. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié à l’ID personnalisé, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationLoginWithFacebookRequest	Modèle de données PFAuthenticationLoginWithFacebookRequest. La connexion Facebook s’effectue à l’aide du jeton d’accès utilisateur Facebook. Vous trouverez plus d’informations sur ce jeton dans la documentation pour développeurs de Facebook (https://developers.facebook.com/docs/facebook-login/access-tokens/). Dans Unity, par exemple, le jeton est disponible en tant qu’AccessToken dans le ScriptableObject FB du SDK Facebook. Si c’est la première fois qu’un utilisateur se connecte avec le compte Facebook et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié à l’ID Facebook du compte fourni. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte Facebook, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab. Notez que les titres ne doivent jamais réutiliser les mêmes applications Facebook entre plusieurs ID de titre PlayFab, car Facebook fournit des ID d’utilisateur uniques par application, et cela peut entraîner des problèmes avec l’ID Facebook de l’utilisateur dans les informations de son compte PlayFab. Si vous devez réutiliser une application dans un nouvel ID de titre PlayFab, assurez-vous d’abord de dissocier tous les comptes de Facebook ou de supprimer tous les utilisateurs du premier ID de titre. Remarque : si l’utilisateur est authentifié avec AuthenticationToken plutôt qu’avec AccessToken, l’API GetFriendsList retournera une liste vide.
PFAuthenticationLoginWithGameCenterRequest	Modèle de données PFAuthenticationLoginWithGameCenterRequest. L’identificateur de joueur Game Center (https://developer.apple.com/library/ios/documentation/Accounts/Reference/ACAccountClassRef/index.html# // apple_ref/occ/instp/ACAccount/identifier) est une chaîne générée qui est stockée sur l’appareil local. Comme pour les identificateurs d’appareil, il faut veiller à ne jamais exposer l’identificateur Game Center d’un joueur aux utilisateurs finaux, car cela pourrait compromettre le compte de l’utilisateur. Si c’est la première fois qu’un utilisateur se connecte avec Game Center et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié à l’identificateur Game Center. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte Game Center, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab. Si un identificateur de joueur Game Center iOS non valide est utilisé, une erreur l’indiquant sera retournée.
PFAuthenticationLoginWithGoogleAccountRequest	Modèle de données PFAuthenticationLoginWithGoogleAccountRequest. La connexion Google s’effectue en obtenant des informations d’identification Google OAuth 2.0 à l’aide des API de connexion Google pour Android sur l’appareil, puis en les transmettant à cette API. Si c’est la première fois qu’un utilisateur se connecte avec le compte Google et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte Google. Sinon, si aucun compte PlayFab n’est lié au compte Google, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab. La méthode actuelle (recommandée) pour obtenir des informations d’identification de compte Google dans une application Android consiste à appeler GoogleSignInAccount.getServerAuthCode() et à envoyer le code d’authentification comme paramètre ServerAuthCode de cette API. Avant cela, vous devez créer un ID client d’application Web OAuth 2.0 dans la console des API Google et configurer son ID client et son secret dans le module complémentaire Google de PlayFab Game Manager pour votre titre. Cette méthode ne nécessite pas de demander à l’utilisateur des autorisations supplémentaires pour son compte Google, ce qui offre une expérience utilisateur avec le moins de friction possible. Pour plus d’informations sur l’obtention du code d’authentification du serveur, consultez https://developers.google.com/identity/sign-in/android/offline-access. La méthode précédente (dépréciée) consistait à obtenir un jeton d’accès OAuth en appelant GetAccessToken() sur le client et à le transmettre comme paramètre AccessToken à cette API. pour le avec le jeton d’accès Google OAuth 2.0. Vous trouverez plus d’informations sur ce changement dans la documentation pour développeurs de Google (https://android-developers.googleblog.com/2016/01/play-games-permissions-are-changing-in.html).
PFAuthenticationLoginWithGooglePlayGamesServicesRequest	Modèle de données PFAuthenticationLoginWithGooglePlayGamesServicesRequest. La connexion Google Play Games s’effectue en obtenant des informations d’identification Google OAuth 2.0 à l’aide des API de connexion Google Play Games pour Android sur l’appareil, puis en les transmettant à cette API. Si c’est la première fois qu’un utilisateur se connecte avec le compte Google Play Games et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte Google Play Games. Sinon, si aucun compte PlayFab n’est lié au compte Google Play Games, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab. La méthode actuelle (recommandée) pour obtenir des informations d’identification de compte Google Play Games dans une application Android consiste à appeler GamesSignInClient.requestServerSideAccess() et à envoyer le code d’authentification comme paramètre ServerAuthCode de cette API. Avant cela, vous devez créer un ID client d’application Web OAuth 2.0 dans la console des API Google et configurer son ID client et son secret dans le module complémentaire Google de PlayFab Game Manager pour votre titre. Cette méthode ne nécessite pas de demander à l’utilisateur des autorisations supplémentaires pour son compte Google, ce qui offre une expérience utilisateur avec le moins de friction possible. Pour plus d’informations sur l’obtention du code d’authentification du serveur, consultez https://developers.google.com/games/services/android/signin.
PFAuthenticationLoginWithNintendoServiceAccountRequest	Modèle de données PFAuthenticationLoginWithNintendoServiceAccountRequest.
PFAuthenticationLoginWithOpenIdConnectRequest	Modèle de données PFAuthenticationLoginWithOpenIdConnectRequest.
PFAuthenticationLoginWithPSNRequest	Modèle de données PFAuthenticationLoginWithPSNRequest. Si c’est la première fois qu’un utilisateur se connecte avec le compte PlayStation :tm: Network et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte PlayStation :tm: Network. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte PlayStation :tm: Network, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationLoginWithServerCustomIdRequest	Modèle de données PFAuthenticationLoginWithServerCustomIdRequest.
PFAuthenticationLoginWithSteamIdRequest	Modèle de données PFAuthenticationLoginWithSteamIdRequest. Si c’est la première fois qu’un utilisateur se connecte avec l’ID Steam et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte Steam. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte Steam, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab. Pour les utilisateurs Steam qui ne sont pas connectés à l’application cliente Steam, seul leur nom d’utilisateur Steam sera synchronisé; les autres données, comme la devise et le pays, ne seront pas disponibles tant qu’ils ne se connecteront pas pendant que le client est ouvert.
PFAuthenticationLoginWithSteamRequest	Modèle de données PFAuthenticationLoginWithSteamRequest. La connexion Steam s’effectue à l’aide du ticket de session Steam. Vous trouverez plus d’informations sur ce ticket dans le SDK Steamworks, ici : https://partner.steamgames.com/documentation/auth. REMARQUE : pour que l’authentification Steam fonctionne, le titre doit être configuré avec l’ID d’application Steam et la clé d’API Web dans PlayFab Game Manager (sous Steam dans le Marketplace des modules complémentaires). Vous pouvez obtenir une clé d’API Web à partir de la page Autorisations de n’importe quel groupe associé à votre ID d’application sur le site Steamworks. Si c’est la première fois qu’un utilisateur se connecte avec le compte Steam et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié à l’ID Steam du compte fourni. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte Steam, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationLoginWithXboxIdRequest	Modèle de données PFAuthenticationLoginWithXboxIdRequest. Si c’est la première fois qu’un utilisateur se connecte avec l’ID XBOX et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte XBOX Live. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte XBOX Live, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationLoginWithXboxRequest	Modèle de données PFAuthenticationLoginWithXboxRequest. Si c’est la première fois qu’un utilisateur se connecte avec le compte XBOX Live et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte XBOX Live. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte XBOX Live, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationServerLoginWithAndroidDeviceIDRequest	Modèle de données PFAuthenticationServerLoginWithAndroidDeviceIDRequest. Sur les appareils Android, il est recommandé d’utiliser Settings.Secure.ANDROID_ID comme AndroidDeviceId, comme décrit dans ce billet de blogue (http://android-developers.blogspot.com/2011/03/identifying-app-installations.html). Vous trouverez plus d’informations sur cet identificateur dans la documentation Android (http://developer.android.com/reference/android/provider/Settings.Secure.html). Si c’est la première fois qu’un utilisateur se connecte avec l’appareil Android et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié à l’ID d’appareil Android. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié à l’appareil Android, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab. Veuillez noter que, bien que plusieurs appareils de ce type puissent être liés à un même compte d’utilisateur, seul celui utilisé le plus récemment pour se connecter (ou lié le plus récemment) sera reflété dans les informations du compte de l’utilisateur. Une mise à jour permettra d’afficher tous les appareils liés dans une version future.
PFAuthenticationServerLoginWithBattleNetRequest	Modèle de données PFAuthenticationServerLoginWithBattleNetRequest.
PFAuthenticationServerLoginWithCustomIDRequest	Modèle de données PFAuthenticationServerLoginWithCustomIDRequest. Il est fortement recommandé aux développeurs de s’assurer qu’il est extrêmement improbable qu’un client puisse générer un ID déjà utilisé par un autre client. Si c’est la première fois qu’un utilisateur se connecte avec l’ID personnalisé et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié à l’ID personnalisé. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié à l’ID personnalisé, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationServerLoginWithIOSDeviceIDRequest	Modèle de données PFAuthenticationServerLoginWithIOSDeviceIDRequest. Sur les appareils iOS, l’identifierForVendor (https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/index.html# // apple_ref/occ/instp/UIDevice/identifierForVendor) doit être utilisé comme DeviceId, car le uniqueIdentifier de UIDevice est déprécié depuis iOS 5, et l’utilisation de l’advertisingIdentifier à cette fin entraînera l’échec du processus de certification d’Apple. Si c’est la première fois qu’un utilisateur se connecte avec l’appareil iOS et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié à l’ID d’appareil iOS propre au fournisseur. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié à l’appareil iOS, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationServerLoginWithPSNRequest	Modèle de données PFAuthenticationServerLoginWithPSNRequest. Si c’est la première fois qu’un utilisateur se connecte avec le compte PlayStation :tm: Network et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte PlayStation :tm: Network. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte PlayStation :tm: Network, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationServerLoginWithXboxRequest	Modèle de données PFAuthenticationServerLoginWithXboxRequest. Si c’est la première fois qu’un utilisateur se connecte avec le compte XBOX Live et que CreateAccount est défini sur true, un nouveau compte PlayFab sera créé et lié au compte XBOX Live. Dans ce cas, aucune adresse courriel ni aucun nom d’utilisateur ne sera associé au compte PlayFab. Sinon, si aucun compte PlayFab n’est lié au compte XBOX Live, une erreur l’indiquant sera retournée, afin que le titre puisse guider l’utilisateur dans la création d’un compte PlayFab.
PFAuthenticationUserSettings	Modèle de données PFAuthenticationUserSettings.
PFAuthenticationValidateEntityTokenRequest	Modèle de données PFAuthenticationValidateEntityTokenRequest. À partir d’un jeton d’entité, valide qu’il n’a pas expiré ni été révoqué, et retourne les détails de son propriétaire.
PFAuthenticationValidateEntityTokenResponse	Modèle de données PFAuthenticationValidateEntityTokenResponse.

Changements d’état

Changement d’état	Description

Énumérations

Énumération	Description
PFAuthenticationIdentifiedDeviceType	Énumération IdentifiedDeviceType.

Dernière modification le 6 octobre 2026

⌘I