מחזירה את כל המטא-נתונים של המפתח שתואמים לערך DataFilter
שצוין. אם ה-DataFilter שסופק מייצג אובייקט DeveloperMetadataLookup
, הפעולה הזו תחזיר את כל רשומות ה-DeveloperMetadata שנבחרו על ידיו. אם ה-DataFilter מייצג מיקום בגיליון אלקטרוני, יוצגו כל המטא-נתונים של המפתח שמשויכים למיקומים שחוצים את אותו אזור.
בקשת HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata:search
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
spreadsheetId |
המזהה של הגיליון האלקטרוני שממנו יש לאחזר את המטא-נתונים. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"dataFilters": [
{
object ( |
שדות | |
---|---|
dataFilters[] |
מסנני הנתונים שמתארים את הקריטריונים שלפיהם נקבע אילו רשומות של DeveloperMetadata יש להחזיר. התשובה כוללת מטא-נתונים שתואמים לאחד מהמסננים שצוינו. |
גוף התשובה
תשובה לבקשה לחיפוש מטא נתונים של מפתח.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"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[] |
כל המסננים שתואמים למטא-נתונים של המפתח שהוחזרו. |