Method: spreadsheets.developerMetadata.search

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

בקשת HTTP

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

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

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

פרמטרים
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)

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