See the supported connectors for Application Integration.

Sheets - Get task

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

The Sheets - Get task lets you read and retrieve a single range of values from a Google spreadsheet.

Spreadsheet: The primary object in Google Sheets that can contain multiple sheets. Each sheet has structured information contained in cells.

You can find the ID of your spreadsheet from its web URL. For example, https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit#gid=0

Google Sheets is one of the many cloud-based productivity solutions in Google Workspace. It allows you to create and edit online spreadsheets with real-time collaboration functionality.

Before you begin

Ensure that you perform the following tasks in your Google Cloud project before configuring the Sheets - Get task:

1. Enable the Google Sheets API (sheets.googleapis.com).

   Enable the Google Sheets API

2. Create an authentication profile of type Service account. Application Integration uses an authentication profile (Service account) to connect to an authentication endpoint for the Sheets - Get task.

   For information about granting additional roles or permissions to a service account, see Granting, changing, and revoking access.

3. In Google sheets, grant the service account the permission to access the spreadsheet.
4. Understand and learn about the common terminologies used in Google Sheet.

Configure the Sheets - Get task

1. In the Google Cloud console, go to the Application Integration page.

   Go to Application Integration

2. In the navigation menu, click Integrations.

   The Integrations page appears listing all the integrations available in the Google Cloud project.

3. Select an existing integration or click Create integration to create a new one.

   If you are creating a new integration:

   1. Enter a name and description in the Create Integration pane.
   2. Select a region for the integration.
      Note: The Regions dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, Click Enable Region. See Enable new region for more information.
   3. Select a service account for the integration. You can change or update the service account details of an integration any time from the Integration summary pane in the integration toolbar.
      Note: The option to select a service account is displayed only if you have enabled integration governance for the selected region.
   4. Click Create.

   This opens the integration in the integration editor.

4. In the integration editor navigation bar, click Tasks to view the list of available tasks and connectors.
5. Click and place the Sheets - Get element in the integration editor.
6. Click the Sheets - Get element on the designer to view the Sheets - Get task configuration pane.
7. Go to Authentication, and select an existing authentication profile that you want to use.

   Optional. If you have not created an authentication profile prior to configuring the task, Click + New authentication profile and follow the steps as mentioned in Create a new authentication profile.

8. Go to Task Input, and configure the displayed inputs fields using the following Task input parameters table.

   Changes to the inputs fields are saved automatically.

Task input parameters

The following table describes the input parameters of the Sheets - Get task:

Property	Data type	Description
SpreadsheetId	String	The ID of your spreadsheet. You can find the ID of your spreadsheet from its web URL. For example, https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit#gid=0
MajorDimension	enum (Dimension)	The primary category or dimension that should be applied. For example, ROWS or COLUMNS. Default value: DIMENSION_UNSPECIFIED
Range	String	The A1 notation or R1C1 notation of the range to retrieve values from.
dateTimeRenderOption	enum (DateTimeRenderOption)	Indicates how values related to date, time, and duration is represented in the output. Note: dateTimeRenderOption is not considered if the value specified for valueRenderOption is FORMATTED_VALUE. Default value: SERIAL_NUMBER
ValueRenderOption	enum (ValueRenderOption)	Indicates how the retrieved values are represented in the output. Default value: FORMATTED_VALUE

Task output

The Sheets - Get task returns the response output containing a ValueRange object corresponding to the requested range. Following is a sample output:

    {
        "range": "Sheet1!A1:D5",
        "majorDimension": "ROWS",
        "values": [
          ["Item", "Cost", "Stocked", "Ship Date"],
          ["Wheel", "$20.50", "4", "42430"],
          ["Door", "$15", "2", "42444"],
          ["Engine", "$100", "1", "42449"],
          ["Totals", "=SUM(B2:B4)", "=SUM(C2:C4)", "=MAX(D2:D4)"]
        ],
      }

Error handling strategy

An error handling strategy for a task specifies the action to take if the task fails due to a temporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see Error handling strategies.

Quotas and limits

For information about quotas and limits, see Quotas and limits.

What's next

• Add edges and edge conditions.
• Test and publish your integration.
• Configure a trigger.
• Add a Data Mapping task.
• See all tasks for Google Cloud services.