Method: spreadsheets.developerMetadata.search
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-03-22 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-03-22 UTC."],[],[],null,["# Method: spreadsheets.developerMetadata.search\n\n- [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\n### HTTP 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\n### Path parameters\n\n| Parameters ||\n|-----------------|---------------------------------------------------------------|\n| `spreadsheetId` | `string` The ID of the spreadsheet to retrieve metadata from. |\n\n### Request 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\n### Response body\n\nA 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\n### Authorization 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\n------------------------\n\nA 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. |"]]