DeveloperMetadataFinder

Search for developer metadata in a spreadsheet. To create new developer metadata finder use
`https://developers.google.com/apps-script/reference/spreadsheet/range#createDeveloperMetadataFinder()`, `https://developers.google.com/apps-script/reference/spreadsheet/sheet#createDeveloperMetadataFinder()`,
or `https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#createDeveloperMetadataFinder()`.

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#find()` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata` | Executes this search and returns the matching metadata. |
| `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#onIntersectingLocations()` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` | Configures the search to consider intersecting locations that have metadata. |
| `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#withId(Integer)` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` | Limits this search to consider only metadata that match the specified ID. |
| `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#withKey(String)` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` | Limits this search to consider only metadata that match the specified key. |
| `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#withLocationType(DeveloperMetadataLocationType)` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` | Limits this search to consider only metadata that match the specified location type. |
| `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#withValue(String)` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` | Limits this search to consider only metadata that match the specified value. |
| `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#withVisibility(DeveloperMetadataVisibility)` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` | Limits this search to consider only metadata that match the specified visibility. |

## Detailed documentation

### `find()`

Executes this search and returns the matching metadata.

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata` --- 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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


`https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` --- 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


`https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` --- 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


`https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` --- 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 |
|---|---|---|
| `locationType` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-location-type` | The location type to match when searching for metadata. |

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` --- 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


`https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` --- 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` | `https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-visibility` | The visibility to match when searching for metadata. |

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/developer-metadata-finder#` --- The developer metadata finder, for chaining.