Pesquise os 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étodo | Tipo de retorno | Breve descrição |
---|---|---|
find() | DeveloperMetadata[] | Executa essa pesquisa e retorna os metadados correspondentes. |
onIntersectingLocations() | DeveloperMetadataFinder | Configura a pesquisa para considerar a interseção de locais com metadados. |
withId(id) | DeveloperMetadataFinder | Limita essa pesquisa a considerar apenas metadados que correspondem ao ID especificado. |
withKey(key) | DeveloperMetadataFinder | Limita essa pesquisa a considerar apenas os metadados que correspondem à chave especificada. |
withLocationType(locationType) | DeveloperMetadataFinder | Limita essa pesquisa a considerar apenas metadados que correspondem ao tipo de local especificado. |
withValue(value) | DeveloperMetadataFinder | Limita essa pesquisa a considerar apenas metadados que correspondem ao valor especificado. |
withVisibility(visibility) | DeveloperMetadataFinder | Limita essa pesquisa a considerar apenas os 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 a interseção de locais com 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 essa pesquisa a considerar apenas metadados que correspondem ao ID especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
id | Integer | O ID que será correspondente ao pesquisar metadados. |
Retornar
DeveloperMetadataFinder
: o localizador de metadados do desenvolvedor para encadeamento.
withKey(key)
Limita essa pesquisa a considerar apenas os metadados que correspondem à chave especificada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave para corresponder ao pesquisar metadados. |
Retornar
DeveloperMetadataFinder
: o localizador de metadados do desenvolvedor para encadeamento.
withLocationType(locationType)
Limita essa pesquisa a considerar apenas metadados que correspondem ao tipo de local especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
locationType | DeveloperMetadataLocationType | O tipo de local para corresponder ao pesquisar metadados. |
Retornar
DeveloperMetadataFinder
: o localizador de metadados do desenvolvedor para encadeamento.
withValue(value)
Limita essa pesquisa a considerar apenas metadados que correspondem ao valor especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
value | String | O valor para correspondência ao pesquisar metadados. |
Retornar
DeveloperMetadataFinder
: o localizador de metadados do desenvolvedor para encadeamento.
withVisibility(visibility)
Limita essa pesquisa a considerar apenas os metadados que correspondem à visibilidade especificada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
visibility | DeveloperMetadataVisibility | A visibilidade para correspondência ao pesquisar metadados. |
Retornar
DeveloperMetadataFinder
: o localizador de metadados do desenvolvedor para encadeamento.