הפונקציה מחזירה את כל המטא-נתונים של המפתחים שתואמים ל-DataFilter שצוין. אם אובייקט DataFilter שסופק מייצג אובייקט DeveloperMetadataLookup, הפונקציה תחזיר את כל הרשומות של DeveloperMetadata שנבחרו על ידו. אם DataFilter מייצג מיקום בגיליון אלקטרוני, הפונקציה תחזיר את כל המטא-נתונים של המפתחים שמשויכים למיקומים שמצטלבים עם האזור הזה.
בקשת HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata:search
מסנני הנתונים שמתארים את הקריטריונים שבהם נעשה שימוש כדי לקבוע אילו רשומות של DeveloperMetadata יוחזר. התשובה תכלול את כל הפריטים של DeveloperMetadata שתואמים לאחד מהמסננים שצוינו.
גוף התשובה
תשובה לבקשה לחיפוש מטא-נתונים של מפתח.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 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. |"]]