Extend Google Sheets with Salesforce Marketing Data



Make calls to the API Server from Google Apps Script.

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

Set Up the API Server

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

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

Authenticating to the Salesforce Marketing Cloud APIs

Set the User and Password to your login credentials, or to the credentials for a sandbox user if you are connecting to a sandbox account.

Connecting to the Salesforce Marketing Cloud APIs

By default, the data provider connects to production environments. Set UseSandbox to true to use a Salesforce Marketing Cloud sandbox account.

The default Instance is s7 of the Web Services API; however, if you use a different instance, you can set Instance.

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

Ready to get started?

Learn more or sign up for a free trial:

CData API Server