[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["\u003cp\u003eDeveloperMetadataFinder allows you to search for developer metadata within a spreadsheet by key, value, ID, location type, or visibility.\u003c/p\u003e\n"],["\u003cp\u003eUse \u003ccode\u003ecreateDeveloperMetadataFinder()\u003c/code\u003e on a Range, Sheet, or Spreadsheet object to initiate a search.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003efind()\u003c/code\u003e executes the search and returns an array of matching DeveloperMetadata objects.\u003c/p\u003e\n"],["\u003cp\u003eYou can refine searches using methods like \u003ccode\u003ewithId()\u003c/code\u003e, \u003ccode\u003ewithKey()\u003c/code\u003e, \u003ccode\u003ewithValue()\u003c/code\u003e, \u003ccode\u003ewithLocationType()\u003c/code\u003e, and \u003ccode\u003ewithVisibility()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eonIntersectingLocations()\u003c/code\u003e configures the search to consider intersecting locations that have metadata, but is only applicable for range-scoped searches.\u003c/p\u003e\n"]]],[],null,["# Class DeveloperMetadataFinder\n\nDeveloperMetadataFinder\n\nSearch for developer metadata in a spreadsheet. To create new developer metadata finder use\n[Range.createDeveloperMetadataFinder()](/apps-script/reference/spreadsheet/range#createDeveloperMetadataFinder()), [Sheet.createDeveloperMetadataFinder()](/apps-script/reference/spreadsheet/sheet#createDeveloperMetadataFinder()),\nor [Spreadsheet.createDeveloperMetadataFinder()](/apps-script/reference/spreadsheet/spreadsheet#createDeveloperMetadataFinder()). \n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|\n| [find()](#find()) | [DeveloperMetadata[]](/apps-script/reference/spreadsheet/developer-metadata) | Executes this search and returns the matching metadata. |\n| [onIntersectingLocations()](#onIntersectingLocations()) | [DeveloperMetadataFinder](#) | Configures the search to consider intersecting locations that have metadata. |\n| [withId(id)](#withId(Integer)) | [DeveloperMetadataFinder](#) | Limits this search to consider only metadata that match the specified ID. |\n| [withKey(key)](#withKey(String)) | [DeveloperMetadataFinder](#) | Limits this search to consider only metadata that match the specified key. |\n| [withLocationType(locationType)](#withLocationType(DeveloperMetadataLocationType)) | [DeveloperMetadataFinder](#) | Limits this search to consider only metadata that match the specified location type. |\n| [withValue(value)](#withValue(String)) | [DeveloperMetadataFinder](#) | Limits this search to consider only metadata that match the specified value. |\n| [withVisibility(visibility)](#withVisibility(DeveloperMetadataVisibility)) | [DeveloperMetadataFinder](#) | Limits this search to consider only metadata that match the specified visibility. |\n\nDetailed documentation\n----------------------\n\n### `find()`\n\nExecutes this search and returns the matching metadata.\n\n#### Return\n\n\n[DeveloperMetadata[]](/apps-script/reference/spreadsheet/developer-metadata) --- The developer metadata that match the search criteria.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `on``Intersecting``Locations()`\n\nConfigures the search to consider intersecting locations that have metadata. This option is\nonly valid for range-scoped searches.\n\n#### Return\n\n\n[DeveloperMetadataFinder](#) --- The developer metadata finder, for chaining.\n\n*** ** * ** ***\n\n### `with``Id(id)`\n\nLimits this search to consider only metadata that match the specified ID.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|-----------|----------------------------------------------|\n| `id` | `Integer` | The ID to match when searching for metadata. |\n\n#### Return\n\n\n[DeveloperMetadataFinder](#) --- The developer metadata finder, for chaining.\n\n*** ** * ** ***\n\n### `with``Key(key)`\n\nLimits this search to consider only metadata that match the specified key.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|-----------------------------------------------|\n| `key` | `String` | The key to match when searching for metadata. |\n\n#### Return\n\n\n[DeveloperMetadataFinder](#) --- The developer metadata finder, for chaining.\n\n*** ** * ** ***\n\n### `with``Location``Type(locationType)`\n\nLimits this search to consider only metadata that match the specified location type.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------------|------------------------------------------------------------------------------------------------------|---------------------------------------------------------|\n| `location``Type` | [DeveloperMetadataLocationType](/apps-script/reference/spreadsheet/developer-metadata-location-type) | The location type to match when searching for metadata. |\n\n#### Return\n\n\n[DeveloperMetadataFinder](#) --- The developer metadata finder, for chaining.\n\n*** ** * ** ***\n\n### `with``Value(value)`\n\nLimits this search to consider only metadata that match the specified value.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|-------------------------------------------------|\n| `value` | `String` | The value to match when searching for metadata. |\n\n#### Return\n\n\n[DeveloperMetadataFinder](#) --- The developer metadata finder, for chaining.\n\n*** ** * ** ***\n\n### `with``Visibility(visibility)`\n\nLimits this search to consider only metadata that match the specified visibility.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------|\n| `visibility` | [DeveloperMetadataVisibility](/apps-script/reference/spreadsheet/developer-metadata-visibility) | The visibility to match when searching for metadata. |\n\n#### Return\n\n\n[DeveloperMetadataFinder](#) --- The developer metadata finder, for chaining."]]
