Class DeveloperMetadataFinder
Page Summary
DeveloperMetadataFinder is used to search for developer metadata in a spreadsheet.
You can create a DeveloperMetadataFinder using methods on Range, Sheet, or Spreadsheet objects.
The
find()method executes the search and returns matching metadata.You can refine your search using methods like
withId(),withKey(),withLocationType(),withValue(), andwithVisibility().onIntersectingLocations()is an option specifically for range-scoped searches to consider intersecting locations with metadata.
Search for developer metadata in a spreadsheet. To create new developer metadata finder useRange.createDeveloperMetadataFinder(),Sheet.createDeveloperMetadataFinder(),orSpreadsheet.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 followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
onIntersectingLocations()
Configures the search to consider intersecting locations that have metadata. This option isonly 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.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.