Class DeveloperMetadataFinder
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
DeveloperMetadataFinder allows you to search for developer metadata within a spreadsheet by key, value, ID, location type, or visibility.
-
Use
createDeveloperMetadataFinder()on a Range, Sheet, or Spreadsheet object to initiate a search. -
find()executes the search and returns an array of matching DeveloperMetadata objects. -
You can refine searches using methods like
withId(),withKey(),withValue(),withLocationType(), andwithVisibility(). -
onIntersectingLocations()configures the search to consider intersecting locations that have metadata, but is only applicable for range-scoped searches.
Search for developer metadata in a spreadsheet. To create new developer metadata finder use
Range.createDeveloperMetadataFinder() , Sheet.createDeveloperMetadataFinder() ,
or Spreadsheet.createDeveloperMetadataFinder() .
Methods
| Method | Return type | Brief description |
|---|---|---|
find() | Developer | Executes this search and returns the matching metadata. |
on | Developer | Configures the search to consider intersecting locations that have metadata. |
with | Developer | Limits this search to consider only metadata that match the specified ID. |
with | Developer | Limits this search to consider only metadata that match the specified key. |
with | Developer | Limits this search to consider only metadata that match the specified location type. |
with | Developer | Limits this search to consider only metadata that match the specified value. |
with | Developer | Limits this search to consider only metadata that match the specified visibility. |
Detailed documentation
find()
Executes this search and returns the matching metadata.
Return
Developer — The developer metadata that match the search criteria.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
onIntersectingLocations()
Configures the search to consider intersecting locations that have metadata. This option is only valid for range-scoped searches.
Return
Developer — The developer metadata finder, for chaining.
withId(id)
Limits this search to consider only metadata that match the specified ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | Integer | The ID to match when searching for metadata. |
Return
Developer — The developer metadata finder, for chaining.
withKey(key)
Limits this search to consider only metadata that match the specified key.
Parameters
| Name | Type | Description |
|---|---|---|
key | String | The key to match when searching for metadata. |
Return
Developer — The developer metadata finder, for chaining.
withLocationType(locationType)
Limits this search to consider only metadata that match the specified location type.
Parameters
| Name | Type | Description |
|---|---|---|
location | Developer | The location type to match when searching for metadata. |
Return
Developer — The developer metadata finder, for chaining.
withValue(value)
Limits this search to consider only metadata that match the specified value.
Parameters
| Name | Type | Description |
|---|---|---|
value | String | The value to match when searching for metadata. |
Return
Developer — The developer metadata finder, for chaining.
withVisibility(visibility)
Limits this search to consider only metadata that match the specified visibility.
Parameters
| Name | Type | Description |
|---|---|---|
visibility | Developer | The visibility to match when searching for metadata. |
Return
Developer — The developer metadata finder, for chaining.