> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/google.md).

# Google

## OAuth app properties

| Property                | Value                                                                                                                                                                                                                                                                                                           |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Multi-tenant**        | **Conditional.** Any Google account can connect once the app has user type *External*, publishing status *In production*, and is verified for the scopes the connectors request. An *Internal* app serves only your own Google Workspace organization. An app in *Testing* serves only the test users you list. |
| **Vendor review**       | **By scope.** Non-sensitive scopes: brand verification only (home page and privacy policy on a domain you own). Sensitive scopes: also a demo video and a justification of each scope. Restricted scopes: also a CASA security assessment by an authorized lab, repeated every year, paid by you.               |
| **Review time**         | Google's estimates: brand 2–3 business days, sensitive scopes about 10 business days, restricted scopes about 6 weeks plus the assessment.                                                                                                                                                                      |
| **Users before review** | 100. In Testing these are the listed test users. In production, an unverified app gets 100 new users over the lifetime of the project, and the count never resets.                                                                                                                                              |
| **App owner**           | A Google Cloud project, and Search Console ownership of every authorized domain.                                                                                                                                                                                                                                |
| **Regions**             | One app works worldwide.                                                                                                                                                                                                                                                                                        |
| **Client secret**       | Does not expire. Google can delete a client that was not used for 6 months.                                                                                                                                                                                                                                     |
| **Rate limits**         | A per-project limit on new user authorizations, which Google does not publish and which applies to verified apps too. Each API has its own request quota.                                                                                                                                                       |
| **Checked**             | 2026-11-13                                                                                                                                                                                                                                                                                                      |

**Limitations**

* While the app is in Testing, a connected account stops working 7 days after consent. In production, Google revokes access that was not used for 6 months, and keeps at most 100 connections per Google account and client.
* Verification is per Google Cloud project and per scope. A scope added later needs a new review.
* A Google Workspace administrator can block third-party apps for their organization, whatever the verification status.
* The Google Drive connector requests these scopes:

| Scope                                            | Tier          |
| ------------------------------------------------ | ------------- |
| `https://www.googleapis.com/auth/drive.file`     | Non-sensitive |
| `https://www.googleapis.com/auth/drive.readonly` | Restricted    |
| `https://www.googleapis.com/auth/drive`          | Restricted    |

Sources: [Drive API scopes](https://developers.google.com/workspace/drive/api/guides/api-specific-auth), [App audience and publishing status](https://support.google.com/cloud/answer/15549945), [Unverified apps](https://support.google.com/cloud/answer/13463817), [Verification requirements](https://support.google.com/cloud/answer/13464321), [OAuth 2.0 policies](https://developers.google.com/identity/protocols/oauth2/policies). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## Application verification

In 2020 Google introduced *Application verification* If an app uses Google APIs to access Google users’ data. This makes it impossible to use the Appmixer Google modules in production without the verification process. Such a verification process has to be done by you.

Most of the Google modules need what Google marks as *Sensitive* or *Restricted Scope* in order to work. For example, the Gmail module needs <https://www.googleapis.com/auth/gmail.compose> scope to create a new email and <https://www.googleapis.com/auth/gmail.readonly> to get new emails.

Originally, the Gmail module was the only one affected by this new Google policy. But new scopes are being marked as *restricted*. Later, they shut down the older Spreadsheets API, and with the new API, the only way to get a list of users Spreadsheets is to use the Drive API and restricted scope <https://www.googleapis.com/auth/drive.metadata.readonly>.

The last (up to now) module affected by this policy is the Drive module.

## Register Oauth2 app

Go to the Google developer console at <https://console.developers.google.com/> and create a new project.

![Developer Console](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-9f31a8002b8514bd88bfe72b3ee21427b0cfff4d%2Fgoogle-1.png?alt=media)

![New Project](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-26f2887a221e823e92f8867aaf206f2cc10aa840%2Fgoogle-2.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-a270b6d75f304ffe7d1a1ef887528bbe7edc0267%2Fgoogle-3.png?alt=media)

When the project is created, add some APIs.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-cfe04938a63ed4d07411ebf531a06463a4e034f0%2Fgoogle-4.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-3272a4abe547f1fe08237ed85f48ec99f3a823cc%2Fgoogle-5.png?alt=media)

Add the Gmail API.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-25df5498256a61677a8e6ead9bace68c2395d718%2Fgoogle-6.png?alt=media)

The Google Sheets API.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-8cd56480ea43bb80e2facd441c51ab6ad808800a%2Fgoogle-7.png?alt=media)

The Google Drive API.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-33238364350dbd6722ce86461fb46bac74f851c5%2Fgoogle-8.png?alt=media)

The Google Calendar API.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-166967f89b744d4cc53c69607a1eb9b1d3b9728f%2Fgoogle-9.png?alt=media)

The Analytics API.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-d2563eb7f05d79e328f62193933ac881789ee5b5%2Fgoogle-10.png?alt=media)

The YouTube API. ![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-b6b22b0cec3eff68874e25db67554532eb948bdb%2Fgoogle-11.png?alt=media)

### OAuth consent screen

The next step is the OAuth consent screen.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-79edd0ba757ea4e246420e72b8b5aa4d065409b4%2Fgoogle-12.png?alt=media)

User Type - Internal vs External. The Internal user type allows you to use the Google modules without the app verification process mentioned at the beginning of this page. However, the modules will work only for accounts within your organization.

We are going to choose External for the purpose of this tutorial.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-5fcbe8d9a577626d21a29938e7931605f30af01c%2Fgoogle-13.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-1e7839fbb1a9b10d725b746fae4ac09a6535ae17%2Fgoogle-14.png?alt=media)

On the next page, leave the scopes empty.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-e7ed248cfb29c141c7faad5cef1df519fdca4194%2Fgoogle-15.png?alt=media)

You can add test users, but you can do this later. Only users added as test users will be able to authenticate!

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-349f876aa9c0d9bc9fb8ef4fee9f664d921678b8%2Fgoogle-16.png?alt=media)

Here is the Oauth consent screen configured. The app is in *the testing* mode, it is *external* (for users outside your organization). No more than 100 accounts (user cap) can be used with this application.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-d6aac7291ea7f00c4b07819593aff3391240cf3d%2Fgoogle-17.png?alt=media)

### Client ID and Client Secret

We need a client ID and a client secret.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-b37f8594c9329a773d1ec80aec35f67ac22cf449%2Fgoogle-18.png?alt=media)

Choose the *Web application* type and give it a name and authorize redirect URI.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-894acf9f5e16501dc3a3509c67897adaadb2f600%2Fgoogle-19.png?alt=media)

For the purpose of this tutorial, we are going to use localhost:2200 which is the default port for the Appmixer API when running on localhost. If you are creating an Oauth application for your production/QA, the URI of your server will be here. The suffix /auth/google/callback will remain there.

You will get your Client ID and Client Secret.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-7f9912c85220eb8f65f62a89027ebd78fe29e911%2Fgoogle-20.png?alt=media)

Put them into the Appmixer Backoffice, see [Backoffice configuration](#backoffice-configuration).

### Domain verification

In order to use Google API Webhooks, you have to verify your domain ownership. More about domain verification can be found [here](https://support.google.com/a/topic/9196?hl=en\&ref_topic=3540977). If you use the Appmixer Self-Managed package and you run Appmixer on your own servers using your custom domain, you can use [CNAME](https://support.google.com/a/answer/47283?hl=en\&ref_topic=29598) records to verify your domain ownership. Otherwise, if you are an Appmixer Hosted customer, you can use the [*HTML file method*](https://support.google.com/a/answer/63026?hl=en) to verify your Appmixer tenant domain (`api.YOUR_TENANT.appmixer.cloud`) at Google.

{% hint style="info" %}
When you use a Google Webhook component without a verified domain, you will receive the **Unauthorized WebHook callback channel error.**
{% endhint %}

First, open the Google developers console and your Appmixer project and follow the instructions in the next picture.

![Domain verification](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-04b01b66e856c25a4838a368a7ceb28b69e294f6%2Fgoogle-23.png?alt=media)

Add your Appmixer tenant API URL (`api.YOUR_TENANT.appmixer.cloud`) and continue to verify the domain ownership. Click 'Take me there' and then 'Add a property'.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-cfc8e2b1f04d475f634b4a463cc0496045745bce%2Fgoogle-26.png?alt=media)

Again, use `api.YOUR_TENANT.appmixer.cloud`. Then download the HTML verification file.

![Download HTML verification file](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-bfc9ba46ffc85ee1d9df1d022116ac61b74d90d2%2Fgoogle-28.png?alt=media)

After you download your HTML verification file, upload it via the Appmixer Backoffice interface to the *Public Files* section on the left. When you are done you should see your file listed:

![Google verification file uploaded via Backoffice](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-d72f8f9236b257159e95bbba67f1ca3422b6c58a%2Fgoogle-29.png?alt=media)

Click the 'Verify' button to finish the verification process.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-28a61778ac9cb0c16bcd47897d77d34b8f0279cc%2Fgoogle-30.png?alt=media)

Now, you can go back to the developer console and add the `api.YOUR_TENANT.appmixer.cloud` domain once more. But this time, because it's already verified, it will appear in the list of your domains.

The new domain has to be added to the *OAuth consent screen* as well.

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-87dcccd7f16815afb4674e89afa645a580ed1fd6%2Fgoogle-33.png?alt=media)

## Backoffice configuration

The Google connector has four OAuth services, each with its own configuration: `appmixer:google` for Calendar, Sheets, BigQuery and YouTube, and `appmixer:google:gmail`, `appmixer:google:drive` and `appmixer:google:analytics` for Gmail, Drive and Analytics. Each of them needs `clientId` and `clientSecret`. They can all hold the values of the same Google OAuth client. See [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector.

![Creating appmixer:google service configuration](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-dcfb867627e11235c1fcd17f1971075839919612%2Fgoogle-21.png?alt=media)

![Setting clientId and clientSecret](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-abbbb7e5ccbf2c53e1c58475440d5edbcaf08593%2Fgoogle-22.png?alt=media)

Configuration ID `appmixer:google`:

* `clientId` — Client ID of the Google OAuth client created above. Not needed when Google is authenticated through the Appmixer Auth Hub.
* `clientSecret` — Client secret of the same client. Not needed with the Auth Hub.
* `callbackUrl` — Optional. The redirect URI passed to Google. By default it is `<your-api-url>/auth/google/callback`; set this key only when Google has to be given a different URL. The value must also be listed as an authorized redirect URI of the OAuth client.
* `batchSize` — Optional. Number of rows that the Sheets **Create Rows** component appends in one request when it imports a CSV file. Default `10000`.
* `concurrency` — Optional. How many rows the BigQuery triggers **New Row**, **Updated Row** and **Deleted Row** store at once while they read the query result. Default `100`.
* `lockTTL` — Optional. How long, in milliseconds, the lock of the BigQuery **New Row** and **Updated Row** triggers is held, so that two runs of the same trigger do not overlap. Default `300000` (5 minutes).
* `lockExtendTime` — Optional. By how many milliseconds the BigQuery **New Row** and **Updated Row** triggers extend their lock after each processed batch of rows. Default `120000` (2 minutes).
* `outputFilePrefix` — Optional. File name prefix of the CSV file that the BigQuery **List Tables** component creates when its output is set to a file. Default `google-export`.
* `DEBUG` — Optional. Set to `true` to log extra details from the Gmail **New Email** and **New Attachment** triggers and the Drive **New File or Folder**, **Updated File or Folder** and **Deleted File or Folder** triggers. Off by default.

The keys other than `clientId`, `clientSecret` and `callbackUrl` can also be set in the configuration of the module the component belongs to (`appmixer:google:spreadsheets`, `appmixer:google:bigquery`, `appmixer:google:gmail`, `appmixer:google:drive`). When a key is in both, the value in `appmixer:google` wins.

Configuration IDs `appmixer:google:gmail`, `appmixer:google:drive` and `appmixer:google:analytics`:

* `clientId`, `clientSecret` — same as above; they can be the values of the same client. Not needed with the Auth Hub.
* `callbackUrl` — Optional, same as above.

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:google -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>"
}'
appmixer service-config set appmixer:google:gmail -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>"
}'
appmixer service-config set appmixer:google:drive -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>"
}'
appmixer service-config set appmixer:google:analytics -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/google.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
