Method: spreadsheets.developerMetadata.search

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
spreadsheetId

string

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

גוף הבקשה

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

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

object (DataFilter)

מסנני הנתונים שמתארים את הקריטריונים שלפיהם נקבע אילו רשומות 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)

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