lavaei / laravel-google-sheets
Google Sheets API v4
Requires
- php: ^7.4||^8.0
- google/apiclient: ^2.10
- illuminate/container: ^6.0||^7.0||^8.0||^9.0
- illuminate/support: ^6.0||^7.0||^8.0||^9.0
- pulkitjalan/google-apiclient: ^4.1||^5.0
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/testbench: ^5.0||^6.0||^7.0
- phpunit/phpunit: ^9.0
- dev-master
- 5.8.0
- 5.7.1
- 5.7.0
- 5.6.0
- 5.5.2
- 5.5.1
- 5.5.0
- 5.4.0
- 5.3.3
- 5.3.2
- 5.3.1
- 5.3.0
- 5.2.2
- 5.2.1
- 5.2.0
- 5.1.0
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 4.0.x-dev
- 4.0.6
- 4.0.5
- 4.0.4
- 4.0.3
- 4.0.2
- 4.0.1
- 4.0.0
- 3.3.0
- 3.2.13
- 3.2.12
- 3.2.11
- 3.2.10
- 3.2.9
- 3.2.8
- 3.2.7
- 3.2.6
- 3.2.5
- 3.2.4
- 3.2.3
- 3.2.2
- 3.2.1
- 3.2.0
- 3.1.1
- 3.1.0
- 3.0.x-dev
- 3.0.0
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.1.0
- 2.0.x-dev
- 2.0.0
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-Laravel9
This package is auto-updated.
Last update: 2025-03-22 21:35:25 UTC
README
Requirements
- PHP >= 7.4
- Laravel >= 6.0
Versioning
- Basic : semver
- Drop old PHP or Laravel version :
+0.1
. composer should handle it well. - Support only latest major version (
master
branch), but you can PR to old branches.
Installation
Composer
composer require revolution/laravel-google-sheets
Laravel
-
This package depends on https://github.com/pulkitjalan/google-apiclient
-
Run
php artisan vendor:publish --provider="PulkitJalan\Google\GoogleServiceProvider" --tag="config"
to publish the google config file// config/google.php // OAuth 'client_id' => env('GOOGLE_CLIENT_ID', ''), 'client_secret' => env('GOOGLE_CLIENT_SECRET', ''), 'redirect_uri' => env('GOOGLE_REDIRECT', ''), 'scopes' => [\Google\Service\Sheets::DRIVE, \Google\Service\Sheets::SPREADSHEETS], 'access_type' => 'online', 'approval_prompt' => 'auto', 'prompt' => 'consent', //"none", "consent", "select_account" default:none // or Service Account 'file' => storage_path('credentials.json'), 'enable' => env('GOOGLE_SERVICE_ENABLED', true),
-
Get API Credentials from https://developers.google.com/console
EnableGoogle Sheets API
,Google Drive API
. -
Configure .env as needed
GOOGLE_APPLICATION_NAME= GOOGLE_CLIENT_ID= GOOGLE_CLIENT_SECRET= GOOGLE_REDIRECT= GOOGLE_DEVELOPER_KEY= GOOGLE_SERVICE_ENABLED= GOOGLE_SERVICE_ACCOUNT_JSON_LOCATION=
Demo
Another Google API Series.
- https://github.com/kawax/laravel-google-photos
- https://github.com/kawax/laravel-google-searchconsole
Usage
id | name | |
---|---|---|
1 | name1 | mail1 |
2 | name2 | mail2 |
https://docs.google.com/spreadsheets/d/{spreadsheetID}/...
Basic Laravel Usage
use Sheets; $user = $request->user(); $token = [ 'access_token' => $user->access_token, 'refresh_token' => $user->refresh_token, 'expires_in' => $user->expires_in, 'created' => $user->updated_at->getTimestamp(), ]; // all() returns array $values = Sheets::setAccessToken($token)->spreadsheet('spreadsheetId')->sheet('Sheet 1')->all(); // [ // ['id', 'name', 'mail'], // ['1', 'name1', 'mail1'], // ['2', 'name1', 'mail2'] // ]
Basic Non-Laravel Usage
use Google\Client; use Revolution\Google\Sheets\Sheets; $client = new Client(); $client->setScopes([Google\Service\Sheets::DRIVE, Google\Service\Sheets::SPREADSHEETS]); // setup Google Client // ... $service = new \Google\Service\Sheets($client); $sheets = new Sheets(); $sheets->setService($service); $values = $sheets->spreadsheet('spreadsheetID')->sheet('Sheet 1')->all();
Get a sheet's values with the header as the key
// get() returns Laravel Collection $rows = Sheets::sheet('Sheet 1')->get(); $header = $rows->pull(0); $values = Sheets::collection($header, $rows); $values->toArray() // [ // ['id' => '1', 'name' => 'name1', 'mail' => 'mail1'], // ['id' => '2', 'name' => 'name2', 'mail' => 'mail2'] // ]
Blade
@foreach($values as $value) {{ data_get($value, 'name') }} @endforeach
Using A1 Notation
$values = Sheets::sheet('Sheet 1')->range('A1:B2')->all(); // [ // ['id', 'name'], // ['1', 'name1'], // ]
Updating a specific range
Sheets::sheet('Sheet 1')->range('A4')->update([['3', 'name3', 'mail3']]); $values = Sheets::range('')->all(); // [ // ['id', 'name', 'mail'], // ['1', 'name1', 'mail1'], // ['2', 'name1', 'mail2'], // ['3', 'name3', 'mail3'] // ]
Append a set of values to a sheet
// When we don't provide a specific range, the sheet becomes the default range Sheets::sheet('Sheet 1')->append([['3', 'name3', 'mail3']]); $values = Sheets::all(); // [ // ['id', 'name', 'mail'], // ['1', 'name1', 'mail1'], // ['2', 'name1', 'mail2'], // ['3', 'name3', 'mail3'] // ]
Append a set of values with keys
// When providing an associative array, values get matched up to the headers in the provided sheet Sheets::sheet('Sheet 1')->append([['name' => 'name4', 'mail' => 'mail4', 'id' => 4]]); $values = Sheets::all(); // [ // ['id', 'name', 'mail'], // ['1', 'name1', 'mail1'], // ['2', 'name1', 'mail2'], // ['3', 'name3', 'mail3'], // ['4', 'name4', 'mail4'], // ]
Add a new sheet
Sheets::spreadsheetByTitle($title)->addSheet('New Sheet Title');
Deleting a sheet
Sheets::spreadsheetByTitle($title)->deleteSheet('Old Sheet Title');
Specifying query parameters
$values = Sheets::sheet('Sheet 1')->majorDimension('DIMENSION_UNSPECIFIED') ->valueRenderOption('FORMATTED_VALUE') ->dateTimeRenderOption('SERIAL_NUMBER') ->all();
https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get#query-parameters
Use original Google_Service_Sheets
$sheets->spreadsheets->... $sheets->spreadsheets_sheets->... $sheets->spreadsheets_values->... Sheets::getService()->spreadsheets->...
see https://github.com/google/google-api-php-client-services/blob/master/src/Google/Service/Sheets.php
LICENSE
MIT
Copyright kawax