Google Sheets

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Enabled by default.
  • Authentication: OAuth 2.0.
  • Connection: A user authorizes the connection in the provider's consent screen.
  • Scopes: https://www.googleapis.com/auth/spreadsheets, https://www.googleapis.com/auth/drive.readonly, https://www.googleapis.com/auth/drive.file.

Credentials

Set these per environment. See Connect an integration.

These variables are required only when you supply your own OAuth app. If a managed app is available, you can connect without setting them. Provider permissions and consent still apply.

VariableRequiredDescription
GOOGLE_CLIENT_IDYesGoogle OAuth Client ID Docs.
GOOGLE_CLIENT_SECRETYesGoogle OAuth Client Secret Docs.

Setup

  1. Choose who owns the Google OAuth app: On hosted Veryfront, Google Sheets uses the Veryfront-managed Google OAuth app: connect Google Sheets from the project's integrations and approve the Google consent screen, no environment variables needed. Set GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET only to use your own Google OAuth app, which is required for local and self-hosted runs.
  2. Enable the Google Sheets API: In the Google Cloud project that owns your OAuth app, enable the Google Sheets API.
  3. Enable the Google Drive API: In the Google Cloud project that owns your OAuth app, enable the Google Drive API.
  4. Configure the OAuth consent screen: Configure the consent screen and add the scopes this connector requests. While the app's publishing status is Testing, only the test users you list can authorize it, and Google expires their refresh tokens after 7 days, so they must reconnect weekly. drive.readonly is a restricted scope, so publishing the app to external users requires Google's OAuth app verification.
  5. Create an OAuth client: Create an OAuth client ID of type Web application. Add the redirect URI of the environment that completes the flow: https://api.veryfront.com/oauth/callback/sheets for hosted Veryfront, or your app origin followed by /api/auth/sheets/callback for a local or self-hosted app. Set GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET from the app's credentials.
  6. Verify access: Run List Spreadsheets (read-only). It returns spreadsheets the connected Google account can open without changing them.

Provider notes

Provider API reference.

Tools

ToolAccessDescription
List Spreadsheets<br /><code className="reference-identifier">sheets__list_spreadsheets</code>ReadList spreadsheets
Get Spreadsheet<br /><code className="reference-identifier">sheets__get_spreadsheet</code>ReadGet spreadsheet
Read Range<br /><code className="reference-identifier">sheets__read_range</code>ReadRead range
Write Range<br /><code className="reference-identifier">sheets__write_range</code>WriteWrite range
Create Spreadsheet<br /><code className="reference-identifier">sheets__create_spreadsheet</code>WriteCreate spreadsheet
Append Rows<br /><code className="reference-identifier">sheets__append_rows</code>WriteAppend rows
Clear Range<br /><code className="reference-identifier">sheets__clear_range</code>WriteClear range values
Batch Update<br /><code className="reference-identifier">sheets__batch_update</code>WriteUpdate spreadsheet structure and formatting
Add Sheet<br /><code className="reference-identifier">sheets__add_sheet</code>WriteAdd sheet
Delete Sheet<br /><code className="reference-identifier">sheets__delete_sheet</code>WriteDelete sheet
Rename Sheet<br /><code className="reference-identifier">sheets__rename_sheet</code>WriteRename sheet
Delete Spreadsheet<br /><code className="reference-identifier">sheets__delete_spreadsheet</code>WriteTrash spreadsheet
Find and Replace<br /><code className="reference-identifier">sheets__find_replace</code>WriteFind and replace spreadsheet text
Copy Sheet<br /><code className="reference-identifier">sheets__copy_sheet</code>WriteCopy sheet
Create Chart<br /><code className="reference-identifier">sheets__create_chart</code>WriteCreate chart
Set Data Validation<br /><code className="reference-identifier">sheets__set_data_validation</code>WriteSet data validation

Verify the connection

Call a read tool such as sheets__list_spreadsheets with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.