Skip to main content

Google Drive

The @uppy/google-drive plugin lets users import files from their Google Drive account.

A Companion instance is required for the Google Drive plugin to work. Companion handles authentication with Google Drive, downloads the files, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.

You can self-host Companion or get a hosted version with any Transloadit plan.

tip

Try out the live example or take it for a spin in StackBlitz.

When should I use this?​

When you want to let users import files from their Google Drive account.

You should use this plugin over the Google Drive Picker plugin if you prefer a UI with more controls, the ability to select folders, a leaner bundle size, and a more consistent user experience.

The downside is it needs a restricted API scope, which requires CASA Tier 2 compliance. This could take months to obtain and potentially a third-party security audit.

npm install @uppy/google-drive

Use​

Using Google Drive requires setup in both Uppy and Companion.

Use in Uppy​

import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import GoogleDrive from '@uppy/google-drive';

import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';

new Uppy()
	.use(Dashboard, { inline: true, target: '#dashboard' })
	.use(GoogleDrive, { companionUrl: 'https://your-companion.com' });

Use with Transloadit​

Transloadit’s OAuth2 key no longer works. This means that you have to use your own OAuth keys with Transloadit’s hosted Companion servers by using Transloadit Template Credentials. Create a Template Credential on the Transloadit site. Select “Companion OAuth” for the service, and enter the key and secret for the provider you want to use. Then you can pass the name of the new credentials to that provider:

import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit';
import GoogleDrive from '@uppy/google-drive';

uppy.use(GoogleDrive, {
	companionUrl: COMPANION_URL,
	companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
	companionKeysParams: {
		key: 'YOUR_TRANSLOADIT_API_KEY',
		credentialsName: 'my_companion_dropbox_creds',
	},
});

Note that even if you use your own credentials, Google’s OAuth2 Consent dialog will still show “transloadit.com” to your users, e.g. “transloadit.com wants to access your Google account” until your app has been verified, after which it should show what’s in your “App name” form field in the Google developer console.

Use in Companion​

To sign up for API keys, go to the Google Developer Console.

Create a project for your app if you don’t have one yet.

The app page has a "Redirect URIs" field. Here, add:

https://$YOUR_COMPANION_HOST_NAME/drive/redirect

If you are using Transloadit hosted Companion:

https://api2.transloadit.com/companion/drive/redirect

Google will give you an OAuth client ID and client secret.

Configure the Google key and secret in Companion. With the standalone Companion server, specify environment variables:

export COMPANION_GOOGLE_KEY="Google OAuth client ID"
export COMPANION_GOOGLE_SECRET="Google OAuth client secret"

When using the Companion Node.js API, configure these options:

companion.app({
	providerOptions: {
		drive: {
			key: 'Google OAuth client ID',
			secret: 'Google OAuth client secret',
		},
	},
});

API​

Options​

id​

A unique identifier for this plugin (string, default is a unique ID for each plugin).

title​

Title / name shown in the UI, such as Dashboard tabs (string, default is the name of the plugin).

target​

DOM element, CSS selector, or plugin to place the drag and drop area into (string, Element, Function, or UIPlugin, default: Dashboard).

companionUrl​

URL to a Companion instance (string, default: null).

companionHeaders​

Custom headers that should be sent along to Companion on every request (Object, default: {}).

companionAllowedHosts​

The valid and authorised URL(s) from which OAuth responses should be accepted (string or RegExp or Array). This option is useful when you have your Companion running on several hosts. Otherwise, the default value should do fine, which uses the origin of companionUrl.

This value can be a string, a RegExp pattern, or an Array of these. Strings are evaluated as regular expressions too and will be wrapped in a RegExp like so:

new RegExp(`^${value}$`);

Important: You must escape regex characters like ., or you might open your app up to security vulnerabilities.

  • Example correct strings
    • '^(?:.*\\.)?example\.com$' matches example.com and all of its subdomains.
    • 'https://example\.com' matches https://example.com only.
  • Example vulnerability: 'https://www.example.com' would allow an attacker with the domain wwwxexample.com to forge and inject a fraudulent token into Uppy.

companionCookiesRule​

This option correlates to the RequestCredentials value (string, default: 'same-origin').

This tells the plugin whether to send cookies to Companion.

locale​

An object with strings property containing additional i18n strings. The key is the i18n key and the value is the English string.

Example:

{
	strings: {
		someKey: 'Some English string',
	},
}

storage​

A custom storage to be used for the plugin’s persistent data. Type AsyncStore, default is LocalStorage.