{"id":20493260,"url":"https://github.com/segment-boneyard/google-spreadsheets","last_synced_at":"2025-04-13T17:20:37.603Z","repository":{"id":12549564,"uuid":"15219737","full_name":"segment-boneyard/google-spreadsheets","owner":"segment-boneyard","description":"A nicer Google Spreadsheets API for node.","archived":false,"fork":false,"pushed_at":"2015-02-10T19:14:04.000Z","size":174,"stargazers_count":51,"open_issues_count":3,"forks_count":5,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-04-13T14:05:46.603Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/segment-boneyard.png","metadata":{"files":{"readme":"Readme.md","changelog":"History.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-12-16T07:34:03.000Z","updated_at":"2025-02-20T08:55:48.000Z","dependencies_parsed_at":"2022-09-25T04:30:59.999Z","dependency_job_id":null,"html_url":"https://github.com/segment-boneyard/google-spreadsheets","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-boneyard%2Fgoogle-spreadsheets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-boneyard%2Fgoogle-spreadsheets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-boneyard%2Fgoogle-spreadsheets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-boneyard%2Fgoogle-spreadsheets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/segment-boneyard","download_url":"https://codeload.github.com/segment-boneyard/google-spreadsheets/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248750666,"owners_count":21155764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T17:34:06.306Z","updated_at":"2025-04-13T17:20:37.563Z","avatar_url":"https://github.com/segment-boneyard.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Google Spreadsheets\n\n  A nicer Google Spreadsheets API for node. Supports batched reads and writes.\n\n## Installation\n\n    $ npm install segmentio/google-spreadsheets\n\n## Examples\n\n### Open Spreadsheet\n\n```js\nvar spreadsheets = require('google-spreadsheets');\n\nspreadsheets()\n  .login('username', 'password')\n  .key('0AvP3ixW_RotVdHdnWDZvUHhnWWhHQy0xZFViN3hUSmc')\n  .open(function (err, spreadsheet) {\n\n  });\n```\n\n```js\nspreadsheets()\n  .login('username', 'password')\n  .name('Segment.io Users')\n  .open(function (err, spreadsheet) {\n    \n  });\n```\n\n\n### Select Worksheet\n\n```js\nvar sheet = spreadsheet.select('id');\n```\n\nor full example:\n\n```js\nspreadsheets()\n  .login('username', 'password')\n  .key('0AvP3ixW_RotVdHdnWDZvUHhnWWhHQy0xZFViN3hUSmc')\n  .open(function (err, spreadsheet) {\n    var worksheets = spreadsheet.worksheets;\n    var worksheet = spreadsheet.select(worksheets[0].id);\n    console.log(worksheet);\n    /*\n    {\n      id: 'od6',\n      name: 'Sheet1',\n      columnCount: 20,\n      rowCount: 20\n    }\n    */\n  });\n```\n\n### Get Cells\n\n```js\nworksheet.query()\n  .cell(1, 1)\n  .cell(1, 2)\n  .get(function (err, cells) {\n    console.log(cells);\n    // [\n    //   {row: 1, column: 1, value: 'something', text: 'something'},\n    //   {row: 1, column: 2, value: '=R[-1]C/12', text: '$18233.33', numeric: 18233.33 }\n    // ]\n});\n```\n\n### Update Rows\n\n```js\nworksheet.update()\n  .cell(1, 3, 'hello')\n  .cell(1, 4, 'hello2')\n  .send(function (err) {\n    \n});\n```\n\n### Query Worksheet Metadata\n\n```js\nworksheet.metadata(function (err, metadata) {\n  console.log(metadata);\n  /*\n  {\n    id: 'od6',\n    name: 'Sheet1',\n    columnCount: 20,\n    rowCount: 20\n  }\n  */\n});\n```\n\n## API\n\n### Spreadsheets\n\n#### .login(username, password)\n\n  Adds a client-login authentication password for the Google Spreadsheets service.\n\n#### .key(key)\n\n  Creates an open query for a spreadsheet with `key`.\n\n#### .name(name)\n\n  Creates an open query for a spreadsheet with `name`.\n\n#### .open(callback)\n\n  Executes the spreadsheet open query.\n\n### Spreadsheet\n\n#### .worksheets\n\n  An array of worksheets accessible on the spreadsheet.\n\n#### .select(id)\n\n  Return a worksheet with `id` within the spreadsheet.\n\n### Worksheet\n\n#### .query()\n\n  Creates a worksheet `CellQuery`.\n\n#### .update()\n\n  Creates a worksheet `UpdateQuery`.\n\n#### .metadata(callback)\n\n  Queries for a worksheet's metadata.\n\n### CellQuery\n\n#### .cell(row, column)\n\n  Adds a cell to lookup within the `CellQuery`.\n\n#### .get(callback)\n\n  Executes the `CellQuery`.\n\n### UpdateQuery\n\n#### .cell(row, column, val)\n\n  Adds a cell to update to the batch update query.\n\n#### .send(callback)\n\n  Sends the cell update batch query.\n\n## License\n\n```\nWWWWWW||WWWWWW\n W W W||W W W\n      ||\n    ( OO )__________\n     /  |           \\\n    /o o|    MIT     \\\n    \\___/||_||__||_|| *\n         || ||  || ||\n        _||_|| _||_||\n       (__|__|(__|__|\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsegment-boneyard%2Fgoogle-spreadsheets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsegment-boneyard%2Fgoogle-spreadsheets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsegment-boneyard%2Fgoogle-spreadsheets/lists"}