requireValidSpreadsheetId

function requireValidSpreadsheetId(value: unknown, message?: string): string;

At least 25 characters of letters, digits, hyphens and underscores — the id that sits in a spreadsheet URL between /d/ and /edit. Nothing is fetched: the format is all that is checked.

isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.

Parameters

Parameter	Type	Description
`value`	`unknown`	The value to validate.
`message` (optional)	`string`	The message of the exception. A default is used when omitted.

Returns

string — the same value, typed as a spreadsheet id.

Throws

Exception	Condition
`IllegalArgumentException`	the value is not a spreadsheet id.

Examples

What passes and what does not

requireValidSpreadsheetId("1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms"); // => "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms"
requireValidSpreadsheetId("short-id"); // throws IllegalArgumentException
requireValidSpreadsheetId("has space in it and is long enough to pass"); // throws IllegalArgumentException

Source

src/appsscript/sheet/requireValidSpreadsheetId.ts

23 September 2026

This documentation was generated with AI (Claude) from the library's source code.

apps-script-utils 2.1.1 Help