### A library for getting data from Google Sheets API v4
npm install google-sheets-mapper  
---
``bash`
npm install google-sheets-mapper
`bash`
pnpm add google-sheets-mapper
`bash`
bun add google-sheets-mapper
UMD build available on unpkg.
---
1. Go to Google Cloud Console to get API key for Google Sheets API.
2. Create a Google Sheet and add some data. See example sheet.
3. Share it with "Anyone with this link can view".
4. Get sheet id from url of the sheet.
`html`
https://docs.google.com/spreadsheets/d/[THIS-IS-THE-SHEET-ID]/
5. I suggest adding API key and sheet id to .env file
---
`js
import { fetchGoogleSheetsData } from "google-sheets-mapper";
const getData = async () => {
try {
return await fetchGoogleSheetsData({
apiKey: process.env.REACT_APP_GOOGLE_API_KEY,
sheetId: process.env.REACT_APP_GOOGLE_SHEETS_ID,
});
} catch (error) {
console.error(error);
}
};
`
Don't use single quotes on sheet names, they will be removed because when using space in sheet name it will be returned wrapped with single quotes and plugin will remove them for clean string id.
`js
import { fetchGoogleSheetsData } from "google-sheets-mapper";
const getData = async () => {
try {
return await fetchGoogleSheetsData({
apiKey: process.env.REACT_APP_GOOGLE_API_KEY,
sheetId: process.env.REACT_APP_GOOGLE_SHEETS_ID,
sheetsOptions: [{ id: "Sheet1" }],
});
} catch (error) {
console.error(error);
}
};
`
---
The GoogleSheetsMapper.fetchGoogleSheetsData function takes an object with three properties:
| Name | Value |
| ------------- | ------ |
| apiKey | string |
| sheetId | string |
| sheetsOptions | array |
- apiKey is a Google Sheets API v4 key from Google Cloud Console.sheetId
- is the id of the sheet.sheetsOptions
- is an array of specific objects { id, headerRowIndex }. Can be left out then it will fallback to all sheets inside the spreadsheet and use first row from sheet as header.
The function produces an MapperState object:
`js`
try {
const data = await GoogleSheetsMapper.fetchGoogleSheetsData({
apiKey,
sheetId,
});
} catch (error) {
console.error(error);
}
| Name | Value |
| ----- | -------------- |
| data | array |
| error | null or object |
- data is an array of mapped data objects.
`js`
[
{
id: "Sheet1",
data: [
{ value: "et", key: "language" },
{ value: "Test sheet", key: "title" },
],
},
];
- error lets you know when there is something wrong. It returns an error object where you can get specific error properties from error.response
`js`
{
status: '404',
statusText: '',
url: 'https://sheets.googleapis.com/v4/spreadsheets/...',
}
---
- Change sheetsNames array of string to sheetsOptions array of objects with { id: 'sheetName' }`