How to auto-sync Leaderboard data to Google Sheets
Step 1 – Add the Jsonimport functionality Follow steps 1 to 4 to add the Jsonimport functionality: Step 2 – Prepare your SynthesisVR Leaderboard URL Step 3 – Create a new Google Sheets file Add 3 empty sheets: SynthesisData: Copy/paste the following formula under A1: Don’t forget to replace 11111111-1111-1111-1111-111111111111 with your actual Synthesis API key. AnalyzedData: Copy/paste the following formula under A1: PublicView: Copy/paste the following formula under A1: Copy/paste the following formula under C1: Step 4 – Enable the automated Google Sheets hourly synchronization Under Google Sheets, click on “File” and select “Settings”. Switch to the “Calculation” tab and switch the “Recalculation” period to “On change and every hour”. Step 5 – Manage the Sheet permissions For the SynthesisData and AnalyzedData Sheets – click the down arrow next to the name and select the “Hide” option: You can now share the Leaderboard publicly. Make sure people not belonging to your organization are not allowed to make changes to the file.
Leaderboard Add-on – Getting Started
Installation: Under SynthesisVR Web Administration portal, navigate to “Administration >> Arcade Setup >> SynthesisVR Subscriptions” and get your stations subscribed for “Leaderboard Application” (it is free for stations that are already subscribed for the full SynthesisVR version). Note: If you are offering Project CARS Pro, you have to also subscribe for the “Project CARS Pro Leaderboard” plugin. Upon subscription, click the Refresh button for all your Access Point instances Go to https://games.synthesisvr.com/games/synthesisvr-leaderboard and click the “Install SynthesisVR Leaderboard” button. The application can be installed on ANY Windows based PC in your local area network. Run the installer, follow the steps and launch the application. You are presented with an option to install Plugins. Do that for the games you are offering. Optional: Go to “Administration >> Games & Licensing >> Your Games”. Find one of the supported games and click on it. Under the popup, switch to the “Plugins” tab and install the “Customer Name” plugin. This will allow you to click on the station name under the “Your Arcade” page and change the customer name on the fly (doesn’t require a running session).
Reading Leaderboard Through API
To programatically read the leaderboard data collected by SynthesisVR, please follow the steps: 1. Login into SynthesisVR with your administrator account and navigate to: 2. Head to the API & Webhooks tab and click on the + button on the top right: Make sure the leaderboard permission is assigned.If the “Strict Access” option is enabled, you will be able to access the collected data ONLY from an IP address associated with your location. 3. Prepare the following URL: Example: Upon refreshing the Widgets page, you’ll be able to locate your API key: Game ID — keep it to 0 (zero) if you want to fetch information about all the collected games. Based on that response, you’ll be able to see and use specific game idsDuration — any combination of <number> + <period>. Examples: The API response data is formatted as JSON and have the following structure: The “score” object itself contains:info = raw data extracted from the game (differ between the games)score = SVR attempt to recognize and extract the score from the info objectcustomer = the customer associated with the SynthesisVR session. In a multi-station session, the data don’t necessary correlate with the actual player.utcepoch = the UTC epoch when the leaderboard record is logged (you can look up the exact date/time in any programming language ; online example: https://www.epochconverter.com/)