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 data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response.
Response body
A reply to a developer metadata search request.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-21 UTC."],[],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchDeveloperMetadataResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [MatchedDeveloperMetadata](#MatchedDeveloperMetadata)\n - [JSON representation](#MatchedDeveloperMetadata.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReturns all developer metadata matching the specified [DataFilter](/workspace/sheets/api/reference/rest/v4/DataFilter). If the provided DataFilter represents a [DeveloperMetadataLookup](/workspace/sheets/api/reference/rest/v4/DataFilter#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.\n\nHTTP request\n\n`POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata:search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|-----------------|---------------------------------------------------------------|\n| `spreadsheetId` | `string` The ID of the spreadsheet to retrieve metadata from. |\n\nRequest body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------|\n| ``` { \"dataFilters\": [ { object (/workspace/sheets/api/reference/rest/v4/DataFilter) } ] } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dataFilters[]` | `object (`[DataFilter](/workspace/sheets/api/reference/rest/v4/DataFilter)`)` The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response. |\n\nResponse body A reply to a developer metadata search request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"matchedDeveloperMetadata\": [ { object (/workspace/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/search#MatchedDeveloperMetadata) } ] } ``` |\n\n| Fields ||\n|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matchedDeveloperMetadata[]` | `object (`[MatchedDeveloperMetadata](/workspace/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/search#MatchedDeveloperMetadata)`)` The metadata matching the criteria of the search request. |\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `https://www.googleapis.com/auth/drive.file`\n- `https://www.googleapis.com/auth/spreadsheets`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nMatchedDeveloperMetadata A developer metadata entry and the data filters specified in the original request that matched it.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"developerMetadata\": { object (/workspace/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#DeveloperMetadata) }, \"dataFilters\": [ { object (/workspace/sheets/api/reference/rest/v4/DataFilter) } ] } ``` |\n\n| Fields ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `developerMetadata` | `object (`[DeveloperMetadata](/workspace/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#DeveloperMetadata)`)` The developer metadata matching the specified filters. |\n| `dataFilters[]` | `object (`[DataFilter](/workspace/sheets/api/reference/rest/v4/DataFilter)`)` All filters matching the returned developer metadata. |"]]
