Google Sheets Connector

Perform various operations such as creating, deleting, and updating spreadsheets and their contents.

Overview

The Google Sheets Connector in Rayven allows users to interact with Google Sheets to perform various operations such as creating, deleting, and updating spreadsheets and their contents. This document outlines how to utilize the Google Sheets connector effectively, including operations for managing documents and sheets within those documents.

Google Sheets Document Operations

1. Creating a Spreadsheet

To create a new spreadsheet, follow these steps:

• Parameters:

  • Credential to Connect With: Create or select existing Google Sheets credentials.
  • Resource: Select "Document."
  • Operation: Select "Create."
  • Title: Enter the desired title for the new spreadsheet.
  • Sheets: Add titles for the sheets you want to create within the spreadsheet.

• Options:

  • Locale: Enter the locale for the spreadsheet, affecting formatting for functions, dates, and currency. Use formats such as:
    • en for English
    • fil for Filipino
    • en_US for English (United States)
  • Recalculation Interval: Specify how often functions like NOW, TODAY, and RAND are updated. Options include:
    • On Change
    • Minute
    • Hour

For more details, refer to the Google Sheets API documentation.

2. Deleting a Spreadsheet

To delete an existing spreadsheet:

• Parameters:
  • Credential to Connect With: Create or select existing Google Sheets credentials.
  • Resource: Select "Document."
  • Operation: Select "Delete."
  • Document: Choose the spreadsheet to delete, with options to select from a list, by URL, or by ID (found in the Google Sheets URL).

Refer to the Google Drive API documentation for more information.

Google Sheets Sheet Within Document Operations

3. Appending or Updating a Row

To append a new row or update an existing one:

• Parameters:

  • Credential to Connect With: Create or select existing Google Sheets credentials.
  • Resource: Select "Sheet Within Document."
  • Operation: Select "Append or Update Row."
  • Document: Choose the spreadsheet containing the target sheet.
  • Sheet: Select the target sheet.

• Mapping Column Mode:

  • Map Each Column Manually: Specify values for each column.
  • Map Automatically: Automatically match incoming data fields to columns in Google Sheets.
  • Nothing: Do not map any data.

• Options:

  • Cell Format: Choose how to format the data in cells.
  • Data Location on Sheet: Specify the data range on the sheet.
  • Handling Extra Fields in Input: Choose how to manage extra fields not matching existing columns (Insert in New Column(s), Ignore Them, or Error).

Refer to the Google Sheets API documentation for more details.

4. Appending a Row

To append a new row to a sheet:

• Parameters:
  • Same as "Appending or Updating a Row" but select "Append Row" for the operation.

5. Clearing a Sheet

To clear all data from a specific sheet:

• Parameters:
  • Operation: Select "Clear."
  • Clear Options: Choose to clear the whole sheet, specific rows, columns, or a specific range.

Refer to the Google Sheets API documentation for more details.

6. Creating a New Sheet

To create a new sheet within a spreadsheet:

• Parameters:

  • Operation: Select "Create."
  • Title: Enter the desired title for the new sheet.

• Options:

  • Hidden: Keep the sheet hidden in the UI.
  • Right To Left: Use RTL layout instead of LTR.
  • Tab Color: Specify the tab color using hex code.

Refer to the Google Sheets API documentation for more details.

7. Deleting a Sheet

To permanently delete a sheet from a spreadsheet:

• Parameters:
  • Operation: Select "Delete."
  • Sheet: Choose the sheet to delete.

Refer to the Google Sheets API documentation for more details.

8. Deleting Rows or Columns

To delete rows or columns in a sheet:

• Parameters:
  • Operation: Select "Delete Rows or Columns."
  • Start Row Number or Start Column: Specify where to start deleting.
  • Number of Rows or Columns to Delete: Specify how many to delete.

Refer to the Google Sheets API documentation for more details.

9. Getting Row(s)

To read one or more rows from a sheet:

• Parameters:

  • Operation: Select "Get Row(s)."
  • Filters: Set filters to limit results (e.g., by column and value).

• Options:

  • Output Formatting: Choose how to format returned data (formatted values, formulas, etc.).

Refer to the Google Sheets API documentation for more details.

10. Updating a Row

To update an existing row in a sheet:

• Parameters:

  • Operation: Select "Update Row."

• Mapping Column Mode: Same as for appending or updating a row.

Refer to the Google Sheets API documentation for more details.

Google Credentials

When using the Google Sheets connector, you will need to authenticate using Google credentials. There are two main authentication methods:

1. OAuth2: Recommended for most users, as it is widely available and easy to set up.
2. Service Account: Useful for specific service nodes. Refer to the Google documentation for more guidance.

Note for Google Cloud Users

You can authenticate by selecting "Sign in with Google" for relevant Google services.

Compatible Nodes

Once configured, your Google Sheets credentials can be used to authenticate various nodes, enabling seamless interactions with Google Sheets.

---

This document provides a comprehensive guide on how to use the Google Sheets connector in Rayven, including the operations available and parameters required. If you have any further questions or need additional information, feel free to ask!