Extend Google Sheets with Dynamics CRM Data



Make calls to the API Server from Google Apps Script.

Interact with Dynamics CRM data from Google Sheets through macros, custom functions, and add-ons. The CData API Server, when paired with the ADO.NET Provider for Dynamics CRM (or any of 200+ other ADO.NET Providers), enables connectivity to Dynamics CRM data from cloud-based and mobile applications like Google Sheets. The API Server is a lightweight Web application that produces OData services for Dynamics CRM 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 Account data and, as you make changes, executes updates to Dynamics CRM data.

About Dynamics CRM Data Integration

CData simplifies access and integration of live Microsoft Dynamics CRM data. Our customers leverage CData connectivity to:

  • Read and write data in the Dynamics CRM 2011+ Services and Dynamics CRM Online.
  • Extend the native features of Dynamics CRM with customizable caching and intelligent query aggregation and separation.
  • Authenticate securely with Dynamics CRM in a variety of ways, including Azure Active Directory, Azure Managed Service Identity credentials, and Azure Service Principal using either a client secret or a certificate.

CData customers use our Dynamics CRM connectivity solutions for a variety of reasons, whether they're looking to replicate their data into a data warehouse (alongside other data sources) or analyze live Dynamics CRMa data from their preferred data tools inside the Microsoft ecosystem (Power BI, Excel, etc.) or with external tools (Tableau, Looker, etc.).


Getting Started


Set Up the API Server

Follow the steps below to begin producing secure Dynamics CRM 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 Dynamics CRM

After you deploy the API Server and the ADO.NET Provider for Dynamics CRM, provide authentication values and other connection properties needed to connect to Dynamics CRM by clicking Settings -> Connections and adding a new connection in the API Server administration console.

The connection string options meet the authentication and connection requirements of different Dynamics CRM instances. To connect to your instance, set the User and Password properties, under the Authentication section, to valid Dynamics CRM user credentials and set the Url to a valid Dynamics CRM server organization root. Additionally, set the CRMVersion property to 'CRM2011+' or 'CRMOnline'. IFD configurations are supported as well; set InternetFacingDeployment to true.

Additionally, you can provide the security token service (STS) or AD FS endpoint in the STSURL property. This value can be retrieved with the GetSTSUrl stored procedure. Office 365 users can connect to the default STS URL by simply setting CRMVersion.

You can then choose the Dynamics CRM 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 Dynamics CRM 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/Account?select=Id,FirstName,NumberOfEmployees,FirstName"; 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 account = JSON.parse(json).value; var cols = [["Id","FirstName","NumberOfEmployees","FirstName"]]; sheet.getRange(1,1,1,4).setValues(cols); row=2; for(var i in account){ for (var j in account[i]) { switch (j) { case "Id": a1.offset(row,0).setValue(account[i][j]); break; case "FirstName": a1.offset(row,1).setValue(account[i][j]); break; case "NumberOfEmployees": a1.offset(row,2).setValue(account[i][j]); break; case "FirstName": 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 Dynamics CRM 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/Account("+id+")"; var putdata = "{\"@odata.type\" : \"CDataAPI.Account\", \""+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 Dynamics CRM data.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server