Model Context Protocol (MCP) finally gives AI models a way to access the business data needed to make them really useful at work. CData MCP Servers have the depth and performance to make sure AI has access to all of the answers.
Try them now for free →
Extend Google Sheets with Smartsheet Data
Make calls to the API Server from Google Apps Script.
Interact with Smartsheet data from Google Sheets through macros, custom functions, and add-ons. The CData API Server, when paired with the ADO.NET Provider for Smartsheet (or any of 200+ other ADO.NET Providers), enables connectivity to Smartsheet data from cloud-based and mobile applications like Google Sheets. The API Server is a lightweight Web application that produces OData services for Smartsheet and any source supported by the CData ADO.NET Providers.
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 Sheet_Event_Plan_Budget data and, as you make changes, executes updates to Smartsheet data.
About Smartsheet Data Integration
CData provides the easiest way to access and integrate live data from Smartsheet. Customers use CData connectivity to:
- Read and write attachments, columns, comments and discussions.
- View the data in individuals cells, report on cell history, and more.
- Perform Smartsheet-specific actions like deleting or downloading attachments, creating, copying, deleting, or moving sheets, and moving or copying rows to another sheet.
Users frequently integrate Smartsheet with analytics tools such as Tableau, Crystal Reports, and Excel. Others leverage our tools to replicate Smartsheet data to databases or data warehouses.
Getting Started
Set Up the API Server
Follow the steps below to begin producing secure Smartsheet OData services:
Deploy
The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.
The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.
Connect to Smartsheet
After you deploy the API Server and the ADO.NET Provider for Smartsheet, provide authentication values and other connection properties needed to connect to Smartsheet by clicking Settings -> Connections and adding a new connection in the API Server administration console.
Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.
You can then choose the Smartsheet entities you want to allow the API Server to access by clicking Settings -> Resources.
Authorize API Server Users
After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address: Connections from all addresses except localhost are blocked by default, so you will need to allow connections from Google's servers for this article. You can authenticate as well as encrypt connections with SSL.
Retrieve Smartsheet 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/Sheet_Event_Plan_Budget?select=Id,TaskName,Progress,Assigned";
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 sheet_event_plan_budget = JSON.parse(json).value;
var cols = [["Id","TaskName","Progress","Assigned"]];
sheet.getRange(1,1,1,4).setValues(cols);
row=2;
for(var i in sheet_event_plan_budget){
for (var j in sheet_event_plan_budget[i]) {
switch (j) {
case "Id":
a1.offset(row,0).setValue(account[i][j]);
break;
case "TaskName":
a1.offset(row,1).setValue(account[i][j]);
break;
case "Progress":
a1.offset(row,2).setValue(account[i][j]);
break;
case "Assigned":
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:
- Click Resources -> Current Project's Triggers -> Add a New Trigger.
- Select retrieve in the Run menu.
- Select From Spreadsheet.
- Select On open.
After closing the dialog, you are prompted to allow access to the application.
Post Changes to Smartsheet 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/Sheet_Event_Plan_Budget("+id+")";
var putdata = "{\"@odata.type\" : \"CDataAPI.Sheet_Event_Plan_Budget\", \""+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:
- Click Resources -> Current Project's Triggers.
- Select buildReq in the Run menu.
- Select From Spreadsheet.
- 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 Smartsheet data.
