Authentication - Login With Facebook Instant Games Id

Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Requires Facebook Instant Games to be configured.

POST https://titleId.playfabapi.com/Client/LoginWithFacebookInstantGamesId

Request Body

Name Required Type Description
CreateAccount
  • boolean

Automatically create a PlayFab account if one is not currently linked to this ID.

EncryptedRequest
  • string

Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).

FacebookInstantGamesSignature True
  • string

Facebook Instant Games signature for the user.

InfoRequestParameters

Flags for which pieces of info to return for the user.

LoginTitlePlayerAccountEntity
  • boolean

Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.

PlayerSecret
  • string

Player secret that is used to verify API request signatures (Enterprise Only).

TitleId True
  • string

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

None

This API requires no authentication headers (usually provides one to other calls).

Type: apiKey
In: header

Definitions

AdCampaignAttributionModel
ApiErrorWrapper

The basic wrapper around every failed API response

CharacterInventory
CharacterResult
ContactEmailInfoModel
ContinentCode
CountryCode
Currency
EmailVerificationStatus
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

EntityTokenResponse
GetPlayerCombinedInfoRequestParams
GetPlayerCombinedInfoResultPayload
ItemInstance

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.

LinkedPlatformAccountModel
LocationModel
LoginIdentityProvider
LoginResult
LoginWithFacebookInstantGamesIdRequest
MembershipModel
PlayerProfileModel
PlayerProfileViewConstraints
PushNotificationPlatform
PushNotificationRegistrationModel
StatisticModel
StatisticValue
SubscriptionModel
SubscriptionProviderStatus
TagModel
TitleActivationStatus
UserAccountInfo
UserAndroidDeviceInfo
UserCustomIdInfo
UserDataPermission

Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.

UserDataRecord
UserFacebookInfo
UserFacebookInstantGamesIdInfo
UserGameCenterInfo
UserGoogleInfo
UserIosDeviceInfo
UserKongregateInfo
UserNintendoSwitchDeviceIdInfo
UserOpenIdInfo
UserOrigination
UserPrivateAccountInfo
UserPsnInfo
UserSettings
UserSteamInfo
UserTitleInfo
UserTwitchInfo
UserWindowsHelloInfo
UserXboxInfo
ValueToDateModel
VirtualCurrencyRechargeTime

AdCampaignAttributionModel

Name Type Description
AttributedAt
  • string

UTC time stamp of attribution

CampaignId
  • string

Attribution campaign identifier

Platform
  • string

Attribution network name

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

Numerical Playfab error code

errorDetails
  • object

Detailed description of individual issues with the request object

errorMessage
  • string

Description for the Playfab errorCode

status
  • string

String HTTP code

CharacterInventory

Name Type Description
CharacterId
  • string

The id of this character.

Inventory

The inventory of this character.

CharacterResult

Name Type Description
CharacterId
  • string

The id for this character on this player.

CharacterName
  • string

The name of this character.

CharacterType
  • string

The type-string that was given to this character on creation.

ContactEmailInfoModel

Name Type Description
EmailAddress
  • string

The email address

Name
  • string

The name of the email info data

VerificationStatus

The verification status of the email

ContinentCode

Name Type Description
AF
  • string
AN
  • string
AS
  • string
EU
  • string
NA
  • string
OC
  • string
SA
  • string

CountryCode

Name Type Description
AD
  • string
AE
  • string
AF
  • string
AG
  • string
AI
  • string
AL
  • string
AM
  • string
AO
  • string
AQ
  • string
AR
  • string
AS
  • string
AT
  • string
AU
  • string
AW
  • string
AX
  • string
AZ
  • string
BA
  • string
BB
  • string
BD
  • string
BE
  • string
BF
  • string
BG
  • string
BH
  • string
BI
  • string
BJ
  • string
BL
  • string
BM
  • string
BN
  • string
BO
  • string
BQ
  • string
BR
  • string
BS
  • string
BT
  • string
BV
  • string
BW
  • string
BY
  • string
BZ
  • string
CA
  • string
CC
  • string
CD
  • string
CF
  • string
CG
  • string
CH
  • string
CI
  • string
CK
  • string
CL
  • string
CM
  • string
CN
  • string
CO
  • string
CR
  • string
CU
  • string
CV
  • string
CW
  • string
CX
  • string
CY
  • string
CZ
  • string
DE
  • string
DJ
  • string
DK
  • string
DM
  • string
DO
  • string
DZ
  • string
EC
  • string
EE
  • string
EG
  • string
EH
  • string
ER
  • string
ES
  • string
ET
  • string
FI
  • string
FJ
  • string
FK
  • string
FM
  • string
FO
  • string
FR
  • string
GA
  • string
GB
  • string
GD
  • string
GE
  • string
GF
  • string
GG
  • string
GH
  • string
GI
  • string
GL
  • string
GM
  • string
GN
  • string
GP
  • string
GQ
  • string
GR
  • string
GS
  • string
GT
  • string
GU
  • string
GW
  • string
GY
  • string
HK
  • string
HM
  • string
HN
  • string
HR
  • string
HT
  • string
HU
  • string
ID
  • string
IE
  • string
IL
  • string
IM
  • string
IN
  • string
IO
  • string
IQ
  • string
IR
  • string
IS
  • string
IT
  • string
JE
  • string
JM
  • string
JO
  • string
JP
  • string
KE
  • string
KG
  • string
KH
  • string
KI
  • string
KM
  • string
KN
  • string
KP
  • string
KR
  • string
KW
  • string
KY
  • string
KZ
  • string
LA
  • string
LB
  • string
LC
  • string
LI
  • string
LK
  • string
LR
  • string
LS
  • string
LT
  • string
LU
  • string
LV
  • string
LY
  • string
MA
  • string
MC
  • string
MD
  • string
ME
  • string
MF
  • string
MG
  • string
MH
  • string
MK
  • string
ML
  • string
MM
  • string
MN
  • string
MO
  • string
MP
  • string
MQ
  • string
MR
  • string
MS
  • string
MT
  • string
MU
  • string
MV
  • string
MW
  • string
MX
  • string
MY
  • string
MZ
  • string
NA
  • string
NC
  • string
NE
  • string
NF
  • string
NG
  • string
NI
  • string
NL
  • string
NO
  • string
NP
  • string
NR
  • string
NU
  • string
NZ
  • string
OM
  • string
PA
  • string
PE
  • string
PF
  • string
PG
  • string
PH
  • string
PK
  • string
PL
  • string
PM
  • string
PN
  • string
PR
  • string
PS
  • string
PT
  • string
PW
  • string
PY
  • string
QA
  • string
RE
  • string
RO
  • string
RS
  • string
RU
  • string
RW
  • string
SA
  • string
SB
  • string
SC
  • string
SD
  • string
SE
  • string
SG
  • string
SH
  • string
SI
  • string
SJ
  • string
SK
  • string
SL
  • string
SM
  • string
SN
  • string
SO
  • string
SR
  • string
SS
  • string
ST
  • string
SV
  • string
SX
  • string
SY
  • string
SZ
  • string
TC
  • string
TD
  • string
TF
  • string
TG
  • string
TH
  • string
TJ
  • string
TK
  • string
TL
  • string
TM
  • string
TN
  • string
TO
  • string
TR
  • string
TT
  • string
TV
  • string
TW
  • string
TZ
  • string
UA
  • string
UG
  • string
UM
  • string
US
  • string
UY
  • string
UZ
  • string
VA
  • string
VC
  • string
VE
  • string
VG
  • string
VI
  • string
VN
  • string
VU
  • string
WF
  • string
WS
  • string
YE
  • string
YT
  • string
ZA
  • string
ZM
  • string
ZW
  • string

Currency

Name Type Description
AED
  • string
AFN
  • string
ALL
  • string
AMD
  • string
ANG
  • string
AOA
  • string
ARS
  • string
AUD
  • string
AWG
  • string
AZN
  • string
BAM
  • string
BBD
  • string
BDT
  • string
BGN
  • string
BHD
  • string
BIF
  • string
BMD
  • string
BND
  • string
BOB
  • string
BRL
  • string
BSD
  • string
BTN
  • string
BWP
  • string
BYR
  • string
BZD
  • string
CAD
  • string
CDF
  • string
CHF
  • string
CLP
  • string
CNY
  • string
COP
  • string
CRC
  • string
CUC
  • string
CUP
  • string
CVE
  • string
CZK
  • string
DJF
  • string
DKK
  • string
DOP
  • string
DZD
  • string
EGP
  • string
ERN
  • string
ETB
  • string
EUR
  • string
FJD
  • string
FKP
  • string
GBP
  • string
GEL
  • string
GGP
  • string
GHS
  • string
GIP
  • string
GMD
  • string
GNF
  • string
GTQ
  • string
GYD
  • string
HKD
  • string
HNL
  • string
HRK
  • string
HTG
  • string
HUF
  • string
IDR
  • string
ILS
  • string
IMP
  • string
INR
  • string
IQD
  • string
IRR
  • string
ISK
  • string
JEP
  • string
JMD
  • string
JOD
  • string
JPY
  • string
KES
  • string
KGS
  • string
KHR
  • string
KMF
  • string
KPW
  • string
KRW
  • string
KWD
  • string
KYD
  • string
KZT
  • string
LAK
  • string
LBP
  • string
LKR
  • string
LRD
  • string
LSL
  • string
LYD
  • string
MAD
  • string
MDL
  • string
MGA
  • string
MKD
  • string
MMK
  • string
MNT
  • string
MOP
  • string
MRO
  • string
MUR
  • string
MVR
  • string
MWK
  • string
MXN
  • string
MYR
  • string
MZN
  • string
NAD
  • string
NGN
  • string
NIO
  • string
NOK
  • string
NPR
  • string
NZD
  • string
OMR
  • string
PAB
  • string
PEN
  • string
PGK
  • string
PHP
  • string
PKR
  • string
PLN
  • string
PYG
  • string
QAR
  • string
RON
  • string
RSD
  • string
RUB
  • string
RWF
  • string
SAR
  • string
SBD
  • string
SCR
  • string
SDG
  • string
SEK
  • string
SGD
  • string
SHP
  • string
SLL
  • string
SOS
  • string
SPL
  • string
SRD
  • string
STD
  • string
SVC
  • string
SYP
  • string
SZL
  • string
THB
  • string
TJS
  • string
TMT
  • string
TND
  • string
TOP
  • string
TRY
  • string
TTD
  • string
TVD
  • string
TWD
  • string
TZS
  • string
UAH
  • string
UGX
  • string
USD
  • string
UYU
  • string
UZS
  • string
VEF
  • string
VND
  • string
VUV
  • string
WST
  • string
XAF
  • string
XCD
  • string
XDR
  • string
XOF
  • string
XPF
  • string
YER
  • string
ZAR
  • string
ZMW
  • string
ZWD
  • string

EmailVerificationStatus

Name Type Description
Confirmed
  • string
Pending
  • string
Unverified
  • string

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id
  • string

Unique ID of the entity.

Type
  • string

Entity type. See https://api.playfab.com/docs/tutorials/entities/entitytypes

TypeString
  • string

Alternate name for Type.

EntityTokenResponse

Name Type Description
Entity

The entity id and type.

EntityToken
  • string

The token used to set X-EntityToken for all entity based API calls.

TokenExpiration
  • string

The time the token will expire, if it is an expiring token, in UTC.

GetPlayerCombinedInfoRequestParams

Name Type Description
GetCharacterInventories
  • boolean

Whether to get character inventories. Defaults to false.

GetCharacterList
  • boolean

Whether to get the list of characters. Defaults to false.

GetPlayerProfile
  • boolean

Whether to get player profile. Defaults to false. Has no effect for a new player.

GetPlayerStatistics
  • boolean

Whether to get player statistics. Defaults to false.

GetTitleData
  • boolean

Whether to get title data. Defaults to false.

GetUserAccountInfo
  • boolean

Whether to get the player's account Info. Defaults to false

GetUserData
  • boolean

Whether to get the player's custom data. Defaults to false

GetUserInventory
  • boolean

Whether to get the player's inventory. Defaults to false

GetUserReadOnlyData
  • boolean

Whether to get the player's read only data. Defaults to false

GetUserVirtualCurrency
  • boolean

Whether to get the player's virtual currency balances. Defaults to false

PlayerStatisticNames
  • string[]

Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false

ProfileConstraints

Specifies the properties to return from the player profile. Defaults to returning the player's display name.

TitleDataKeys
  • string[]

Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false

UserDataKeys
  • string[]

Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false

UserReadOnlyDataKeys
  • string[]

Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserReadOnlyData is false

GetPlayerCombinedInfoResultPayload

Name Type Description
AccountInfo

Account information for the user. This is always retrieved.

CharacterInventories

Inventories for each character for the user.

CharacterList

List of characters for the user.

PlayerProfile

The profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not exist.

PlayerStatistics

List of statistics for this player.

TitleData
  • object

Title data for this title.

UserData

User specific custom data.

UserDataVersion
  • number

The version of the UserData that was returned.

UserInventory

Array of inventory items in the user's current inventory.

UserReadOnlyData

User specific read-only data.

UserReadOnlyDataVersion
  • number

The version of the Read-Only UserData that was returned.

UserVirtualCurrency
  • object

Dictionary of virtual currency balance(s) belonging to the user.

UserVirtualCurrencyRechargeTimes

Dictionary of remaining times and timestamps for virtual currencies.

ItemInstance

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.

Name Type Description
Annotation
  • string

Game specific comment associated with this instance when it was added to the user inventory.

BundleContents
  • string[]

Array of unique items that were awarded when this catalog item was purchased.

BundleParent
  • string

Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or container.

CatalogVersion
  • string

Catalog version for the inventory item, when this instance was created.

CustomData
  • object

A set of custom key-value pairs on the inventory item.

DisplayName
  • string

CatalogItem.DisplayName at the time this item was purchased.

Expiration
  • string

Timestamp for when this instance will expire.

ItemClass
  • string

Class name for the inventory item, as defined in the catalog.

ItemId
  • string

Unique identifier for the inventory item, as defined in the catalog.

ItemInstanceId
  • string

Unique item identifier for this specific instance of the item.

PurchaseDate
  • string

Timestamp for when this instance was purchased.

RemainingUses
  • number

Total number of remaining uses, if this is a consumable item.

UnitCurrency
  • string

Currency type for the cost of the catalog item. Not available when granting items.

UnitPrice
  • number

Cost of the catalog item in the given currency. Not available when granting items.

UsesIncrementedBy
  • number

The number of uses that were added or removed to this item in this call.

LinkedPlatformAccountModel

Name Type Description
Email
  • string

Linked account email of the user on the platform, if available

Platform

Authentication platform

PlatformUserId
  • string

Unique account identifier of the user on the platform

Username
  • string

Linked account username of the user on the platform, if available

LocationModel

Name Type Description
City
  • string

City name.

ContinentCode

The two-character continent code for this location

CountryCode

The two-character ISO 3166-1 country code for the country associated with the location

Latitude
  • number

Latitude coordinate of the geographic location.

Longitude
  • number

Longitude coordinate of the geographic location.

LoginIdentityProvider

Name Type Description
AndroidDevice
  • string
Custom
  • string
CustomServer
  • string
Facebook
  • string
FacebookInstantGames
  • string
GameCenter
  • string
GameServer
  • string
GooglePlay
  • string
IOSDevice
  • string
Kongregate
  • string
NintendoSwitch
  • string
OpenIdConnect
  • string
PSN
  • string
PlayFab
  • string
Steam
  • string
Twitch
  • string
Unknown
  • string
WindowsHello
  • string
XBoxLive
  • string

LoginResult

Name Type Description
EntityToken

If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and returned.

InfoResultPayload

Results for requested info.

LastLoginTime
  • string

The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue

NewlyCreated
  • boolean

True if the account was newly created on this login.

PlayFabId
  • string

Player's unique PlayFabId.

SessionTicket
  • string

Unique token authorizing the user and game at the server level, for the current session.

SettingsForUser

Settings specific to this user.

LoginWithFacebookInstantGamesIdRequest

Name Type Description
CreateAccount
  • boolean

Automatically create a PlayFab account if one is not currently linked to this ID.

EncryptedRequest
  • string

Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).

FacebookInstantGamesSignature
  • string

Facebook Instant Games signature for the user.

InfoRequestParameters

Flags for which pieces of info to return for the user.

LoginTitlePlayerAccountEntity
  • boolean

Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.

PlayerSecret
  • string

Player secret that is used to verify API request signatures (Enterprise Only).

TitleId
  • string

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

MembershipModel

Name Type Description
IsActive
  • boolean

Whether this membership is active. That is, whether the MembershipExpiration time has been reached.

MembershipExpiration
  • string

The time this membership expires

MembershipId
  • string

The id of the membership

OverrideExpiration
  • string

Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been overridden, this will be the new expiration time.

OverrideIsSet
  • boolean

Whether the override expiration is set.

Subscriptions

The list of subscriptions that this player has for this membership

PlayerProfileModel

Name Type Description
AdCampaignAttributions

List of advertising campaigns the player has been attributed to

AvatarUrl
  • string

URL of the player's avatar image

BannedUntil
  • string

If the player is currently banned, the UTC Date when the ban expires

ContactEmailAddresses

List of all contact email info associated with the player account

Created
  • string

Player record created

DisplayName
  • string

Player display name

LastLogin
  • string

UTC time when the player most recently logged in to the title

LinkedAccounts

List of all authentication systems linked to this player account

Locations

List of geographic locations from which the player has logged in to the title

Memberships

List of memberships for the player, along with whether are expired.

Origination

Player account origination

PlayerId
  • string

PlayFab player account unique identifier

PublisherId
  • string

Publisher this player belongs to

PushNotificationRegistrations

List of configured end points registered for sending the player push notifications

Statistics

List of leaderboard statistic values for the player

Tags

List of player's tags for segmentation

TitleId
  • string

Title ID this player profile applies to

TotalValueToDateInUSD
  • number

Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.

ValuesToDate

List of the player's lifetime purchase totals, summed by real-money currency

PlayerProfileViewConstraints

Name Type Description
ShowAvatarUrl
  • boolean

Whether to show player's avatar URL. Defaults to false

ShowBannedUntil
  • boolean

Whether to show the banned until time. Defaults to false

ShowCampaignAttributions
  • boolean

Whether to show campaign attributions. Defaults to false

ShowContactEmailAddresses
  • boolean

Whether to show contact email addresses. Defaults to false

ShowCreated
  • boolean

Whether to show the created date. Defaults to false

ShowDisplayName
  • boolean

Whether to show the display name. Defaults to false

ShowLastLogin
  • boolean

Whether to show the last login time. Defaults to false

ShowLinkedAccounts
  • boolean

Whether to show the linked accounts. Defaults to false

ShowLocations
  • boolean

Whether to show player's locations. Defaults to false

ShowMemberships
  • boolean

Whether to show player's membership information. Defaults to false

ShowOrigination
  • boolean

Whether to show origination. Defaults to false

ShowPushNotificationRegistrations
  • boolean

Whether to show push notification registrations. Defaults to false

ShowStatistics
  • boolean

Reserved for future development

ShowTags
  • boolean

Whether to show tags. Defaults to false

ShowTotalValueToDateInUsd
  • boolean

Whether to show the total value to date in usd. Defaults to false

ShowValuesToDate
  • boolean

Whether to show the values to date. Defaults to false

PushNotificationPlatform

Name Type Description
ApplePushNotificationService
  • string
GoogleCloudMessaging
  • string

PushNotificationRegistrationModel

Name Type Description
NotificationEndpointARN
  • string

Notification configured endpoint

Platform

Push notification platform

StatisticModel

Name Type Description
Name
  • string

Statistic name

Value
  • number

Statistic value

Version
  • number

Statistic version (0 if not a versioned statistic)

StatisticValue

Name Type Description
StatisticName
  • string

unique name of the statistic

Value
  • number

statistic value for the player

Version
  • number

for updates to an existing statistic value for a player, the version of the statistic when it was loaded

SubscriptionModel

Name Type Description
Expiration
  • string

When this subscription expires.

InitialSubscriptionTime
  • string

The time the subscription was orignially purchased

IsActive
  • boolean

Whether this subscription is currently active. That is, if Expiration > now.

Status

The status of this subscription, according to the subscription provider.

SubscriptionId
  • string

The id for this subscription

SubscriptionItemId
  • string

The item id for this subscription from the primary catalog

SubscriptionProvider
  • string

The provider for this subscription. Apple or Google Play are supported today.

SubscriptionProviderStatus

Name Type Description
BillingError
  • string
Cancelled
  • string
CustomerDidNotAcceptPriceChange
  • string
FreeTrial
  • string
NoError
  • string
PaymentPending
  • string
ProductUnavailable
  • string
UnknownError
  • string

TagModel

Name Type Description
TagValue
  • string

Full value of the tag, including namespace

TitleActivationStatus

Name Type Description
ActivatedSteam
  • string
ActivatedTitleKey
  • string
None
  • string
PendingSteam
  • string
RevokedSteam
  • string

UserAccountInfo

Name Type Description
AndroidDeviceInfo

User Android device information, if an Android device has been linked

Created
  • string

Timestamp indicating when the user account was created

CustomIdInfo

Custom ID information, if a custom ID has been assigned

FacebookInfo

User Facebook information, if a Facebook account has been linked

FacebookInstantGamesIdInfo

Facebook Instant Games account information, if a Facebook Instant Games account has been linked

GameCenterInfo

User Gamecenter information, if a Gamecenter account has been linked

GoogleInfo

User Google account information, if a Google account has been linked

IosDeviceInfo

User iOS device information, if an iOS device has been linked

KongregateInfo

User Kongregate account information, if a Kongregate account has been linked

NintendoSwitchDeviceIdInfo

Nintendo Switch account information, if a Nintendo Switch account has been linked

OpenIdInfo

OpenID Connect information, if any OpenID Connect accounts have been linked

PlayFabId
  • string

Unique identifier for the user account

PrivateInfo

Personal information for the user which is considered more sensitive

PsnInfo

User PSN account information, if a PSN account has been linked

SteamInfo

User Steam information, if a Steam account has been linked

TitleInfo

Title-specific information for the user account

TwitchInfo

User Twitch account information, if a Twitch account has been linked

Username
  • string

User account name in the PlayFab service

WindowsHelloInfo

Windows Hello account information, if a Windows Hello account has been linked

XboxInfo

User XBox account information, if a XBox account has been linked

UserAndroidDeviceInfo

Name Type Description
AndroidDeviceId
  • string

Android device ID

UserCustomIdInfo

Name Type Description
CustomId
  • string

Custom ID

UserDataPermission

Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.

Name Type Description
Private
  • string
Public
  • string

UserDataRecord

Name Type Description
LastUpdated
  • string

Timestamp for when this data was last updated.

Permission

Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData requests being made by one player about another player.

Value
  • string

Data stored for the specified user data key.

UserFacebookInfo

Name Type Description
FacebookId
  • string

Facebook identifier

FullName
  • string

Facebook full name

UserFacebookInstantGamesIdInfo

Name Type Description
FacebookInstantGamesId
  • string

Facebook Instant Games ID

UserGameCenterInfo

Name Type Description
GameCenterId
  • string

Gamecenter identifier

UserGoogleInfo

Name Type Description
GoogleEmail
  • string

Email address of the Google account

GoogleGender
  • string

Gender information of the Google account

GoogleId
  • string

Google ID

GoogleLocale
  • string

Locale of the Google account

GoogleName
  • string

Name of the Google account user

UserIosDeviceInfo

Name Type Description
IosDeviceId
  • string

iOS device ID

UserKongregateInfo

Name Type Description
KongregateId
  • string

Kongregate ID

KongregateName
  • string

Kongregate Username

UserNintendoSwitchDeviceIdInfo

Name Type Description
NintendoSwitchDeviceId
  • string

Nintendo Switch Device ID

UserOpenIdInfo

Name Type Description
ConnectionId
  • string

OpenID Connection ID

Issuer
  • string

OpenID Issuer

Subject
  • string

OpenID Subject

UserOrigination

Name Type Description
Amazon
  • string
Android
  • string
CustomId
  • string
Facebook
  • string
FacebookInstantGamesId
  • string
GameCenter
  • string
GamersFirst
  • string
Google
  • string
IOS
  • string
Kongregate
  • string
LoadTest
  • string
NintendoSwitchDeviceId
  • string
OpenIdConnect
  • string
Organic
  • string
PSN
  • string
Parse
  • string
ServerCustomId
  • string
Steam
  • string
Twitch
  • string
Unknown
  • string
WindowsHello
  • string
XboxLive
  • string

UserPrivateAccountInfo

Name Type Description
Email
  • string

user email address

UserPsnInfo

Name Type Description
PsnAccountId
  • string

PSN account ID

PsnOnlineId
  • string

PSN online ID

UserSettings

Name Type Description
GatherDeviceInfo
  • boolean

Boolean for whether this player is eligible for gathering device info.

GatherFocusInfo
  • boolean

Boolean for whether this player should report OnFocus play-time tracking.

NeedsAttribution
  • boolean

Boolean for whether this player is eligible for ad tracking.

UserSteamInfo

Name Type Description
SteamActivationStatus

what stage of game ownership the user is listed as being in, from Steam

SteamCountry
  • string

the country in which the player resides, from Steam data

SteamCurrency

currency type set in the user Steam account

SteamId
  • string

Steam identifier

SteamName
  • string

Steam display name

UserTitleInfo

Name Type Description
AvatarUrl
  • string

URL to the player's avatar.

Created
  • string

timestamp indicating when the user was first associated with this game (this can differ significantly from when the user first registered with PlayFab)

DisplayName
  • string

name of the user, as it is displayed in-game

FirstLogin
  • string

timestamp indicating when the user first signed into this game (this can differ from the Created timestamp, as other events, such as issuing a beta key to the user, can associate the title to the user)

LastLogin
  • string

timestamp for the last user login for this title

Origination

source by which the user first joined the game, if known

TitlePlayerAccount

Title player account entity for this user

isBanned
  • boolean

boolean indicating whether or not the user is currently banned for a title

UserTwitchInfo

Name Type Description
TwitchId
  • string

Twitch ID

TwitchUserName
  • string

Twitch Username

UserWindowsHelloInfo

Name Type Description
WindowsHelloDeviceName
  • string

Windows Hello Device Name

WindowsHelloPublicKeyHash
  • string

Windows Hello Public Key Hash

UserXboxInfo

Name Type Description
XboxUserId
  • string

XBox user ID

ValueToDateModel

Name Type Description
Currency
  • string

ISO 4217 code of the currency used in the purchases

TotalValue
  • number

Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and ninety-nine cents when Currency is 'USD')

TotalValueAsDecimal
  • string

Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine dollars and ninety-nine cents when Currency is 'USD'.

VirtualCurrencyRechargeTime

Name Type Description
RechargeMax
  • number

Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen below this value.

RechargeTime
  • string

Server timestamp in UTC indicating the next time the virtual currency will be incremented.

SecondsToRecharge
  • number

Time remaining (in seconds) before the next recharge increment of the virtual currency.

Error Codes

Name Code
AccountNotFound 1001
FacebookInstantGamesAuthNotConfiguredForTitle 1397
InvalidFacebookInstantGamesSignature 1396
InvalidSignature 1273
InvalidSignatureTime 1324
InvalidTitleId 1004
PlayerSecretAlreadyConfigured 1294
PlayerSecretNotConfigured 1323
RequestViewConstraintParamsNotAllowed 1303