Extend Google Sheets with Oracle Eloqua Reporting Data

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

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 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 Oracle Eloqua Reporting OData services:

Connect to Oracle Eloqua Reporting

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

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

   Oracle Eloqua Reporting supports the following authentication methods:

   • Basic authentication (User and Password)
   • OAuth 2.0 code grant flow
   • OAuth 2.0 password grant flow

   Basic Authentication (User and Password)

   To perform authentication with a user and password, specify these properties:

   • AuthScheme: Basic.
   • Company: The company name associated with your Oracle Eloqua Reporting account.
   • User: Your login account name.
   • Password: Your login password.

   OAuth Authentication (Code Grant Flow)

   To authenticate with the OAuth code grant flow, you must set AuthScheme to OAuth and create a custom OAuth application. For information about how to create a custom OAuth application, see the Help documentation.

   Then set the following properties:

   • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
   • OAuthClientId: The client Id assigned when you registered your application.
   • OAuthClientSecret: The client secret that was assigned when you registered your application.
   • CallbackURL: The redirect URI that was defined when you registered your application.

   When you connect, the driver opens Oracle Eloqua Reporting's OAuth endpoint in your default browser. Log in and grant permissions to the application. When the access token expires, the driver refreshes it automatically.

   OAuth Authentication (Password Grant Flow)

   With the OAuth password grant flow, you can use your OAuth application's credentials alongside your user credentials to authenticate without the need to grant permission manually via a browser prompt. You must create an OAuth app (see the Help documentation) to use this authentication method.

   Set the following properties:

   • AuthScheme: OAuthPassword
   • Company: The company's unique identifier.
   • User: Your login account name.
   • Password: Your login password.
   • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
   👁 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 Oracle Eloqua Reporting 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 Oracle Eloqua Reporting

Having created a user, you are ready to create API endpoints for the Oracle Eloqua Reporting 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 Oracle Eloqua Reporting 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:

Retrieve Oracle Eloqua Reporting 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/?select=Id,,,";
 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 = JSON.parse(json).value;

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

 row=2;
 for(var i in ){
 for (var j in [i]) {
 switch (j) {
 case "Id":
 a1.offset(row,0).setValue(account[i][j]);
 break;
 case "":
 a1.offset(row,1).setValue(account[i][j]);
 break;
 case "":
 a1.offset(row,2).setValue(account[i][j]);
 break;
 case "":
 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.

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.