Using Publisher data
This tutorial describes how to create and use Publisher (Studio) data.
Publisher data is data that spans more than one title - such as when you have multiple games that need to share common information.
Note
This category also includes data for players that spans multiple games. PlayFab stores data as Key/Value Pairs (KVPs).
Most of these APIs are server APIs that your program must call from a dedicated server, or through a CloudScript function within the PlayFab service.
- Use the server APIs SetPublisherData to update, and GetPublisherData to retrieve, Publisher-specific custom KVPs.
- Use UpdateUserPublisherData to create or update, and GetUserPublisherData to retrieve, Publisher-specific custom KVPs for the player.
- Use the server API UpdateUserPublisherReadOnlyData to update, and the client API GetUserPublisherReadOnlyData to retrieve, the read-only Publisher-specific custom KVPs for the user.
- Use the server APIs UpdateUserPublisherInternalData to update, and GetUserPublisherInternalData to retrieve, the internal Publisher-specific custom KVPs for the user.
You must call the server APIs from a dedicated server or through a CloudScript function through the PlayFab service. This is by design, as the PlayFab server APIs require that you supply your secret key.
Tip
We do not recommend using server APIs from within a game client. If you need to make use of a server API, use CloudScript for this type of functionality.
Publisher data values are copied and distributed to potentially hundreds of machines in the PlayFab cluster server. As part of this process, this data is cached and changes may take up to fifteen minutes to refresh in those caches.
Note
Publisher data is best suited for global constant/static data, and is not suitable or reliable as global variables.
Publisher data
Publisher data is used to store static data for a set of titles. Each entry is not bound to any PlayFab entity, such as a player (as opposed to user publisher data).
Setting Publisher data
The following snippet demonstrates how to set Publisher data using the Server API.
Note
There is an admin API counterpart for this operation.
public void ServerSetPublisherData() {
PlayFabServerAPI.SetPublisherData(new SetPublisherDataRequest() {
Key = "SomeKey",
Value = "SomeValue"
},
result => Debug.Log("Complete setting publisher data"),
error => {
Debug.Log("Got error setting publisher data");
Debug.Log(error.GenerateErrorReport());
}
);
}
Getting Publisher data
The following snippet demonstrates getting Publisher data using the Client API.
Note
There are server and admin API counterparts for this operation.
public void ClientGetPublisherData() {
PlayFabClientAPI.GetPublisherData(new GetPublisherDataRequest(),
result => {
if (result.Data == null || !result.Data.ContainsKey("SomeKey")) Debug.Log("No SomeKey");
else Debug.Log("SomeKey: " + result.Data["SomeKey"]);
},
error => {
Debug.Log("Got error getting publisher data");
Debug.Log(error.GenerateErrorReport());
});
}
User Publisher data
User Publisher data can be used to introduce Publisher data that is bound to a PlayFab user (player).
Unlike regular Publisher data, it is possible for a Client application to alter user Publisher data.
PlayFab exposes 3 protection levels for user Publisher data from the Client API point of view:
Regular user Publisher data exposes read and write access for client applications.
- Set via Client, Server, and Admin API.
- Get via Client, Server, and Admin API.
- The Client API may only set Publisher data for a player who is currently logged in.
Read-only user Publisher data exposes read access for client applications.
- Set via Server and Admin API.
- Get via Client, Server, and Admin API.
Internal user Publisher data exposes no access for client applications, and is used to store the secret portion of user data.
- Set via Server and Admin API.
- Get via Server and Admin API.
Setting user Publisher data
The following snippet demonstrates how to set all 3 kinds of Publisher data using Client and Server APIs.
// Use Client API to set User Publisher Data for current user
public void ClientSetUserPublisherData() {
PlayFabClientAPI.UpdateUserPublisherData(new UpdateUserDataRequest() {
Data = new Dictionary<string, string>() {
{ "SomeKey", "SomeValue" }
}
},
result => Debug.Log("Complete setting Regular User Publisher Data"),
error =>
{
Debug.Log("Error setting Regular User Publisher Data");
Debug.Log(error.GenerateErrorReport());
});
}
// Use Server API to set Read-Only User Publisher Data for selected user
public void ServerSetUserPublisherReadOnlyData() {
PlayFabServerAPI.UpdateUserPublisherReadOnlyData(new UpdateUserDataRequest() {
PlayFabId = "< PlayFab Player Id >",
Data = new Dictionary<string, string>() {
{ "SomeKey", "SomeValue" }
}
},
result => Debug.Log("Complete setting Read-Only User Publisher Data"),
error =>
{
Debug.Log("Error setting Read-Only User Publisher Data");
Debug.Log(error.GenerateErrorReport());
});
}
// Use Server API to set Internal User Publisher Data for selected user
public void ServerSetUserPublisherInternalData() {
PlayFabServerAPI.UpdateUserPublisherInternalData(new UpdateUserInternalDataRequest() {
PlayFabId = "< PlayFab Player Id >",
Data = new Dictionary<string, string>() {
{ "SomeKey", "SomeValue" }
}
},
result => Debug.Log("Complete setting Internal User Publisher Data"),
error =>
{
Debug.Log("Error setting Internal User Publisher Data");
Debug.Log(error.GenerateErrorReport());
});
}
Getting user Publisher data
The following snippet demonstrates how to get all 3 kinds of Publisher data using Client and Server APIs.
// Use Client API to get Regular User Publisher Data for selected user
public void ClientGetUserPublisherData() {
PlayFabClientAPI.GetUserPublisherData(new GetUserDataRequest() {
PlayFabId = "<PlayFab Player Id>"
}, result => {
if (result.Data == null || !result.Data.ContainsKey("SomeKey")) Debug.Log("No SomeKey");
else Debug.Log("SomeKey: " + result.Data["SomeKey"]);
},
error => {
Debug.Log("Got error getting Regular Publisher Data:");
Debug.Log(error.GenerateErrorReport());
});
}
// Use Client API to get Read-Only User Publisher Data for selected user
public void ClientGetUserPublisherReadOnlyData() {
PlayFabClientAPI.GetUserPublisherReadOnlyData(new GetUserDataRequest() {
PlayFabId = "<PlayFab Player Id>"
}, result => {
if (result.Data == null || !result.Data.ContainsKey("SomeKey")) Debug.Log("No SomeKey");
else Debug.Log("SomeKey: " + result.Data["SomeKey"]);
},
error => {
Debug.Log("Got error getting Read-Only Publisher Data:");
Debug.Log(error.GenerateErrorReport());
});
}
// Use Server API to get Internal User Publisher Data for selected user
public void ServerGetUserPublisherInternalData() {
PlayFabServerAPI.GetUserPublisherInternalData(new GetUserDataRequest() {
PlayFabId = "<PlayFab Player Id>"
}, result => {
if (result.Data == null || !result.Data.ContainsKey("SomeKey")) Debug.Log("No SomeKey");
else Debug.Log("SomeKey: " + result.Data["SomeKey"]);
},
error => {
Debug.Log("Got error getting Internal Publisher Data:");
Debug.Log(error.GenerateErrorReport());
});
}