Extend Google Sheets with Kintone Data

Interact with Kintone data from Google Sheets through macros, custom functions, and add-ons. The CData API Server enables connectivity to Kintone data from cloud-based and mobile applications like Google Sheets. The API Server is a lightweight Web application that produces OData services for Kintone.

Google Apps Script can consume these OData services in the JSON format. This article shows how to create a simple add-on that populates a Google Spreadsheet with Comments data and, as you make changes, executes updates to Kintone data.

Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure Kintone OData services:

Connect to Kintone

To work with Kintone data from Google Sheets, we start by creating and configuring a Kintone connection. Follow the steps below to configure the API Server to connect to Kintone data:

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the Kintone connection. 👁 Selecting a data source (SQLite is shown)
   
3. Enter the necessary authentication properties to connect to Kintone.

   In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

   • Url: The URL of your account.
   • GuestSpaceId: Optional. Set this when using a guest space.

   Authenticating with Kintone

   Kintone supports the following authentication methods.

   Using Password Authentication

   You must set the following to authenticate:

   • User: The username of your account.
   • Password: The password of your account.

   Using Basic Authentication

   If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

   Using Client SSL

   Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

   👁 Connecting to a datasource (SQLite is shown)
   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your Kintone data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

1. On the Users page, click Add User to open the Add User dialog.
2. Next, set the Role, Username, and Privileges properties and then click Add User. 👁 Configure a new user
   
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page: 👁 API Server user settings
   

Creating API Endpoints for Kintone

Having created a user, you are ready to create API endpoints for the Kintone tables:

1. First, navigate to the API page and then click Add Table . 👁 Add tables
   
2. Select the connection you wish to access and click Next. 👁 Select the connection (SQLite is shown)
   
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm. 👁 Adding tables from the connection (SQLite is shown)
   

Gather the OData Url

Having configured a connection to Kintone data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

👁 API Endpoints

Retrieve Kintone Data

Open the Script Editor from your spreadsheet by clicking Tools -> Script Editor. In the Script Editor, add the following function to populate a spreadsheet with the results of an OData query:

function retrieve(){
 var url = "https://MyUrl/api.rsc/Comments?select=Id,CreatorName,Text,AppId";
 var response = UrlFetchApp.fetch(url,{
 headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
 }); 
 var json = response.getContentText();
 var sheet = SpreadsheetApp.getActiveSheet();
 var a1 = sheet.getRange('a1');
 var index=1;
 var comments = JSON.parse(json).value;

 var cols = [["Id","CreatorName","Text","AppId"]]; 
 sheet.getRange(1,1,1,4).setValues(cols);

 row=2;
 for(var i in comments){
 for (var j in comments[i]) {
 switch (j) {
 case "Id":
 a1.offset(row,0).setValue(account[i][j]);
 break;
 case "CreatorName":
 a1.offset(row,1).setValue(account[i][j]);
 break;
 case "Text":
 a1.offset(row,2).setValue(account[i][j]);
 break;
 case "AppId":
 a1.offset(row,3).setValue(account[i][j]);
 break;
 } 
 }
 row++;
 }
}

Follow the steps below to add an installable trigger to populate the spreadsheet when opened:

1. Click Resources -> Current Project's Triggers -> Add a New Trigger.
2. Select retrieve in the Run menu.
3. Select From Spreadsheet.
4. Select On open.

After closing the dialog, you are prompted to allow access to the application.

Post Changes to Kintone Data

Add the following function to post changes to cells back to the API Server:

function buildReq(e){
 var sheet = SpreadsheetApp.getActiveSheet();
 var changes = e.range;
 var id = sheet.getRange(changes.getRow(),1).getValue();
 var col = sheet.getRange(1,changes.getColumn()).getValue();
 
 var url = "http://MyServer/api.rsc/Comments("+id+")";
 var putdata = "{\"@odata.type\" : \"CDataAPI.Comments\", \""+col+"\": \""+changes.getValue()+"\"}";;
 UrlFetchApp.fetch(url,{
 method: "put",
 contentType: "application/json",
 payload: putdata,
 headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
 });

}

Follow the steps below to add the update trigger:

1. Click Resources -> Current Project's Triggers.
2. Select buildReq in the Run menu.
3. Select From Spreadsheet.
4. Select On edit.

You can test the script by clicking Publish -> Test as Add-On. Select the version, installation type, and spreadsheet to create a test configuration. You can then select and run the test configuration.

As you make changes to cells, the API Server executes updates to Kintone data.