invokable-laravel-google-sheets

Depending on your use case, choose one of the following authentication methods:

• Service Account: Recommended for most Laravel applications, automated systems, and background jobs. It uses a JSON key file to authenticate as a non-human user.
• OAuth 2.0: Use when your application needs to act on behalf of a specific user to access their personal Google Sheets.
• API Key: Only suitable for reading public spreadsheets. This is very limited in scope.

OAuth 2.0 authentication is the preferred method when your application needs to access a user's personal Google Sheets. Use this method for:

• User-centric applications: Where users interact with their own spreadsheets.
• Multi-tenant applications: Where different users access different spreadsheets.
• Personal data access: Reading or writing data from a user's personal Google account.
• Desktop or web applications: Where user interaction is available to grant permissions.

The GoogleSheets trait provides a sheets() method. If your model or an imported namespace already uses the name sheets, you may encounter conflicts. You can use the use ... { ... } syntax to alias the trait's method if necessary.

use GoogleSheets { 
    GoogleSheets::sheets as googlesheets;
}

Choose an authentication method based on your application's needs:

Note: API Key authentication is read-only and only works for publicly shared spreadsheets.

The package automatically handles token refreshing when using setAccessToken() if a valid refresh_token is provided in the array. To persist the newly refreshed access token, you should retrieve the updated token from the package after the call.

$token = [
    'access_token' => $user->google_access_token,
    'refresh_token' => $user->google_refresh_token,
    'expires_in' => $user->google_expires_in,
    'created' => $user->google_token_created,
];

// This will automatically refresh the token if expired
Sheets::setAccessToken($token)->spreadsheet('id')->sheet('Sheet1')->all();

// Get the updated token after refresh
$updatedToken = Sheets::getAccessToken();
if ($updatedToken) {
    $user->update([
        'google_access_token' => $updatedToken['access_token'],
        'google_token_created' => time(),
    ]);
}

To use OAuth 2.0, you must first set up your project in the Google Cloud Console:

1. Enable APIs: Navigate to APIs & Services > Library and enable both the Google Sheets API and the Google Drive API.
2. Create Credentials: Go to APIs & Services > Credentials and select Create Credentials > OAuth client ID.
3. Configure Consent Screen: If prompted, choose External, provide an app name and support email, and add these scopes:
   • https://www.googleapis.com/auth/spreadsheets
   • https://www.googleapis.com/auth/drive
4. Set Application Type: Choose Web application.
5. Authorized Redirect URIs: Add your callback URL (e.g., http://localhost:8000/auth/google/callback for local dev or https://yourdomain.com/auth/google/callback for production).
6. Save Credentials: Copy the generated Client ID and Client Secret.

Install the package via Composer. Ensure your environment meets the requirements: PHP >= 8.3 and Laravel >= 12.0.

After installation, publish the configuration file and enable the Google Sheets API and Google Drive API in your Google Cloud Console.

composer require revolution/laravel-google-sheets
php artisan vendor:publish --tag="google-config"

For environments like GitHub Actions or containerized deployments where managing separate files is difficult, you can store the entire JSON credential content as a string in your .env file.

1. Set GOOGLE_SERVICE_ACCOUNT_JSON_LOCATION to the raw JSON string in your .env.
2. Update config/google.php to decode the string:

// config/google.php
'service' => [
    'enable' => env('GOOGLE_SERVICE_ENABLED', false),
    'file' => json_decode(env('GOOGLE_SERVICE_ACCOUNT_JSON_LOCATION', ''), true),
],

Install the package via Composer. This package requires PHP >= 8.0.

composer require pulkitjalan/google-apiclient

The recommended way to process data is to retrieve rows as a Laravel Collection and then use Sheets::collection() to map the first row (headers) as keys for the subsequent rows.

use Revolution\Google\Sheets\Facades\Sheets;

// get() returns Laravel Collection
$rows = Sheets::sheet('Sheet 1')->get();

$header = $rows->pull(0);
$values = Sheets::collection(header: $header, rows: $rows);

// $values is now a collection of associative arrays:
// [['id' => '1', 'name' => 'name1', ...], ...]

When upgrading to version 6.0, ensure your environment meets the following requirements:

• Requirements: Upgrade to PHP >= 8.0 and Laravel >= 8.x.