Account Management - Link Google Play Games Services Account

Service:

Client

API Version:

240514

Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account credentials

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

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
ServerAuthCode	True	string	OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess() (https://developers.google.com/games/services/android/signin) Google Play Games client API.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ForceLink		boolean	If another user is already linked to the account, unlink the other user and re-link. If the current user is already linked, link both accounts

Responses

Name	Type	Description
200 OK	LinkGooglePlayGamesServicesAccountResult
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
LinkGooglePlayGamesServicesAccountRequest	Google Play Games sign-in is accomplished by obtaining a Google OAuth 2.0 credential using the Google Play Games sign-in for Android APIs on the device and passing it to this API.
LinkGooglePlayGamesServicesAccountResult

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

LinkGooglePlayGamesServicesAccountRequest

Google Play Games sign-in is accomplished by obtaining a Google OAuth 2.0 credential using the Google Play Games sign-in for Android APIs on the device and passing it to this API.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ForceLink	boolean	If another user is already linked to the account, unlink the other user and re-link. If the current user is already linked, link both accounts
ServerAuthCode	string	OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess() (https://developers.google.com/games/services/android/signin) Google Play Games client API.

LinkGooglePlayGamesServicesAccountResult

Error Codes

Name	Code
AccountAlreadyLinked	1011
GoogleOAuthError	1271
GoogleOAuthNotConfiguredForTitle	1270
InvalidGooglePlayGamesServerAuthCode	1545
InvalidGoogleToken	1026
LinkedAccountAlreadyClaimed	1012