Live Update

Description

Live update addon let you update database data on player's devices using the data from Google Sheets, using public GoogleSheets Json API. Export to google sheets is not supported.

Restrictions

  1. WebGl platform requires special setup (read below)
  2. Do not use this addon to update critical data. There is a chance some users won't be able to download updates (due to network issues for example).
  3. Plugin uses formatted values, not raw value. If you use numeric fields, please, make sure formatted value for these fields are the same as raw values (you may need to change cells formatting)

DataSource types

DataSource type-> GoogleSheets API Visualization API Excel file export
URL to retrieve data https://sheets.googleapis.com/v4/spreadsheets/[Your Spreadsheet Id]/values/[Table Name]?key=[Your API key] https://docs.google.com/spreadsheets/d/[Your Spreadsheet Id]/gviz/tq?tqx=out:csv&sheet=[Table Name] https://docs.google.com/spreadsheets/d/[Your Spreadsheet Id]/export
Number of network calls 1 * number of tables 1 * number of tables 1
Pros Official recommended method Do not require any credentials
  1. Do not require any credentials
  2. Fastest method if you update several tables, cause it uses one single network call to obtain all data
Cons
  1. API calls have free usage limits. Read more here. If you reach the limit, GoogleSheets will not return correct feed and LiveUpdate plugin will fail.
  2. API key is exposed, cause database stores the value
  1. It's not clear if Google can consider it as API abuse and ToS violation
  1. It's not clear if Google can consider it as API abuse and ToS violation
  2. Require special setup
  3. Not working on WEBGl platform
Special setup None None
  1. Move Assets\BansheeGz\BGDatabase\Editor\Libs\NPOI folder to any folder, which is not under "Editor" folder
  2. Select all DLLs in NPOI folder and mark them to be compatible with "Any platform"
  3. Download and import this package

How it works

  1. First time your game is launched and database is loaded, it'll try to read data from Google Sheets. Alternatively set "Manual load" parameter on and trigger loading manually from script at any moment
  2. If step 1 is successful, every time database is loaded, it will be merged with data from Google Sheets, thus applying the update.
  3. If step 1 is unsuccessful, database data will remain intact.

Setting up

  1. Enable LiveUpdate plugin (under addons->LiveUpdate)
  2. Choose DataSource type (GoogleSheets API/Visualization API/Excel file export)
  3. Get Spreadsheet Id from Google. Assign it to Spreadsheet Id LiveUpdate addon parameter
  4. If you chose GoogleSheets API, get "API key" from Google. Assign it to API key LiveUpdate addon parameter
  5. Make sure to share target spreadsheet. Open target spreadsheet, click on Share button on the top right and set access level to "public" or "people with link". Otherwise plugin won't work.
  6. Google sheets data should have proper layout (as described here). Starting with v.1.5.13 _id column/ID value are not required anymore _id column with valid IDs are required

Checking if setup was correct

You can check if you set up config properly by accessing specific URL from your browser without logging to Google account. Each DataSource type uses it's own URL (listed in the table above), so try to access the data with corresponding URL
For example, GoogleSheets API datasource type uses this URL to access the data https://sheets.googleapis.com/v4/spreadsheets/[Your Spreadsheet Id]/values/[Name of one of your meta]?key=[Your API key] , so for the following parameters
  1. SpreadsheetId=MYko0fxH01GIJcBq41YAT9eFpU6Znm5I5RByHsJpupHZ
  2. ApiKey=RYIzaSyB0xsc_BoOBNRHfhW9xpCx1t03a-gV6qc
  3. Meta=Items
the URL to check will be : This is not a working example, it's just an example how to substitute parameters.

WEBGL/Asynchronous setup

[BGDatabase version >=1.5.2 is required] WEBGL platform does not allow to update data synchronously. So it updates data asynchronously, over several frames. It means data should be preloaded before it can be accessed. Alternative way to load data asynchronously is to toggle on "Force asynchronous" parameter.

Here are the required steps:

  1. Make sure to toggle "Manual Load" parameter on
  2. Download this preloader script and attach it to any GameObject in your starting scene
  3. Once LiveUpdate plugin finishes downloading data, LiveUpdatePreloader.Ready method will be called. Make sure to not access database until this moment
  4. Preloader should work on any platform, no need to write platform specific code

Parameters

Parameter name Description
Spreadsheet Id Id of your spreadsheet. Learn how to obtain it here
API key API key to use for GoogleSheets API datasource type. Learn how to create it here
Timeout Timeout for connection. Value (in seconds) is between 1-30, default is 5
Manual Load Set it to true if you do not want this addon to be executed automatically. In this case, you will need to manually trigger the loading by calling
BGRepo.I.Addons.Get<BGAddonLiveUpdate>().Load(true);
In Builds Only Setting this to true will disable addon if your game is run in Editor. It will work in builds only. It is recommended to set it to true as soon as you are sure the addon works correctly.
Force asynchronous If set to true, data loader will use asynchronous loader, which does not block main thread and loads data over several frames. WEBGl platform ignores this parameter, cause it does not support synchronous loader and uses asynchronous loader by default
Merge Settings The same merge settings you use for Export/Import or Saving/Loading. Learn more about merge settings here
Log level level of details to be used while gathering log information. Logs messages are gathered while addon tries to read information from GoogleSheets
Print log on load If set to true, log will be printed to Unity console after load attempt
Value resolver type Full C# type name to be used to convert GoogleSheets values to another format. This type should implement BansheeGz.BGDatabase.BGLiveUpdateValueResolver interface. For example, you could use currency formatted values inside GoogleSheet for int fields ($5,200). To properly read such values you need to convert them to valid int values ($5,200->5200). Here is an example implementation of such type, which do such conversion.