Method: spreadsheets.developerMetadata.search

Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
spreadsheetId

string

The ID of the spreadsheet to retrieve metadata from.

Request body

The request body contains data with the following structure:

JSON representation
{
  "dataFilters": [
    {
      object(DataFilter)
    }
  ],
}
Fields
dataFilters[]

object(DataFilter)

The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters will be included in the response.

Response body

If successful, the response body contains data with the following structure:

A reply to a developer metadata search request.

JSON representation
{
  "matchedDeveloperMetadata": [
    {
      object(MatchedDeveloperMetadata)
    }
  ],
}
Fields
matchedDeveloperMetadata[]

object(MatchedDeveloperMetadata)

The metadata matching the criteria of the search request.

Authorization

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

MatchedDeveloperMetadata

A developer metadata entry and the data filters specified in the original request that matched it.

JSON representation
{
  "developerMetadata": {
    object(DeveloperMetadata)
  },
  "dataFilters": [
    {
      object(DataFilter)
    }
  ],
}
Fields
developerMetadata

object(DeveloperMetadata)

The developer metadata matching the specified filters.

dataFilters[]

object(DataFilter)

All filters matching the returned developer metadata.

Send feedback about...