WorksheetETag Property

The ETag of the current worksheet in a Google Worksheet feed.

Syntax

 gspreadsheets.getWorksheetETag([callback])
 gspreadsheets.setWorksheetETag( worksheetETag, [callback])

Default Value

""

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 the getWorksheetETag([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setWorksheetETag([callback]) 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

This property is used to obtain the ETag of the specified worksheet within a Google Worksheet feed and will be populated once WorksheetIndex is set.

This property is also used when querying worksheets. When WorksheetETag contains a non-empty string, an "If-None-Match" header will be sent with the entered value when QueryWorksheets is called. This allows you to perform conditional retrievals in the case that you only want to list a worksheet if it has been modified (e.g. contains a different ETag value).

This property is not available at design time.

Data Type

String