ssgetSheetByNameData

ssgetSheetByNameData is a utility function used in spreadsheet automation libraries to retrieve data from a sheet by its name within a given spreadsheet. It returns the sheet’s contents as a two-dimensional array of values, suitable for programmatic processing.

Typically, the function accepts two arguments: a reference to the spreadsheet (either as an object or an identifier) and a string that specifies the sheet name. It locates the sheet by name, reads the relevant data region (often the used range or a defined data area), and returns the values. If the named sheet does not exist, the behavior varies by implementation; some versions throw an error while others return null or an empty array.

Return value and options: The primary return is a 2D array where each sub-array represents a row of values. Some variants offer optional parameters to include or exclude header rows, trim empty trailing rows, or limit the number of rows read. This flexibility makes the function useful for extracting data for analysis, transformation, or export tasks.

Usage notes: The function is commonly employed in scripts that need to import tabular data from named sheets into processing pipelines. Performance can be affected by sheet size, so users should be mindful of large sheets and consider optional data-limiting features if available.

See also: getSheetByName, getDataRange, getValues, and related spreadsheet APIs.