Title-Wide Data Management - Get Publisher Data

Service:

Server

API Version:

240412

Retrieves the key-value store of custom publisher settings

POST https://titleId.playfabapi.com/Server/GetPublisherData

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
Keys	True	string[]	array of keys to get back data from the Publisher data blob, set by the admin tools

Responses

Name	Type	Description
200 OK	GetPublisherDataResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GetPublisherDataRequest	This API is designed to return publisher-specific values which can be read, but not written to, by the client. This data is shared across all titles assigned to a particular publisher, and can be used for cross-game coordination. Only titles assigned to a publisher can use this API. For more information email helloplayfab@microsoft.com. Note that there may up to a minute delay in between updating title data and this API call returning the newest value.
GetPublisherDataResult

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

GetPublisherDataRequest

This API is designed to return publisher-specific values which can be read, but not written to, by the client. This data is shared across all titles assigned to a particular publisher, and can be used for cross-game coordination. Only titles assigned to a publisher can use this API. For more information email helloplayfab@microsoft.com. 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[]	array of keys to get back data from the Publisher data blob, set by the admin tools

GetPublisherDataResult

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

Error Codes

Name	Code
PublisherNotSet	1122