aigorlaxy/google-sheets-model-importer

A simple trait to insert or update data to models from Google Sheets with just the link of the published spreadsheet. No need of Google API.

v3.4.0 2024-09-11 10:12 UTC

Requires

• php: ^7.3|^8.0
• illuminate/support: ^8.0|^9.0|^10.0

MIT

• Igor Borges

README

A simple Laravel support class to insert or update data to models from Google Sheets with just the link of the published spreadsheet. No need of Google API.

Installation

You can install the package via composer:

composer require aigorlaxy/google-sheets-model-importer

Using

1. Create a Google Spreadsheet.

2. Publish it to internet and set general access to anyone with the link can be a viewer.

3. Include the class in your model class and use it.

4. To create a instance of that class, you will need your target model, your googleSpreadSheetId and your specfic tab sheet2_gid.

5. To get your entire spreadsheet id using your published Google Sheets link The link will look something like that: https://docs.google.com/spreadsheets/d/e/YOU_GOOGLE_SHEET_SPREADSHEET_ID/something_else

6. To get your specific sheetId, follow this instructions: If you have just one tab for that model, use the gid as a string. If you have more than one tab for the same model, use array. All models must match the same column schema to work. The link will look something like that: https://docs.google.com/spreadsheets/d/YOUR_SPREADSHEET_ID/edit?gid=YOUR_SHEET_ID

7. Create a instance of the class.

$googleSheetModelImpoter = new GoogleSheetModelImpter(Model $model, string $googleSpreadSheetId, string $googleSheetId);

1. Optional props 8.1. $updateColumnIndex: Optionaly you can set a different primary key to check for updates. if your primary key is not default id or you want to track updates based on another column. If not set, it will assume that id column is your primary key.

$googleSheetModelImpoter->updateColumnIndex = 'your_column_name';

8.2. $colunsToSkip: You can also optionaly set columns to be skipped. The app will search for columns that contains any of that strings and will skip the import for that ones. You can set a single string or an array.

$googleSheetModelImpoter->colunsToSkip = 'your_column_in_google_sheets_to_skip';

1. Example of usage:

$model = User::class;
$googleSpreadSheetId = '1gaLFuSnh20kggxEaasr511s15vt3olKqp9o12HenDLI3vA7pg';
$sheetId = '15144122';
$googleSheetModelImpoter = new GoogleSheetModelImpter($model, $googleSpreadSheetId, $googleSheetId);

$googleSheetModelImpoter->updateOrCreate(); // Updating and inserting new data.
$googleSheetModelImpoter->getFreshTable(); // Truncate the current table and inserting the new data.

1. Any issue or suggestions, please send me an e-mail: [e-mail]