node google spreadsheetダウンロード - node google spreadsheetソースコードダウンロード

node google spreadsheet

その他のソースコード

4.1.4

ダウンロード

Googleスプレッドシート

JavaScript / typescript 用の最も人気のある Google Sheets API ラッパー

複数の認証オプション (google-auth-library 経由) - サービスアカウント、OAuth、API キー、ADC など
セルベースの API - 読み取り、書き込み、一括更新、フォーマット
行ベースの API - 読み取り、更新、削除 (古い v3 の行ベースの呼び出しに基づく)
ワークシートの管理 - 追加、削除、サイズ変更、プロパティ (例: タイトル) の更新、同じドキュメントまたは他のドキュメントへの複製
ドキュメントの管理 - 新しいドキュメントの作成、ドキュメントの削除、基本的な共有/権限
エクスポート - シート/ドキュメントをさまざまな形式でダウンロードします

ドキュメントサイト -完全なドキュメントは https://theoephraim.github.io/node-google-spreadsheet で入手できます。

?インストール- pnpm i google-spreadsheet
(またはnpm i google-spreadsheet --saveまたはyarn add google-spreadsheet )

例

次の例は、実行できることのほんの一部を理解することを目的としています。

重要な注意- 例を簡潔にするために、ノードの一部の古いバージョンでは許可されていない最上位レベルで await を呼び出しています。ルートレベルのスクリプトで await を呼び出す必要があり、環境がそれをサポートしていない場合は、代わりに次のように非同期関数でラップする必要があります。

 ( async function ( ) {
  await someAsyncFunction ( ) ;
} ) ( ) ;

基本

 import { GoogleSpreadsheet } from 'google-spreadsheet' ;
import { JWT } from 'google-auth-library' ;

// Initialize auth - see https://theoephraim.github.io/node-google-spreadsheet/#/guides/authentication
const serviceAccountAuth = new JWT ( {
  // env var values here are copied from service account credentials generated by google
  // see "Authentication" section in docs for more info
  email : process . env . GOOGLE_SERVICE_ACCOUNT_EMAIL ,
  key : process . env . GOOGLE_PRIVATE_KEY ,
  scopes : [ 'https://www.googleapis.com/auth/spreadsheets' ] ,
} ) ;

const doc = new GoogleSpreadsheet ( '<the sheet ID from the url>' , serviceAccountAuth ) ;

await doc . loadInfo ( ) ; // loads document properties and worksheets
console . log ( doc . title ) ;
await doc . updateProperties ( { title : 'renamed doc' } ) ;

const sheet = doc . sheetsByIndex [ 0 ] ; // or use `doc.sheetsById[id]` or `doc.sheetsByTitle[title]`
console . log ( sheet . title ) ;
console . log ( sheet . rowCount ) ;

// adding / removing sheets
const newSheet = await doc . addSheet ( { title : 'another sheet' } ) ;
await newSheet . delete ( ) ;

詳細情報:

Googleスプレッドシート
Googleスプレッドシートワークシート
認証

行の操作

 // if creating a new sheet, you can set the header row
const sheet = await doc . addSheet ( { headerValues : [ 'name' , 'email' ] } ) ;

// append rows
const larryRow = await sheet . addRow ( { name : 'Larry Page' , email : '[email protected]' } ) ;
const moreRows = await sheet . addRows ( [
  { name : 'Sergey Brin' , email : '[email protected]' } ,
  { name : 'Eric Schmidt' , email : '[email protected]' } ,
] ) ;

// read rows
const rows = await sheet . getRows ( ) ; // can pass in { limit, offset }

// read/write row values
console . log ( rows [ 0 ] . get ( 'name' ) ) ; // 'Larry Page'
rows [ 1 ] . set ( 'email' , '[email protected]' ) ; // update a value
rows [ 2 ] . assign ( { name : 'Sundar Pichai' , email : '[email protected]' } ) ; // set multiple values
await rows [ 2 ] . save ( ) ; // save updates on a row
await rows [ 2 ] . delete ( ) ; // delete a row

Row メソッドは、データの形状について明示的な TypeScript タイプをサポートします。

 type UsersRowData = {
  name : string ;
  email : string ;
  type ?: 'admin' | 'user' ;
} ;
const userRows = await sheet . getRows < UsersRowData > ( ) ;

userRows [ 0 ] . get ( 'name' ) ; // <- TS is happy, knows it will be a string
userRows [ 0 ] . get ( 'badColumn' ) ; // <- will throw a type error

詳細情報:

GoogleSpreadsheetワークシート > 行の操作
Googleスプレッドシート行

細胞を扱う

 await sheet . loadCells ( 'A1:E10' ) ; // loads range of cells into local cache - DOES NOT RETURN THE CELLS
console . log ( sheet . cellStats ) ; // total cells, loaded, how many non-empty
const a1 = sheet . getCell ( 0 , 0 ) ; // access cells using a zero-based index
const c6 = sheet . getCellByA1 ( 'C6' ) ; // or A1 style notation
// access everything about the cell
console . log ( a1 . value ) ;
console . log ( a1 . formula ) ;
console . log ( a1 . formattedValue ) ;
// update the cell contents and formatting
a1 . value = 123.456 ;
c6 . formula = '=A1' ;
a1 . textFormat = { bold : true } ;
c6 . note = 'This is a note!' ;
await sheet . saveUpdatedCells ( ) ; // save all updates in one call

詳細情報:

GoogleSpreadsheetワークシート > セルの操作
Googleスプレッドシートセル

ドキュメントの管理と共有

 const auth = new JWT ( {
  email : process . env . GOOGLE_SERVICE_ACCOUNT_EMAIL ,
  key : process . env . GOOGLE_PRIVATE_KEY ,
  scopes : [
    'https://www.googleapis.com/auth/spreadsheets' ,
    // note that sharing-related calls require the google drive scope
    'https://www.googleapis.com/auth/drive.file' ,
  ] ,
} ) ;

// create a new doc
const newDoc = await GoogleSpreadsheet . createNewSpreadsheetDocument ( auth , { title : 'new fancy doc' } ) ;

// share with specific users, domains, or make public
await newDoc . share ( '[email protected]' ) ;
await newDoc . share ( 'mycorp.com' ) ;
await newDoc . setPublicAccessLevel ( 'reader' ) ;

// delete doc
await newDoc . delete ( ) ;

なぜ？

このモジュールは、一般的な操作を簡素化するための Google API の直感的なラッパーを提供します

Google の v4 シート API は v3 よりもはるかに使いやすくなっていますが、公式の googleapis npm モジュールは、あらゆる Google 製品を処理する巨大な自動生成メタツールです。モジュールと API 自体は扱いにくく、ドキュメントは少なくとも使い始めるにはかなりひどいものです。

どのような状況で Google の API を直接使用する必要がありますか?
このモジュールは、インターフェースの簡素化とトレードオフを行います。 Google の API は、多くのリクエストを並行して実行するメカニズムを提供しているため、ユースケースにとって速度と効率が非常に重要である場合は、Google の API を直接使用することをお勧めします。 API には、ここではまだ実装されていない、あまり使用されていない機能も多数あります。

サポートと貢献

このモジュールは Theo Ephraim によって作成され、積極的に保守されています。

このモジュールを商用プロジェクトに積極的に使用していますか?それをサポートしてみませんか?
テオにビールを買ってあげる

スポンサー

まだありません - 連絡してください!

貢献する

貢献は歓迎されますが、既存の規則に従い、リンターを使用し、関連するテストを追加し、関連するドキュメントを追加してください。

ドキュメントサイトは docsify を使用して生成されます。ローカルでプレビューして実行して編集できるようにするには、 npm run docs:previewを実行して http://localhost:3000 にアクセスします。コンテンツは docs フォルダー内のマークダウンファイルに存在します。