Sushi.Mediakiwi.Module.GoogleSheetsSync

A list module for use in Mediakiwi which allows for synchronizing data with GoogleSheets. This Module can be used in two ways.

1. Using a Google Service Account

This is the easiest and fastest way to get started, this will create a shared SpreadSheet for every user of the module, so every user sees the same data. If you want to use this option, take a look at The needed steps for creating Service Account Credentials

Installation steps

• Download the ServiceAccount credentials file from the Google Cloud API explorer.
• Place this file in the Root of your project and set 'Copy to output directory' to always.
• Add this section to your configuration file (appsettings.json) :

"GoogleSheetsSettings": {
  // The relative filename for the ServiceAccount credentials file
  "service-account-filename": "sheetsCredentials.json",
},

2. Using Google OpenID

This is the more advanced way of using the module. This will create a SpreadSheet unique for every user of the module. So if User A exports data to a spreadsheet and edits it, User B will not see those changes, because User B also has a personal version of the exported data at hand. If you want to use this option, take a look at The needed steps for creating a Google Open ID

Installation steps

• Add this section to your configuration file (appsettings.json) :

"GoogleSheetsSettings": {
  // Get this ClientID from the Google Cloud platform
  "client-id": "[GOOGLE-CLIENT-ID]",
  // Get this ClientSecret from the Google Cloud platform
  "client-secret": "[GOOGLE-CLIENT-SECRET]",
  // What is the relative url path to listen to OpenID requests
  "handler-path": "/signin-google",
  // The basis on which writer permission is given, can be one of 'USEREMAIL', 'USERDOMAIN' or 'SETDOMAINS'
  // USEREMAIL: Only the user requesting the Google Sheets creation will get writer permissions. This will send a Google email to the requesting user on every request.
  // USERDOMAIN: Everyone in the same domain as the user requesting the Google Sheets creation will get writer permissions.  
  // SETDOMAINS (default): Everyone in the same domain as the domains listed below will get writer permissions. 
  "permission-base": "SETDOMAINS",
  // Which domains are allowed to edit the produced googlesheets file (will be used ONLY when the permission-base is "SETDOMAINS") ?
  "allowed-domains": [ "supershift.nl", "somedomain.com", "anotherdomain.com" ]
},

• Add these lines to your application startup (Configure) code, before the call to app.UseMediakiwi() :

// Install the OpenID listener (only needed when ClientID and ClientSecret are used)
app.UseGoogleOpenID();

3. Global installation steps

• Add these lines to your services startup (ConfigureServices) code :

// Install all included modules
services.AddGoogleSheetsModules(true, true, true);

This will also create the database table if needed, so the database connectionstring must be known at this point. This can be done with :

MicroORM.DatabaseConfiguration.SetDefaultConnectionString(connString);

Things to note :

• You can also enable only one Module, by setting enableExportModule, enableViewModule or enableImportModule.
• The Import module will only show up if the list has an implementation for the ListDataReceived event.
• The Export module will only show up if the list has the setting for XLS export enabled.
• The View module will only show up when a list has been exported at least once.