Class DeveloperMetadataFinder

DeveloperMetadataFinder

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()
DeveloperMetadata[] Executes this search and returns the matching metadata.
onIntersectingLocations()
DeveloperMetadataFinder Configures the search to consider intersecting locations that have metadata.
withId(id)
DeveloperMetadataFinder Limits this search to consider only metadata that match the specified ID.
withKey(key)
DeveloperMetadataFinder Limits this search to consider only metadata that match the specified key.
withLocationType(locationType)
DeveloperMetadataFinder Limits this search to consider only metadata that match the specified location type.
withValue(value)
DeveloperMetadataFinder Limits this search to consider only metadata that match the specified value.
withVisibility(visibility)
DeveloperMetadataFinder Limits this search to consider only metadata that match the specified visibility.

Detailed documentation

find()

Executes this search and returns the matching metadata.

Return

DeveloperMetadata[] — 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

DeveloperMetadataFinder — 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

DeveloperMetadataFinder — 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

DeveloperMetadataFinder — 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
DeveloperMetadataLocationType The location type to match when searching for metadata.

Return

DeveloperMetadataFinder — 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

DeveloperMetadataFinder — 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
DeveloperMetadataVisibility The visibility to match when searching for metadata.

Return

DeveloperMetadataFinder — The developer metadata finder, for chaining.