Extend Google Sheets with Adobe Target Data

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

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 Activities 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 Adobe Target OData services:

Connect to Adobe Target

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

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the Adobe Target connection.
3. Enter the necessary authentication properties to connect to Adobe Target.

   To connect to Adobe Target, you must provide the Tenant property along with OAuth connection properties mentioned below. Note that while other connection properties can influence processing behavior, they do not affect the ability to connect.

   To determine your Tenant name:

   1. Log in to Adobe Experience. The URL will look similar to: "https://experience.adobe.com/#/@mycompanyname/preferences/general-section".
   2. Extract the value after the "/#/@". In this example, it is "mycompanyname".
   3. Set the Tenant connection property to that value.

   User Accounts (OAuth)

   You must set AuthScheme to OAuthClient for all user account flows.

   Note: Adobe authentication via OAuth requires updating your token every two weeks.

   All Applications

   CData provides an embedded OAuth application that simplifies OAuth authentication. Alternatively, you can create a custom OAuth application. Review Creating a Custom OAuth App in the Help documentation for more information.

   Obtaining the OAuth Access Token

   Set the following properties to connect:

   • InitiateOAuth: Set to GETANDREFRESH to automatically perform the OAuth exchange and refresh the OAuthAccessToken as needed.
   • OAuthClientId : Set to the client Id assigned when you registered your app.
   • OAuthClientSecret : Set to the client secret assigned when you registered your app.
   • CallbackURL : Set to the redirect URI defined when you registered your app. For example: https://localhost:3333

   With these settings, the provider obtains an access token from Adobe Target, which it uses to request data. The OAuth values are stored in the location specified by OAuthSettingsLocation, ensuring they persist across connections.

   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your Adobe Target 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.
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:

Creating API Endpoints for Adobe Target

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

1. First, navigate to the API page and then click Add Table .
2. Select the connection you wish to access and click Next.
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm.

Gather the OData Url

Having configured a connection to Adobe Target 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 Adobe Target 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/Activities?select=Id,Id,Name,Type";
  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 activities = JSON.parse(json).value;

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

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