Skip to content
Nappai Documentation

Google Spread Sheet

Manage Google Sheets directly from your Nappai dashboard

How it Works

The Google Spread Sheet component talks to Google’s Sheets API. When you add it to a workflow, you first choose a Google Sheets API credential that you created in Nappai’s credentials section. The component then uses that credential to call the Sheets API and perform the operation you selected. All the data you see in the dashboard is just a convenient way to set the parameters for those API calls.

Operations

This component offers several operations that you can select based on what you need to do. You can only use one operation at a time:

  • Create SpreadSheet: Create a brand‑new Google Spreadsheet.
  • Create Sheet: Add a new sheet (tab) inside an existing spreadsheet.
  • Get: Retrieve data from a spreadsheet or a specific sheet.
  • Update: Modify the name of a spreadsheet or a sheet.
  • Duplicate SpreadSheet: Make a copy of an existing spreadsheet.
  • Clear: Remove all data from a sheet.
  • Delete: Remove a sheet or an entire spreadsheet.

To use the component, first select the operation you need in the “Operation” field.

Inputs

Mapping Mode

This component has a special mode called “Mapping Mode”. When you enable this mode using the toggle switch, an additional input called “Mapping Data” is activated, and each input field offers you three different ways to provide data:

  • Fixed: You type the value directly into the field.
  • Mapped: You connect the output of another component to use its result as the value.
  • Javascript: You write Javascript code to dynamically calculate the value.

This flexibility allows you to create more dynamic and connected workflows.

Input Fields

The following fields are available to configure this component. Each field may be visible in different operations:

  • Select Spreadsheet: Choose the Google Spreadsheet you want to work with. In the Get operation, if this field is empty, all sheets will be returned.

    • Visible in: Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

  • Operation: Pick the action you want to perform.

    • Visible in: Create SpreadSheet, Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

  • Include Data: Tell the component to return the actual cell data when you use the Get operation.

    • Visible in: Get

  • Mapping Mode: Enable mapping mode to process multiple data records in batch.

    • Visible in: Create SpreadSheet, Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

  • Mode of Input: Decide how the component receives the spreadsheet reference.

    • Visible in: Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

  • New Spreadsheet Name: Provide a name for a new spreadsheet when you update or duplicate.

    • Visible in: Update, Duplicate SpreadSheet

  • Select Sheet: Pick a specific sheet to work with. If “All SpreadSheet” is selected, all sheets will be used in the operation.

    • Visible in: Get, Clear, Delete

  • Sheet Name: Name that will be used for the new sheets you create.

    • Visible in: Create SpreadSheet, Create Sheet

  • Spreadsheet ID: The unique ID of the spreadsheet you want to target. In the Get operation, if this field is empty, all sheets will be returned.

    • Visible in: Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

  • Spreadsheet Name: Name that will be used in the spreadsheet when you create a new one.

    • Visible in: Create SpreadSheet

  • Tool Name: The name of the tool that will be used when this component is connected as a tool. This name will be displayed to the agent when it selects tools to use.

    • Visible in: Create SpreadSheet, Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

  • Tool Description: A detailed description of what this tool does. This description will help the agent understand when and how to use this tool effectively.

    • Visible in: Create SpreadSheet, Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

  • Tools arguments metadata: Defines the arguments metadata for the tools.

    • Visible in: Create SpreadSheet, Create Sheet, Get, Update, Duplicate SpreadSheet, Clear, Delete

Note: The component also has a Credential input where you select the Google Sheets API credential you created in Nappai’s credentials section.

  1. First, set up the “Google Sheets API” credential in the Credentials area of Nappai.
  2. Then, choose that credential in the “Credential” field of this component.
    The credential requires a Client Id, Client Secret, and Spreadsheet read access, but these details are handled automatically and do not appear in the Input Fields list.

Outputs

  • Data: The raw data returned from the Google Sheets API (used by other components or for display).
  • Tool: A tool representation that can be used by Nappai agents to perform the selected operation.

Usage Example

Scenario 1 – Create a new spreadsheet

  1. Drag the Google Spread Sheet component onto the canvas.
  2. Set Operation to Create SpreadSheet.
  3. Enter a Spreadsheet Name (e.g., “Quarterly Report”).
  4. (Optional) Set Tool Name and Tool Description if you want the component to act as a tool for agents.
  5. Click Run.
    The component will create a new spreadsheet and return its ID and name in the Data output.

Scenario 2 – Get data from a sheet

  1. Add the component and choose Operation = Get.
  2. Select the spreadsheet in Select Spreadsheet or leave it blank to get all sheets.
  3. Choose a specific sheet in Select Sheet or leave it blank to get all sheets.
  4. Check Include Data to retrieve cell values.
  5. Run the component.
    The Data output will contain the requested sheet data.
  • Google Drive Component – Manage files and folders in Google Drive.
  • Google Sheets API Credential – Create and manage the credentials needed for this component.

Tips and Best Practices

  • Keep your Google Sheets API credential secure; never share the Client Id or Client Secret.
  • Use Mapping Mode when you need to process many rows or sheets in a single run.
  • When using the Get operation, leave Select Spreadsheet empty only if you really need all sheets; otherwise, specify a spreadsheet to reduce API calls.
  • The Tool Name and Tool Description fields are useful when you want agents to choose this component automatically.

Security Considerations

  • The component relies on a Google Sheets API credential. Ensure that the credential has the minimum permissions required (e.g., read‑only access if you only need to read data).
  • Do not expose the credential details in logs or outputs.
  • Use Nappai’s built‑in credential management to keep secrets out of your workflow definitions.