Laravel & Google Drive Storage

Demo project with Laravel 5.4

Look at the commit history to see each of the steps I have taken to set this up.

Set up this demo project locally

git clone git@github.com:ivanvermeyen/laravel-google-drive-demo.git
composer install

I took care of this:

This will also install only one additional package that is not included by Laravel out of the box:

"nao-pon/flysystem-google-drive": "~1.1"

I have included a GoogleDriveServiceProvider which I have added to the providers array in config/app.php, and added a google disk in config/filesystems.php:

'disks' => [

    // ...

    'google' => [
        'driver' => 'google',
        'clientId' => env('GOOGLE_DRIVE_CLIENT_ID'),
        'clientSecret' => env('GOOGLE_DRIVE_CLIENT_SECRET'),
        'refreshToken' => env('GOOGLE_DRIVE_REFRESH_TOKEN'),
        'folderId' => env('GOOGLE_DRIVE_FOLDER_ID'),
    ],

    // ...

],

Create your Google Drive API keys

Detailed information on how to obtain your API ID, secret and refresh token:

Update `.env` file

Add the keys you created to your .env file and set google as your default cloud storage. You can copy the .env.example file and fill in the blanks.

FILESYSTEM_CLOUD=google
GOOGLE_DRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
GOOGLE_DRIVE_CLIENT_SECRET=xxx
GOOGLE_DRIVE_REFRESH_TOKEN=xxx
GOOGLE_DRIVE_FOLDER_ID=null

Using multiple Google Drive accounts

If you want to use multiple Google Drive accounts in a single Laravel app, you need to get the API keys for each one as described above and store them separately in your .env file:

MAIN_GOOGLE_DRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
MAIN_GOOGLE_DRIVE_CLIENT_SECRET=xxx
MAIN_GOOGLE_DRIVE_REFRESH_TOKEN=xxx
MAIN_GOOGLE_DRIVE_FOLDER_ID=null

BACKUP_GOOGLE_DRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
BACKUP_GOOGLE_DRIVE_CLIENT_SECRET=xxx
BACKUP_GOOGLE_DRIVE_REFRESH_TOKEN=xxx
BACKUP_GOOGLE_DRIVE_FOLDER_ID=null

Then you should add a disk in config/filesystems.php for each account using the google driver and the account specific keys:

'main_google' => [
    'driver' => 'google',
    'clientId' => env('MAIN_GOOGLE_DRIVE_CLIENT_ID'),
    'clientSecret' => env('MAIN_GOOGLE_DRIVE_CLIENT_SECRET'),
    'refreshToken' => env('MAIN_GOOGLE_DRIVE_REFRESH_TOKEN'),
    'folderId' => env('MAIN_GOOGLE_DRIVE_FOLDER_ID'),
],

'backup_google' => [
    'driver' => 'google',
    'clientId' => env('BACKUP_GOOGLE_DRIVE_CLIENT_ID'),
    'clientSecret' => env('BACKUP_GOOGLE_DRIVE_CLIENT_SECRET'),
    'refreshToken' => env('BACKUP_GOOGLE_DRIVE_REFRESH_TOKEN'),
    'folderId' => env('BACKUP_GOOGLE_DRIVE_FOLDER_ID'),
],

Now you can access the drives like so:

$mainDisk = Storage::disk('main_google');
$backupDisk = Storage::disk('backup_google');

Keep in mind that there can only be one default cloud storage drive, defined by FILESYSTEM_CLOUD in your .env (or config) file. If you set it to main_google, that will be the cloud drive:

Storage::cloud(); // refers to Storage::disk('main_google')

Available routes

Route	Description
/put	Puts a new `test.txt` file to Google Drive
/put-existing	Puts an existing file to Google Drive
/list	Lists all files in Google Drive (root directory, not recursive by default)
/list-folder-contents	List all files in a specific folder
/get	Finds and downloads the `test.txt` file from Google Drive
/create-dir	Creates a `Test Dir` directory
/create-sub-dir	Creates a `Test Dir` directory and a `Sub Dir` sub directory
/put-in-dir	Puts a new `test.txt` file to the `Test Dir` sub directory
/newest	Puts a new file to Google Drive and then fetches it
/delete	Delete a file from Google Drive
/delete-dir	Delete an entire directory from Google Drive
/rename-dir	Rename a directory in Google Drive
/put-get-stream	Use a stream to store and get larger files
/share	Change permissions to share a file with the public
/export/{basename}	Export a Google doc (to PDF)

This is a very basic example to get you started. To see the logic behind these routes, check routes/web.php.

Interesting Reads

Upload large files to S3 using Laravel 5 by Freek Van der Herten.

usmanfourspan/laravel-google-drive-demo