Account Management - Get PlayFab IDs From Facebook Instant Games Ids

Service:

Client

API Version:

240412

Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.

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

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Request Body

Name	Required	Type	Description
FacebookInstantGamesIds	True	string[]	Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in length.

Responses

Name	Type	Description
200 OK	GetPlayFabIDsFromFacebookInstantGamesIdsResult	For Facebook Instant Game identifiers which have not been linked to PlayFab accounts, null will be returned.
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
FacebookInstantGamesPlayFabIdPair
GetPlayFabIDsFromFacebookInstantGamesIdsRequest
GetPlayFabIDsFromFacebookInstantGamesIdsResult	For Facebook Instant Game identifiers which have not been linked to PlayFab accounts, null will be returned.

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	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

FacebookInstantGamesPlayFabIdPair

Name	Type	Description
FacebookInstantGamesId	string	Unique Facebook Instant Games identifier for a user.
PlayFabId	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook Instant Games identifier.

GetPlayFabIDsFromFacebookInstantGamesIdsRequest

Name	Type	Description
FacebookInstantGamesIds	string[]	Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in length.

GetPlayFabIDsFromFacebookInstantGamesIdsResult

For Facebook Instant Game identifiers which have not been linked to PlayFab accounts, null will be returned.

Name	Type	Description
Data	FacebookInstantGamesPlayFabIdPair[]	Mapping of Facebook Instant Games identifiers to PlayFab identifiers.