Search
|
|||||
|
|
||||
Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region
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 20 input parameters
| Name | Format | Description |
|---|---|---|
spreadsheetId Required |
STRING |
The ID of the spreadsheet to retrieve metadata from |
dataFilters[] |
OBJECT |
Filter that describes what data should be selected or returned from a request |
dataFilters[].developerMetadataLookup |
OBJECT |
Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified |
dataFilters[].developerMetadataLookup.metadataLocation |
OBJECT |
A location where metadata may be associated in a spreadsheet |
dataFilters[].developerMetadataLookup.metadataLocation.spreadsheet |
BOOLEAN |
True when metadata is associated with an entire spreadsheet |
dataFilters[].developerMetadataLookup.metadataLocation.sheetId |
INTEGER |
The ID of the sheet when metadata is associated with an entire sheet |
dataFilters[].developerMetadataLookup.metadataLocation.locationType |
ENUMERATION |
The type of location this object represents. This field is read-only |
dataFilters[].developerMetadataLookup.locationMatchingStrategy |
ENUMERATION |
Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified |
dataFilters[].developerMetadataLookup.locationType |
ENUMERATION |
Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT |
dataFilters[].developerMetadataLookup.metadataKey |
STRING |
Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key |
dataFilters[].developerMetadataLookup.metadataId |
INTEGER |
Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id |
dataFilters[].developerMetadataLookup.visibility |
ENUMERATION |
Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered |
dataFilters[].developerMetadataLookup.metadataValue |
STRING |
Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value |
dataFilters[].a1Range |
STRING |
Selects data that matches the specified A1 range |
dataFilters[].gridRange |
OBJECT |
A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if
The start index must always be less than or equal to the end index.
If the start index equals the end index, then the range is empty.
Empty ranges are typically not meaningful and are usually rendered in the
UI as |
dataFilters[].gridRange.startRowIndex |
INTEGER |
The start row (inclusive) of the range, or not set if unbounded |
dataFilters[].gridRange.startColumnIndex |
INTEGER |
The start column (inclusive) of the range, or not set if unbounded |
dataFilters[].gridRange.sheetId |
INTEGER |
The sheet this range is on |
dataFilters[].gridRange.endRowIndex |
INTEGER |
The end row (exclusive) of the range, or not set if unbounded |
dataFilters[].gridRange.endColumnIndex |
INTEGER |
The end column (exclusive) of the range, or not set if unbounded |
= Parameter name
= Format
|
spreadsheetId STRING Required The ID of the spreadsheet to retrieve metadata from |
|
dataFilters[] OBJECT Filter that describes what data should be selected or returned from a request |
|
dataFilters[].developerMetadataLookup OBJECT Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified |
|
dataFilters[].developerMetadataLookup.metadataLocation OBJECT A location where metadata may be associated in a spreadsheet |
|
dataFilters[].developerMetadataLookup.metadataLocation.spreadsheet BOOLEAN True when metadata is associated with an entire spreadsheet |
|
dataFilters[].developerMetadataLookup.metadataLocation.sheetId INTEGER The ID of the sheet when metadata is associated with an entire sheet |
|
dataFilters[].developerMetadataLookup.metadataLocation.locationType ENUMERATION The type of location this object represents. This field is read-only |
|
dataFilters[].developerMetadataLookup.locationMatchingStrategy ENUMERATION Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified |
|
dataFilters[].developerMetadataLookup.locationType ENUMERATION Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT |
|
dataFilters[].developerMetadataLookup.metadataKey STRING Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key |
|
dataFilters[].developerMetadataLookup.metadataId INTEGER Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id |
|
dataFilters[].developerMetadataLookup.visibility ENUMERATION Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered |
|
dataFilters[].developerMetadataLookup.metadataValue STRING Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value |
|
dataFilters[].a1Range STRING Selects data that matches the specified A1 range |
|
dataFilters[].gridRange OBJECT A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if
The start index must always be less than or equal to the end index.
If the start index equals the end index, then the range is empty.
Empty ranges are typically not meaningful and are usually rendered in the
UI as |
|
dataFilters[].gridRange.startRowIndex INTEGER The start row (inclusive) of the range, or not set if unbounded |
|
dataFilters[].gridRange.startColumnIndex INTEGER The start column (inclusive) of the range, or not set if unbounded |
|
dataFilters[].gridRange.sheetId INTEGER The sheet this range is on |
|
dataFilters[].gridRange.endRowIndex INTEGER The end row (exclusive) of the range, or not set if unbounded |
|
dataFilters[].gridRange.endColumnIndex INTEGER The end column (exclusive) of the range, or not set if unbounded |
Output
This building block provides 14 output parameters
| Name | Format | Description |
|---|---|---|
matchedDeveloperMetadata[] |
OBJECT |
A developer metadata entry and the data filters specified in the original request that matched it |
matchedDeveloperMetadata[].dataFilters[] |
OBJECT |
Filter that describes what data should be selected or returned from a request |
matchedDeveloperMetadata[].dataFilters[].developerMetadataLookup |
OBJECT |
Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified |
matchedDeveloperMetadata[].dataFilters[].a1Range |
STRING |
Selects data that matches the specified A1 range |
matchedDeveloperMetadata[].dataFilters[].gridRange |
OBJECT |
A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if
The start index must always be less than or equal to the end index.
If the start index equals the end index, then the range is empty.
Empty ranges are typically not meaningful and are usually rendered in the
UI as |
matchedDeveloperMetadata[].developerMetadata |
OBJECT |
Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too |
matchedDeveloperMetadata[].developerMetadata.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 |
matchedDeveloperMetadata[].developerMetadata.location |
OBJECT |
A location where metadata may be associated in a spreadsheet |
matchedDeveloperMetadata[].developerMetadata.location.spreadsheet |
BOOLEAN |
True when metadata is associated with an entire spreadsheet |
matchedDeveloperMetadata[].developerMetadata.location.sheetId |
INTEGER |
The ID of the sheet when metadata is associated with an entire sheet |
matchedDeveloperMetadata[].developerMetadata.location.locationType |
ENUMERATION |
The type of location this object represents. This field is read-only |
matchedDeveloperMetadata[].developerMetadata.visibility |
ENUMERATION |
The metadata visibility. Developer metadata must always have a visibility specified |
matchedDeveloperMetadata[].developerMetadata.metadataValue |
STRING |
Data associated with the metadata's key |
matchedDeveloperMetadata[].developerMetadata.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
|
matchedDeveloperMetadata[] OBJECT A developer metadata entry and the data filters specified in the original request that matched it |
|
matchedDeveloperMetadata[].dataFilters[] OBJECT Filter that describes what data should be selected or returned from a request |
|
matchedDeveloperMetadata[].dataFilters[].developerMetadataLookup OBJECT Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified |
|
matchedDeveloperMetadata[].dataFilters[].a1Range STRING Selects data that matches the specified A1 range |
|
matchedDeveloperMetadata[].dataFilters[].gridRange OBJECT A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if
The start index must always be less than or equal to the end index.
If the start index equals the end index, then the range is empty.
Empty ranges are typically not meaningful and are usually rendered in the
UI as |
|
matchedDeveloperMetadata[].developerMetadata OBJECT Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too |
|
matchedDeveloperMetadata[].developerMetadata.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 |
|
matchedDeveloperMetadata[].developerMetadata.location OBJECT A location where metadata may be associated in a spreadsheet |
|
matchedDeveloperMetadata[].developerMetadata.location.spreadsheet BOOLEAN True when metadata is associated with an entire spreadsheet |
|
matchedDeveloperMetadata[].developerMetadata.location.sheetId INTEGER The ID of the sheet when metadata is associated with an entire sheet |
|
matchedDeveloperMetadata[].developerMetadata.location.locationType ENUMERATION The type of location this object represents. This field is read-only |
|
matchedDeveloperMetadata[].developerMetadata.visibility ENUMERATION The metadata visibility. Developer metadata must always have a visibility specified |
|
matchedDeveloperMetadata[].developerMetadata.metadataValue STRING Data associated with the metadata's key |
|
matchedDeveloperMetadata[].developerMetadata.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 |