Google Sheets

Pull rows from a Google Sheet straight into your page. Access via sdk.sheets.

Quick start

const sdk = await ShareOut.create();

if (!await sdk.sheets.isConnected()) {
  const ok = await sdk.sheets.authorize();   // opens OAuth popup
  if (!ok) return;
}

const { data, headers, rowCount } = await sdk.sheets.fetch({
  spreadsheetUrl: 'https://docs.google.com/spreadsheets/d/ABC123/edit',
  range: 'Sheet1',
  headers: true,
});

Methods

getAuthUrl(returnUrl?): Promise<{ authUrl, message }>
authorize(returnUrl?): Promise<boolean>
isConnected(): Promise<boolean>
fetch({ spreadsheetUrl?, spreadsheetId?, range?, headers? }): Promise<{ data, headers?, rowCount }>

Pass either spreadsheetUrl or spreadsheetId. With headers: true, each row becomes an object keyed by the first row’s column names.

Cache the result

Fetch once, store in sdk.json, and render from there so navigation doesn’t refetch:

const { data } = await sdk.sheets.fetch({ spreadsheetId: 'ID', range: 'Data!A1:Z100', headers: true });
await sdk.json.set('sheetsData', { data, fetchedAt: Date.now() });

Errors

Code	Meaning
SHEETS_NOT_CONNECTED	OAuth not completed — call authorize()
SHEETS_ACCESS_DENIED	The sheet isn’t shared with the connected account
FETCH_ERROR	Google Sheets API error