Get
|
|||||
|
|
||||
Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, edit, create, and delete all of your Google Drive files
- View and manage Google Drive files and folders that you have opened or created with this app
- View and manage your spreadsheets in Google Drive
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
spreadsheetId Required |
STRING |
The ID of the spreadsheet to retrieve metadata from |
metadataId Required |
INTEGER |
The ID of the developer metadata to retrieve |
= Parameter name
= Format
|
spreadsheetId STRING Required The ID of the spreadsheet to retrieve metadata from |
|
metadataId INTEGER Required The ID of the developer metadata to retrieve |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
metadataId |
INTEGER |
The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive |
location |
OBJECT |
A location where metadata may be associated in a spreadsheet |
location.dimensionRange |
OBJECT |
A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side |
location.dimensionRange.startIndex |
INTEGER |
The start (inclusive) of the span, or not set if unbounded |
location.dimensionRange.endIndex |
INTEGER |
The end (exclusive) of the span, or not set if unbounded |
location.dimensionRange.sheetId |
INTEGER |
The sheet this span is on |
location.dimensionRange.dimension |
ENUMERATION |
The dimension of the span |
location.spreadsheet |
BOOLEAN |
True when metadata is associated with an entire spreadsheet |
location.sheetId |
INTEGER |
The ID of the sheet when metadata is associated with an entire sheet |
location.locationType |
ENUMERATION |
The type of location this object represents. This field is read-only |
visibility |
ENUMERATION |
The metadata visibility. Developer metadata must always have a visibility specified |
metadataValue |
STRING |
Data associated with the metadata's key |
metadataKey |
STRING |
The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified |
= Parameter name
= Format
|
metadataId INTEGER The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive |
|
location OBJECT A location where metadata may be associated in a spreadsheet |
|
location.dimensionRange OBJECT A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side |
|
location.dimensionRange.startIndex INTEGER The start (inclusive) of the span, or not set if unbounded |
|
location.dimensionRange.endIndex INTEGER The end (exclusive) of the span, or not set if unbounded |
|
location.dimensionRange.sheetId INTEGER The sheet this span is on |
|
location.dimensionRange.dimension ENUMERATION The dimension of the span |
|
location.spreadsheet BOOLEAN True when metadata is associated with an entire spreadsheet |
|
location.sheetId INTEGER The ID of the sheet when metadata is associated with an entire sheet |
|
location.locationType ENUMERATION The type of location this object represents. This field is read-only |
|
visibility ENUMERATION The metadata visibility. Developer metadata must always have a visibility specified |
|
metadataValue STRING Data associated with the metadata's key |
|
metadataKey STRING The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified |