Title-Wide Data Management - Get Title Data

Reference

Service:: Client

API Version:: 240412

Retrieves the key-value store of custom title settings

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

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	Type	Description
Keys	string[]	Specific keys to search for in the title data (leave null to get all keys)
OverrideLabel	string	Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, the overrides are applied automatically to the title data.

Responses

Name	Type	Description
200 OK	GetTitleDataResult
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
GetTitleDataRequest	This API is designed to return title specific values which can be read, but not written to, by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. If the player belongs to an experiment variant that uses title data overrides, the overrides are applied automatically and returned with the title data. Note that there may up to a minute delay in between updating title data and this API call returning the newest value.
GetTitleDataResult

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

GetTitleDataRequest

This API is designed to return title specific values which can be read, but not written to, by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. If the player belongs to an experiment variant that uses title data overrides, the overrides are applied automatically and returned with the title data. Note that there may up to a minute delay in between updating title data and this API call returning the newest value.

Name	Type	Description
Keys	string[]	Specific keys to search for in the title data (leave null to get all keys)
OverrideLabel	string	Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, the overrides are applied automatically to the title data.

GetTitleDataResult

Name	Type	Description
Data	object	a dictionary object of key / value pairs