Sheets - Append task

The Sheets - Append task lets you append data after a specified table of data in a Google spreadsheet. New values are appended to the new row that is created after the specified table, starting with the first column of the table.

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 - Append task:

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

    Enable the Google Sheets API

  2. Create an authentication profile. Apigee Integration uses an authentication profile to connect to an authentication endpoint for the Sheets - Append task.

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

  3. Understand and learn about the common terminologies used in Google Sheet.

Configure the Sheets - Append task

  1. In the Apigee UI, select your Apigee Organization.
  2. Click Develop > Integrations.
  3. Select an existing integration or create a new integration by clicking Create Integration.

    If you are creating a new integration:

    1. Enter a name and description in the Create Integration dialog.
    2. Select a Region for the integration from the list of supported regions.
    3. Click Create.

    This opens the integration in the integration designer.

  4. In the integration designer navigation bar, click +Add a task/trigger > Tasks to view the list of available tasks.
  5. Click and place the Sheets - Append element in the integration designer.
  6. Click the Sheets - Append element on the designer to view the Sheets - Append 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 - Append 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

Range String The A1 notation of a range to search for the desired table in the sheet.
IncludeValuesInResponse Boolean Indicates if the returned object should include the values of the cells that were appended values.
InsertDataOption enum (InsertDataOption) Indicates how the existing data will be changed when the new data is appended.
ValueInputOption enum (ValueInputOption) Indicates how the data is interpreted.

Default value: INPUT_VALUE_OPTION_UNSPECIFIED

ResponseDateTimeRenderOption enum (DateTimeRenderOption) Indicates how values related to date, time, and duration is represented in the output.

Default value: SERIAL_NUMBER

ResponseValueRenderOption enum (ValueRenderOption) Indicates how the retrieved values are represented in the output.

Default value: FORMATTED_VALUE

Request JSON The request body is a ValueRange object that describes range values to write. See request JSON structure.

Task output

The Sheets - Append task returns the response output containing a AppendValuesResponse object, similar to the following sample output:

    {
        "spreadsheetId": SPREADSHEET_ID,
        "tableRange": "Sheet1!A1:D2",
        "updates": {
          "spreadsheetId": SPREADSHEET_ID,
          "updatedRange": "Sheet1!A3:D4",
          "updatedRows": 2,
          "updatedColumns": 4,
          "updatedCells": 8,
        }
      }

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.

What's next

  1. Add edges and edge conditions.
  2. Test and publish your integration.
  3. Configure a trigger.
  4. Add a Data Mapping task.
  5. See all tasks for Google Cloud services.