Publisher

The PlayFab Publisher Module is specifically designed to manage and utilize the studio-wide features. 

In PlayFab, the publisher refers to the studio. Henceforth, this plugin lets you access the studio-wide features of the studio where this game is handled including the other games from this studio.

There can also be multiple studios on a PlayFab Server account. 

Features range from studio to user accounts. This means that there are Studio data and also User Studio data, which are, to wit:

  • Publisher Data

  • User Publisher Data

These can be written or read through this addon, including reading of other players.

User Data

The User Data addon implements title-wide game user data. It is a counterpart for the Publisher addon's studio-wide user data.

User Data is best used for a game-specific data for each user.

Title Manager

The Title Manager addon implements title-wide game global data. It is a counterpart for the Publisher addon's studio-wide global data.

Title Manager is best used for data accessible to all users in a game title.

 

Intstructions

1. The first step is to add the PlayFab API addon into the project.

2. Then, add the Authentication addon into the project.

3. Finally, add the Publisher addon into the project.

Features :

  • User Studio Data & Read-Only Data

  • Other Studio User Data & Read-Only Data

  • Private and Public Studio Data

  • Easy Local Studio Data loading feature.

  • Account synced and profiled.

  • Organized request and update feature.

Network Services :

  • Facebook

  • Google Plus

  • Game Center

  • Google Play

  • Facebook Instant Games

  • Steam

  • Xbox Live

  • Nintendo Switch

  • PS4

  • PlayFab

Actions, Conditions & Expressions

Actions

Get Publisher Data:

  • Plan Get Publisher Data - Plan to get a Publisher Data for the next "Get Publisher Data".

    • Key - ​The "Key" reference for the Publisher Data.

  • Get Publisher Data - Retrieves the key-value store of custom publisher settings.

    • Tag -​ Tag to differentiate requests.

Get User Publisher Data:

  • Plan Get User Publisher Data - Plan to get a User Publisher Data for the next "Get User Publisher Data".

    • Key - ​The "Key" reference for the User Publisher Data.

  • Get User Publisher Data - Retrieves the publisher-specific custom data for the user which is readable and writable by the client.

    • Tag -​ Tag to differentiate requests.

  • Get All User Publisher Data - Retrieves all the publisher-specific custom data for the user which is readable and writable by the client.

    • Tag -​ Tag to differentiate requests.

Get User Publisher Read-Only Data:

  • Plan Get User Read Data - Plan to get a User Publisher Read-Only Data for the next "Get User Publisher Read Data".

    • Key - ​The "Key" reference for the User Publisher ReadOnly Data.

  • Get User Publisher Read Data - Retrieves the publisher-specific custom data for the user which can only be read by the client.

    • Tag -​ Tag to differentiate requests.

  • Get All User Publisher Read Data - Retrieves all the publisher-specific custom data for the user which can only be read by the client.

    • Tag -​ Tag to differentiate requests.

Update User Publisher Data:

  • Plan Write Data - Plan a "Write User Publisher Data" request into the next "Update User Data".

    • Key - ​Input the "Key" of the User Publisher Data. Keys are trimmed of whitespace, are limited in size, and may not begin with a "!" character or be null.

    • Value - The Value for the "User Publisher Data Key".

  • Plan Remove Data - Plan a "Remove User Publisher Data" request into the next "Update User Data".

    • Key - ​Input the "Key" of the User Data to remove.

  • Update User Publisher Data - Creates and updates the publisher-specific custom data for the user which is readable and writable by the client.

    • Permission - ​Permission to be applied to all "User Publisher Data Keys" written in this request. If "Public", it will hidden from other Players.

      • Private​

      • Public

    • Tag -​ Tag to differentiate requests.

Get Other User Publisher Data:

  • Plan Get Other Publisher Data - Plan to get "Other's" Publisher Data for the next "Get User Publisher Data".

    • Key - ​The "Key" reference for the User Publisher Data.

  • Get Other Publisher Data - Retrieves the publisher-specific custom data from "Other Users" which is readable and writable by the client.

    • PlayFab ID - ​The Target Player's "PlayFabID".

    • Tag -​ Tag to differentiate requests.

  • Get All Other Publisher Data - Retrieves all the publisher-specific custom data from "Other Users" which is readable and writable by the client.

    • PlayFab ID - ​The Target Player's "PlayFabID".

    • Tag -​ Tag to differentiate requests.

Get Other User Publisher Read-Only Data:

  • Plan Get Other Read Data - Plan to get Other User's Publisher Read-Only Data for the next "Get User Publisher Read Data".

    • Key - ​The "Key" reference for the User Publisher ReadOnly Data.

  • Get Other Publisher Read Data - Retrieves the publisher-specific custom data from Other Users which can only be read by the client.

    • PlayFab ID - ​The Target Player's "PlayFabID".

    • Tag -​ Tag to differentiate requests.

  • Get All Other Publisher Read Data - Retrieves all the publisher-specific custom data from Other Users which can only be read by the client.

    • PlayFab ID - ​The Target Player's "PlayFabID".

    • Tag -​ Tag to differentiate requests.

Publisher :: Locally Retrieve:

  • Load Publisher Data - Load the local data from the latest "Get Publisher Data".

    • Key - ​Input the "Key" of the Publisher Data to load.

User Publisher :: Locally Retrieve:

  • Load User Publisher Data - Load the local data from the latest "Get User Publisher Data".

    • Key - ​Input the "Key" of the User Publisher Data to load.

User Publisher Read-Only Data :: Locally Retrieve:

  • Load User Publisher Read Data - Load the local read-only data from the latest "Get User Publisher Read Data".

    • Key - ​Input the "Key" of the User Publisher Read-Only Data to load.

Other Publisher :: Locally Retrieve:

  • Load Other Publisher Data - Load the local data from the latest "Get Other Publisher Data".

    • Key - ​Input the "Key" of the User Publisher Data to load.

Other Publisher Read-Only Data :: Locally Retrieve:

  • Load Other Publisher Read Data - Load the local read-only data from the latest "Get Other Publisher Read Data".

    • Key - ​Input the "Key" of the User Publisher Read-Only Data to load.

Conditions

Get Publisher Data:

  • On Get Publisher Data - Triggers when the Get Publisher Data Succeeded.

  • On Get Publisher Data Error - Triggers when the Get Publisher Data Failed.

Get User Publisher Data:

  • On Get Publisher Data - Triggers when the Get User Publisher Data Succeeded.

  • On Get Publisher Data Error - Triggers when the Get User Publisher Data Failed.

Get User Publisher Read Only Data:

  • On Get Publisher Read Data - Triggers when the Get User Publisher Read-Only Data Succeeded.

  • On Get Publisher Read Data Error - Triggers when the Get User Publisher Read-Only Data Failed.

Get Other Publisher Data:

  • On Get Publisher Data - Triggers when the Get Other Publisher Data Succeeded.

  • On Get Publisher Data Error - Triggers when the Get Other Publisher Data Failed.

Get Other Publisher Read Only Data:

  • On Get Publisher Read Data - Triggers when the Get Other Publisher Read-Only Data Succeeded.

  • On Get Publisher Read Data Error - Triggers when the Get Other Publisher Read-Only Data Failed.

Update User Publisher Data:

  • On Update Publisher Data - Triggers when the Update User Publisher Data Succeeded.

  • On Update Publisher Data Error - Triggers when the Update User Publisher Data Failed.

Load :: Publisher Data:

  • On Load Publisher Data - Triggers when the Load Publisher Data Succeeded.

    • Key - The "Key" or "Publisher Data Name" to load for return.

  • On Load Publisher Data Failed - Triggers when the Load Publisher Data Failed.

    • Key - ​The "Key" or "Publisher Data Name" to load for return.

  • On Any Load Publisher Data - Triggers when any Load Publisher Data Succeeded.

  • On Any Load Publisher Failed - Triggers when any Load Publisher Data Failed.

Expressions

Get User Publisher Data :

  • getDataVersion - Returns the "User Publisher Data : Data Version" from the latest "Get Publisher Data". Indicates the current version of the data that has been set.

Get User Publisher Read-Only Data :

  • getReadDataVersion - Returns the "User Publisher Read Data : Data Version" from the latest "Get User Publisher Data". Indicates the current version of the data that has been set.

Update User Publisher Data :

  • updateDataVersion - Returns the "Update User Publisher : Data Version" from the latest "Update User Publisher Data". Indicates the current version of the data that has been set.


Get Other User Publisher Data :

  • getODataVersion - Returns the "Other Publisher Data : Data Version" from the latest "Get Other Publisher Data". Indicates the current version of the data that has been set.


Get Other User Publisher Read-Only Data :

  • getOReadDataVersion - Returns the "Other Publisher Read Data : Data Version" from the latest "Get Other Publisher Read Data". Indicates the current version of the data that has been set.


Load Publisher Data :

  • retPublisherValue - Returns the "Publisher Data : Value" loaded from the "Load Publisher Data".

  • retPublisherKey - Returns the "Key" of the loaded data.


Load User Publisher Data :

  • retDataValue - Returns the "User Publisher Data : Value" loaded from the "Load User Publisher Data".

  • retDataLastUpdated - Returns the "User Publisher Data : Last Updated" loaded from the "Load User Publisher Data".

  • retDataPermission - Returns the "User Publisher Data : Permission" loaded from the "Load User Publisher Data".

  • retDataKey - Returns the "Key" of the loaded data.


Load User Publisher Read-Only Data :

  • retReadDataValue - Returns the "User Publisher Read Data : Value" loaded from the "Load User Publisher Read Data".

  • retReadDataLastUpdated - Returns the "User Publisher Read Data : Last Updated" loaded from the "Load User Publisher Read Data".

  • retReadDataPermission - Returns the "User Publisher Read Data : Permission" loaded from the "Load User Publisher Read Data".

  • retReadDataKey - Returns the "Key" of the loaded data.


Load Other User Publisher Data :

  • retODataValue - Returns the "Other Publisher Data : Value" loaded from the "Load Other Publisher Data".

  • retODataLastUpdated - Returns the "Other Publisher Data : Last Updated" loaded from the "Load Other Publisher Data".

  • retODataPermission - Returns the "Other Publisher Data : Permission" loaded from the "Load Other Publisher Data".

  • retODataKey - Returns the "Key" of the loaded data.


Load Other User Publisher Read-Only Data :

  • retOReadDataValue - Returns the "Other Publisher Read Data : Value" loaded from the "Load Other Publisher Read Data".

  • retOReadDataLastUpdated - Returns the "Other Publisher Read Data : Last Updated" loaded from the "Load Other Publisher Read Data".

  • retOReadDataPermission - Returns the "Other Publisher Read Data : Permission" loaded from the "Load Other Publisher Read Data".

  • retOReadDataKey - Returns the "Key" of the loaded data.


Server Response :

  • ServerResponse - Return the "Server Response" from every request from the PlayFab Server. The server response can also be shown in the "Chrome Developer Tools : Console", if in "debug mode".

Request :

  • Tag - Return the "Tag" of the latest request.

Publisher:

  • StudioLoad - Return a publisher (studio) data value.

    • Key - The​ key of the publisher (studio) data.​​

Load:

  • OtherLoad - Returns the another user's studio data value.

    • Key - The​ key of another user publisher data.

  • OtherReadLoad - Returns the another user's read-only studio data value.

    • Key - The​ key of another user read-only publisher data.

  • UserLoad - Returns the user's studio data value.

    • Key - The​ key of the user publisher data.

  • UserReadLoad - Returns the user's read-only studio data value.

    • Key - The​ key of the user read-only publisher data.

 

Server Management

The Publisher addon implements both player-specific data read & write for the current publisher (studio), these are then sent to the PlayFab servers and synced to all connected (synced) authentication methods. There are 3 data types,  the studio player datastudio read-only data and the studio internal data

  • Player data - both readable and writable data, customized for each player and can be public or private.

  • Read-only data - exclusively read-only data, customized for each player and can be public or private.

  • Internal data - unreadable and can't be altered from the client or the Publisher plugin. This is a developer exclusive data for the players, which can be very useful for server automation. In cases of needs in alteration of this data, it would then require the Cloud Scripting feature from the PlayFab - Automation console with the Cloud Script plugin calling it from the client (application).

 

Admin privileges allows you to modify each player's data automatically via the Server API automation, Cloud Script or manually using the Admin Console.

Screenshot - 1.png

Step 1 : Login to your PlayFab account, select the title from the studio.

Step 2 : Click on the Players tab. Then the Players list will show. Select a player, then the player overview will open.

Screenshot - 2.png

Step 3 : From the player overview, select the Player Data (Publisher), which will show you the player's  current data.

Player Data.png

Step 4 : To manually modify a player's writable and readable data.

Simply add, change or remove the data from the list. Then finally save changes.

You can control everything here as the administrator.

Player ReadData.png

Step 5 : To manually modify a player's read-only data.

Simply add, change or remove the data from the list. Then finally save changes.

You can control everything here as the administrator.

Internal Data.png

Step 6 : To manually modify a player's internal data.

Simply add, change or remove the data from the list. Then finally save changes.

You can also set all data types from Public to Private. Just like in the plugin.

 
 

Game Project

Sample Setup Project

Specifications

  • Instructions - The sample project has comments and instructions on how to use the addon and its features.

  • A.C.E. Coverage - It covers the implementation of each action, condition and expression.

  • Tips and Tricks - It provides some tips and tricks to a better use of the addon and of the event-sheet system alongside it.

Supporters

Only

Easy Project Sample

Sample Setup Project

Specifications

  • Instructions - The sample project has comments and instructions on how to use the addon and its features.

  • A.C.E. Coverage - It covers the implementation of each action, condition and expression.

  • Tips and Tricks - It provides some tips and tricks to a better use of the addon and of the event-sheet system alongside it.

Supporters

Only

 

Get the tools

for your pro games!

Constuct Master Collection - Itch.io
Constuct Master Collection - Discord
Constuct Master Collection - Construct 3

© Construct Master Collection 2020 • All rights reserved

Contact Information:

Expressions - 1