Method: spreadsheets.developerMetadata.search

Retorna todos os metadados do desenvolvedor correspondentes ao DataFilter especificado. Se o DataFilter fornecido representar um objeto DeveloperMetadataLookup, todas as entradas DeveloperMetadata selecionadas por ele serão retornadas. Se o DataFilter representar um local em uma planilha, serão retornados todos os metadados do desenvolvedor associados aos locais que cruzam essa região.

Solicitação HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata:search

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
spreadsheetId

string

O ID da planilha da qual os metadados devem ser recuperados.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
Campos
dataFilters[]

object (DataFilter)

Os filtros de dados que descrevem os critérios usados para determinar quais entradas do DeveloperMetadata serão retornadas. Os metadados do desenvolvedor correspondentes a qualquer um dos filtros especificados são incluídos na resposta.

Corpo da resposta

Uma resposta a uma solicitação de pesquisa de metadados do desenvolvedor.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "matchedDeveloperMetadata": [
    {
      object (MatchedDeveloperMetadata)
    }
  ]
}
Campos
matchedDeveloperMetadata[]

object (MatchedDeveloperMetadata)

Os metadados que correspondem aos critérios da solicitação de pesquisa.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Para mais informações, consulte o Guia de autorização.

MatchedDeveloperMetadata

Uma entrada de metadados do desenvolvedor e os filtros de dados especificados na solicitação original correspondente.

Representação JSON 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
Campos
developerMetadata

object (DeveloperMetadata)

Os metadados do desenvolvedor correspondentes aos filtros especificados.
dataFilters[]

object (DataFilter)

Todos os filtros que correspondem aos metadados retornados do desenvolvedor.