Knowledge base

Allowing Xplenty access to my data on Google Sheets

Xplenty can access your Google Sheets data. This article details creating the Google Sheets connection and the process of building a data pipeline to read Google Sheets data in Xplenty. There are also pre-built templates to read data from a Google Sheet or write data to a Google Sheet. Please see Create a package from a template for instructions on using a template.

To create a Google Sheets connection in Xplenty:

  1. Click the Connections icon (lightning bolt) on the top left menu.
  2. To create a connection, click New connection.

  3. Choose Google Sheets.
  4. Click Authenticate. (If required, sign in to Google Sheets)
  5. Click Connect to authorize Xplenty access to your Google Sheets account.
  6. In the new new Google Sheets connection window, name the connection and click Create Google Sheets connection.

To modify Google Sheets connections in Xplenty:

  1. Click the Connections icon (lightning bolt) on the top left menu.
  2. Click a connection to re-connect if your password has changed or the token has expired.
  3. To delete a Google Sheets connection, click on the three vertical dots on the far right of the connection listing and select the Delete connection option. 

To build a data pipeline to read Google Sheets data in Xplenty:


REST API Component: read_spreadsheet

  • Authentication - Click Connection and then select your Google Sheets connection. If you haven't created your Google Sheets connection yet, click + New and follow the instructions found above. undefined
  • URL - Enter the URL for the Google Sheets API:$spreadsheetId/values/$sheetName. Make sure the method is set to GET. undefined
  • Sheet ID and name - Replace the variables $spreadsheetId and $sheetName with the values specific to your spreadsheet. You can find them located in the URL and at the bottom left.  SheetIDandName.jpg
  • Response - Type $.values[*] in the Base record JSONPath Expression field. * If the first record in your sheet contains field names, type $.values[1:] instead. undefined
  • Input fields - Click Select all to move values over to the Selected fields. Then click Save. undefined

Select Component: bag_to_tuple

  • Pass the values field into the BagToTuple function (for more information on the BagToTuple function see this article) - BagToTuple(values). Click Save. undefined

Select Component: parse_data

  • Parse the individual fields in the Expression column using the tuple syntax - values.$0, values.$1, etc. Assign field names in the Alias column. Click Save. undefined

Destination Component: sheet_data

  • The template shows a Redshift destination component; however, if you'd prefer to use a different destination, delete the Redshift component and select a destination component of your choice. undefined
  • Choose target connection - Select your target connection. If you haven't created your connection yet, click + New. undefined
  • Destination properties - Fill in the values for target schema and table, select an operation type, pre or post-action SQL, and advanced options.
  • Schema mapping - Click Auto-fill to bring in all of the fields. If you've selected a Merge operation type, click the Key box next to the merge key field(s). Click Save. undefined