# grid-cms-sdk > The grid-cms fetcher library Latest version **1.3.3** (published 2021-12-19) · MIT license · 0 weekly downloads ## Install ```sh npm install grid-cms-sdk pnpm add grid-cms-sdk yarn add grid-cms-sdk bun add grid-cms-sdk ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.3.3 | | Published | 2021-12-19 | | First published | 2021-11-14 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 27.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 8 | | Author | hiromasaishiwata | | Maintainers | kotobuki562 | | Keywords | jamstack, npm, fetcher, query, grid-cms, spreadsheet, googleapis, cms, headlesscms | ## Links - npm: https://www.npmjs.com/package/grid-cms-sdk - Repository: https://github.com/kotobuki562/grid-cms-SDK - Homepage: https://github.com/kotobuki562/grid-cms-SDK#readme - Issues: https://github.com/kotobuki562/grid-cms-SDK/issues - npm.io page: https://npm.io/package/grid-cms-sdk ## Dependencies (1) - [google-auth-library](https://npm.io/package/google-auth-library.md) ^7.10.2 ## Alternatives - [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads - [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads - [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads - [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads - [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads ## Recent versions - 1.3.3 (latest) — 2021-12-19 - 1.3.2 — 2021-12-11 - 1.3.1 — 2021-12-11 - 1.2.0 — 2021-12-04 - 1.1.8 — 2021-12-04 - 1.1.7 — 2021-12-03 - 1.1.6 — 2021-12-03 - 1.1.5 — 2021-12-03 - 1.1.2 — 2021-11-25 - 1.1.1 — 2021-11-25 - 1.1.0 — 2021-11-25 - 1.0.11 — 2021-11-23 - 1.0.9 — 2021-11-23 - 1.0.8 — 2021-11-23 - 1.0.7 — 2021-11-23 - … 7 more at https://npm.io/package/grid-cms-sdk/versions ## README Grid CMS is a Headress CMS service that uses Google Sheets. All data can be managed in spreadsheets and is simple. Make CMS simpler. This package is a fetcher library for grid-cms ### [What is Grid CMS?](https://grid-cms.vercel.app/) ### [Grid CMS Tutorial](https://grid-cms.vercel.app/grid) # 1. begin grid-cms-SDK ``` npm i grid-cms-sdk // or // yarn add grid-cms-sdk ``` # 2. create-client ```index.ts import { createClient } from "grid-cms-sdk/dist"; const client = createClient({ email: "YOUR_GOOGLE_SERVICE_ACCOUNT_EMAIL", privateKey: "YOUR_GOOGLE_PRIVATE_KEY", }); ``` # 3. get sheet data for Next.js SSG The image below is sample data. ![sample](https://user-images.githubusercontent.com/67810971/146659925-7c0ff57b-6971-478b-bfcd-496e8ff15159.png) ## `Basic` ```index.ts import { getSheet } from "grid-cms-sdk/dist"; import { client } from "src/gridCMS" export const getStaticProps = async () => { const res = await getSheet( client, { spreadsheetId: "SPREAD_SHEET_ID", range: "SHEET_NAME", } ); return { props: { result: res.contents, total: res.totalCount, } }; }; ``` ## `Pagination` ```index.ts import { getSheet } from "grid-cms-sdk/dist"; import { client } from "src/gridCMS" export const getStaticProps = async () => { const res = await getSheet( client, { spreadsheetId: "SPREAD_SHEET_ID", range: "SHEET_NAME", }, { pagenation: { limit: 5 // Number of data to be displayed per page, offset: 0 // Current number of pages minus 1, }, } ); return { props: { result: res.contents, total: res.totalCount, } }; }; ``` ## `Multiple contents` ```index.ts import { getSheet } from "grid-cms-sdk/dist"; import { client } from "src/gridCMS" export const getStaticProps = async () => { const results = await getSheets( client, { spreadsheetId: "SPREAD_SHEET_ID", ranges: ["sheet1", "sheet2", "sheet3"], }, // Any option { pagenation: { limit: 5, offset: 0, }, } ); return { props: { results } }; }; ``` # Request | Name | Required | Types | rescription | | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `createClient` | ✅ | `Client:{ email: string, privateKey: string }` | `email`: Your Google Service Account email.
`privateKey`: Your Google Service Account private_key. | | `getSheet` | ✅ | `Client, Option: { spreadsheetId: string; range: string; }, queries?: { pagenation: { limit: number; offset: number; } }` | `spreadsheetId`: Your spreadsheet ID.
`range`: Your shpreadsheet sheet name.
`limit`: Number of data to be displayed per page.
`offset`: Current number of pages minus 1 | | `getSheets` | ✅ | `Client, Option: { spreadsheetId: string; ranges: Array; }, queries?: { pagenation: { limit: number; offset: number; } }` | `ranges`: Your shpreadsheet sheet names. | # Response | Name | Required | Types | rescription | | -------------- | -------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `createClient` | - | JWT | JWT class in google auth library. | | `getSheet` | - | `contents: T[];`
`colms: string[];`
`totalCount: number;` | `contents`: If you add a type argument to the getSheet API, it will be returned as an array of the attached type.
`colms`: Return the first row of data with the spreadsheet.
`totalCount`: Total number of contents. | | `getSheets` | - | `Array{ contents: any[]; colms: string[]; totalCount: number; }` | `contents`: Return data from the second row onward for each spreadsheet specified in ranges as JSON.
`colms`: Returns a string array of the first row of data for each spreadsheet specified by ranges.
`totalCount`: Total number of contents for each spreadsheet specified in ranges. | --- _Source: https://npm.io/package/grid-cms-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._