Class DeveloperMetadataFinder

DeveloperMetadataFinder

Pesquisar metadados do desenvolvedor em uma planilha. Para criar um novo localizador de metadados do desenvolvedor, use Range.createDeveloperMetadataFinder(), Sheet.createDeveloperMetadataFinder() ou Spreadsheet.createDeveloperMetadataFinder().

Métodos

MétodoTipo de retornoBreve descrição
find()DeveloperMetadata[]Executa essa pesquisa e retorna os metadados correspondentes.
onIntersectingLocations()DeveloperMetadataFinderConfigura a pesquisa para considerar locais de interseção que têm metadados.
withId(id)DeveloperMetadataFinderLimita a pesquisa para considerar apenas metadados que correspondem ao ID especificado.
withKey(key)DeveloperMetadataFinderLimita a pesquisa para considerar apenas metadados que correspondem à chave especificada.
withLocationType(locationType)DeveloperMetadataFinderLimita a pesquisa para considerar apenas metadados que correspondam ao tipo de local especificado.
withValue(value)DeveloperMetadataFinderLimita a pesquisa para considerar apenas metadados que correspondam ao valor especificado.
withVisibility(visibility)DeveloperMetadataFinderLimita a pesquisa para considerar apenas metadados que correspondem à visibilidade especificada.

Documentação detalhada

find()

Executa essa pesquisa e retorna os metadados correspondentes.

Retornar

DeveloperMetadata[]: os metadados do desenvolvedor que correspondem aos critérios de pesquisa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

onIntersectingLocations()

Configura a pesquisa para considerar locais de interseção que têm metadados. Essa opção só é válida para pesquisas no escopo do intervalo.

Retornar

DeveloperMetadataFinder: o localizador de metadados do desenvolvedor, para encadeamento.


withId(id)

Limita a pesquisa para considerar apenas metadados que correspondem ao ID especificado.

Parâmetros

NomeTipoDescrição
idIntegerO ID a ser correspondido ao pesquisar metadados.

Retornar

DeveloperMetadataFinder: o localizador de metadados do desenvolvedor, para encadeamento.


withKey(key)

Limita a pesquisa para considerar apenas metadados que correspondem à chave especificada.

Parâmetros

NomeTipoDescrição
keyStringA chave a ser correspondida ao pesquisar metadados.

Retornar

DeveloperMetadataFinder: o localizador de metadados do desenvolvedor, para encadeamento.


withLocationType(locationType)

Limita a pesquisa para considerar apenas metadados que correspondam ao tipo de local especificado.

Parâmetros

NomeTipoDescrição
locationTypeDeveloperMetadataLocationTypeO tipo de local a ser correspondido ao pesquisar metadados.

Retornar

DeveloperMetadataFinder: o localizador de metadados do desenvolvedor, para encadeamento.


withValue(value)

Limita a pesquisa para considerar apenas metadados que correspondam ao valor especificado.

Parâmetros

NomeTipoDescrição
valueStringO valor a ser correspondido ao pesquisar metadados.

Retornar

DeveloperMetadataFinder: o localizador de metadados do desenvolvedor, para encadeamento.


withVisibility(visibility)

Limita a pesquisa para considerar apenas metadados que correspondem à visibilidade especificada.

Parâmetros

NomeTipoDescrição
visibilityDeveloperMetadataVisibilityA visibilidade a ser correspondida ao pesquisar metadados.

Retornar

DeveloperMetadataFinder: o localizador de metadados do desenvolvedor, para encadeamento.