Method: spreadsheets.developerMetadata.search

הפונקציה מחזירה את כל המטא-נתונים של המפתחים שתואמים לDataFilter שצוין. מידע נוסף מפורט במאמר קריאה, כתיבה וחיפוש של מטא-נתונים.

אם האובייקט DataFilter מייצג אובייקט DeveloperMetadataLookup, הפונקציה מחזירה את כל רשומות DeveloperMetadata שנבחרו על ידו. אם DataFilter מייצג מיקום בגיליון אלקטרוני, הפונקציה תחזיר את כל המטא-נתונים של המפתחים שמשויכים למיקומים שחופפים לאזור הזה.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
spreadsheetId

string

המזהה של הגיליון האלקטרוני שממנו רוצים לאחזר מטא-נתונים.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
שדות
dataFilters[]

object (DataFilter)

מסנני הנתונים שמתארים את הקריטריונים שמשמשים לקביעה אילו רשומות DeveloperMetadata יוחזרו. התשובה כוללת את כל רכיבי DeveloperMetadata שתואמים למסננים שצוינו.

גוף התשובה

תשובה לבקשת חיפוש של מטא נתונים של מפתח.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "matchedDeveloperMetadata": [
    {
      object (MatchedDeveloperMetadata)
    }
  ]
}
שדות
matchedDeveloperMetadata[]

object (MatchedDeveloperMetadata)

הנתונים של המטא-נתונים שתואמים לקריטריונים של בקשת החיפוש.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין במדריך ההרשאות.

MatchedDeveloperMetadata

רשומה של מטא-נתונים של מפתח ומסנני הנתונים שצוינו בבקשה המקורית שתאמו לה.

ייצוג ב-JSON 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
שדות
developerMetadata

object (DeveloperMetadata)

המטא-נתונים של המפתח שתואמים למסננים שצוינו.
dataFilters[]

object (DataFilter)

כל המסננים שתואמים למטא-נתונים של המפתחים שמוחזרים.