Method: googleapis.sheets.v4.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.

Arguments

Parameters
spreadsheetId

string

Required. The ID of the spreadsheet to retrieve metadata from.
body

object (SearchDeveloperMetadataRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of SearchDeveloperMetadataResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- search:
    call: googleapis.sheets.v4.spreadsheets.developerMetadata.search
    args:
        spreadsheetId: ...
        body:
            dataFilters: ...
    result: searchResult

JSON

[
  {
    "search": {
      "call": "googleapis.sheets.v4.spreadsheets.developerMetadata.search",
      "args": {
        "spreadsheetId": "...",
        "body": {
          "dataFilters": "..."
        }
      },
      "result": "searchResult"
    }
  }
]