View a markdown version of this page

Google Sheets integration - Amazon Quick

Google Sheets integration

With the Google Sheets action connector, you can access Google Sheets directly in Amazon Quick through natural language. You can create and edit spreadsheets, read and write cell ranges, format cells, and search for data without leaving Amazon Quick.

Amazon Quick supports multiple authentication methods for Google Sheets. Choose the method that best fits your organization's security requirements.

  • Default OAuth app – Uses an AWS-managed OAuth application. No additional credentials are needed. You authenticate directly with your Google account.

  • Custom OAuth app – Uses a customer-managed OAuth client created in the Google Cloud Console. This option gives your organization full control over the OAuth configuration.

For more information about the authentication methods that Amazon Quick supports, see Authentication methods.

Before you begin

Make sure that you have the following before you set up the integration.

Configuring Google Cloud

If you use Default OAuth app authentication, skip this section and see Setting up the connector in Amazon Quick.

For Custom OAuth app authentication, complete the following steps in the Google Cloud Console before you configure Amazon Quick. When you enable the API in step 3, search for and enable the Google Sheets API.

Create an OAuth client in Google Cloud Console

Create an OAuth client in the Google Cloud Console to get the client credentials that you need for Amazon Quick. For more information, see Using OAuth 2.0 to Access Google APIs on the Google website.

  1. Sign in to the Google Cloud Console on the Google website.

  2. Create a new project or select an existing project.

  3. In the left navigation pane, choose APIs & Services, then choose Library. Search for the API that your integration requires and choose Enable.

  4. Choose OAuth consent screen and choose Get Started.

  5. Configure the consent screen:

    • Enter an App Name and select a User support email.

    • For Audience, choose Internal (your organization only) or External (any Google user).

    • Add developer contact details and choose Create.

  6. Choose Create OAuth client.

  7. Configure the client:

    • For Application type, choose Web application.

    • Enter a Name for your client.

    • Under Authorized redirect URIs, add the Amazon Quick callback URL: https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

  8. Choose Create.

  9. Record the following values. You need them when you configure Amazon Quick.

    • Client ID

    • Client secret

Recommended scopes

The following scopes are requested when you connect to Google Sheets.

Google Sheets recommended scopes
Scope Description
https://www.googleapis.com/auth/spreadsheets Reads and writes Google Sheets spreadsheets.
https://www.googleapis.com/auth/drive Reads and writes files in Google Drive.
https://www.googleapis.com/auth/drive.readonly Reads files in Google Drive.
openid Authenticates the user's identity.
email Reads the user's email address.
Note

The openid and email scopes are automatically included in the OAuth consent flow for user authentication. They are not required for Service-to-Service OAuth.

Setting up the connector in Amazon Quick

Connect from the Available tab

If you want to use Default OAuth app authentication, you can connect directly from the Available tab without additional configuration.

  1. In the Amazon Quick console, choose Connectors.

  2. On the Available tab, find Google Sheets and choose Connect.

  3. Complete the Google sign-in flow and grant the requested permissions.

To configure a connector with Custom OAuth app instead, use the Create for your team tab as described below.

Create from the Create for your team tab

After you complete any required Google Cloud configuration, create the connector in Amazon Quick.

  1. In the Amazon Quick console, choose Connectors.

  2. Choose the Create for your team tab.

  3. Find and choose Google Sheets.

    Note

    If a Google Sheets connector already exists, a dialog appears with your existing connectors. To use an existing connector, choose it. To create a new one, choose No, create new.

  4. Enter a Name for your connector. Optionally, choose + Add Description to add a description.

  5. For Connection type, choose Public network.

  6. For OAuth Configuration, choose one of the following authentication methods and configure the required fields.

    1. For Default OAuth app:

      No additional credentials are needed. Choose Next to continue.

    2. For Custom OAuth app, configure the following fields:

      • Base URL (Optional) – The Google Sheets API base URL. For example: https://sheets.googleapis.com

      • Client ID – The client ID from your Google Cloud OAuth client.

      • Client secret – The client secret from your Google Cloud OAuth client.

      • Token URL – The token endpoint. For example: https://oauth2.googleapis.com/token

      • Authorization URL – The authorization endpoint. For example: https://accounts.google.com/o/oauth2/v2/auth

      • Redirect URL – Pre-filled with the Amazon Quick callback URL.

  7. Choose Next.

  8. If you chose Default OAuth app or Custom OAuth app, a Google authorization window opens. Review the requested permissions and choose Allow.

  9. On the Review page, review the available actions for the connector. Choose Next.

  10. On the Publish page, choose who can access the connector. You can enable access for everyone in your organization or search for specific teams or groups.

  11. Choose Publish.

Available actions

After you set up the connector, the following actions are available.

Google Sheets available actions
Category Action Description
Values Get Values Reads values from a cell range.
Values Batch Get Value Reads values from multiple cell ranges in a single request.
Values Get Values By Filter Reads values using a data filter.
Values Update Values Writes values to a cell range.
Values Batch Update Value Writes values to multiple cell ranges in a single request.
Values Append Values Appends values after the last row of data in a range.
Values Delete Values Clears values from a cell range.
Values Update Text Finds and replaces text across a spreadsheet.
Rows Create Row Creates a new row in a spreadsheet.
Rows Put Rows Upserts rows in a spreadsheet.
Rows Get Spreadsheet Row Looks up a row by matching criteria.
Spreadsheets Create Spreadsheet Creates a new spreadsheet.
Spreadsheets Get Spreadsheet Info Retrieves metadata for a spreadsheet.
Spreadsheets Search Spreadsheets Searches for spreadsheets.
Sheets Create Sheet Adds a new sheet to a spreadsheet.
Sheets List Sheet Names Lists sheet names in a spreadsheet.
Sheets Update Sheet Properties Updates sheet properties such as name or visibility.
Formatting Update Cell Format Formats cells in a range.
Formatting Update Conditional Format Rules Creates or updates conditional formatting rules.
Note

The actions that you can use depend on the spreadsheets accessible to the authenticated user.

Managing and troubleshooting

To edit, share, or delete your connector, see Managing existing integrations.

Common Google authentication issues

  • Sign-in fails (Default OAuth app or Custom OAuth app) – Verify that your Google account is active and that you can sign in to the Google website directly. For Custom OAuth app, confirm that the redirect URI in your Google Cloud OAuth client matches the Amazon Quick callback URL.

  • App blocked by administrator – If your Google Workspace administrator restricts third-party app access, you might see an error when you attempt to sign in. Contact your Google Workspace administrator to allow the Amazon Quick app.

  • Invalid client credentials (Custom OAuth app) – Verify that the Client ID and Client secret match the values in your Google Cloud OAuth client.

  • Authentication popup fails – Verify that your browser allows popups from the Amazon Quick console domain. Try using a different browser or clearing your browser cache.

  • Permissions revoked – If you previously revoked Amazon Quick access from your Google Account permissions settings, you need to re-authenticate by editing the connector and signing in again.

  • Google API rate limiting – Google might limit requests during high usage periods. If actions fail, retry after a few minutes.

Google Sheets-specific issues

  • Google Sheets API not enabled – Verify that the Google Sheets API is enabled in your Google Cloud project under APIs & Services, Library.