QuerySpreadsheets Method

Queries a Google Spreadsheets feed using the specified parameters.

Syntax

gspreadsheets.querySpreadsheets([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Queries a Google Spreadsheets feed using the specified QueryParams. To fetch a Google Spreadsheets feed, without filtering any of the spreadsheets, you can call QuerySpreadsheets without adding any parameters to QueryParams.

The spreadsheet feed contents are delivered through the Transfer event. The response headers can be retrieved via the ParsedHeaders property as well as through the Header event.

The class will then attempt to parse the Google Spreadsheets feed. Upon successfully parsing the response, FeedProperties will be set with their associated feed element values. The SpreadsheetList event will fire once for each spreadsheet and the following properties will also be populated (SpreadsheetIndex is used to navigate the returned documents):