DataFilter

מסנן שמתאר אילו נתונים צריך לבחור או להחזיר מבקשה.

ייצוג JSON
{

  // Union field filter can be only one of the following:
  "developerMetadataLookup": {
    object (DeveloperMetadataLookup)
  },
  "a1Range": string,
  "gridRange": {
    object (GridRange)
  }
  // End of list of possible types for union field filter.
}
שדות
שדה איחוד filter. סוגי המסננים שעשויים להגביל את הנתונים שנבחרו. filter יכול להיות רק אחד מהבאים:
developerMetadataLookup

object (DeveloperMetadataLookup)

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

a1Range

string

בחירת נתונים שתואמים לטווח A1 שצוין.

gridRange

object (GridRange)

בחירת נתונים שתואמים לטווח שמתואר על ידי GridRange.

DeveloperMetadataLookup

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

ייצוג JSON
{
  "locationType": enum (DeveloperMetadataLocationType),
  "metadataLocation": {
    object (DeveloperMetadataLocation)
  },
  "locationMatchingStrategy": enum (DeveloperMetadataLocationMatchingStrategy),
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "visibility": enum (DeveloperMetadataVisibility)
}
שדות
locationType

enum (DeveloperMetadataLocationType)

מגביל את המטא-נתונים של המפתח שנבחרו לרשומות המשויכות למיקומים מהסוג שצוין. לדוגמה, כשהשדה הזה מזוהה בתור ROW, החיפוש הזה מתייחס רק למטא-נתונים של מפתחים שמשויכים לשורות. אם לא מגדירים את השדה, כל סוגי המיקומים נלקחים בחשבון. לא ניתן לציין את השדה הזה בתור SPREADSHEET כאשר ה-locationMatchingStrategy מצוין כ-INTERSECTING או כאשר ה-metadataLocation מצוין כמיקום שאינו גיליון אלקטרוני: מטא-נתונים של גיליון אלקטרוני לא יכולים להצטלב למיקום אחר של מטא-נתונים של המפתח. יש להשאיר את השדה הזה לא מוגדר גם אם locationMatchingStrategy מוגדר כמדויק.

metadataLocation

object (DeveloperMetadataLocation)

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

locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

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

metadataId

integer

מגבילה את המטא-נתונים של המפתח שנבחרו כך שיתאימו ל-DeveloperMetadata.metadata_id.

metadataKey

string

מגבילה את המטא-נתונים של המפתח שנבחרו כך שיתאימו ל-DeveloperMetadata.metadata_key.

metadataValue

string

מגבילה את המטא-נתונים של המפתח שנבחרו כך שיתאימו ל-DeveloperMetadata.metadata_value.

visibility

enum (DeveloperMetadataVisibility)

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

אסטרטגיה למטא-נתונים של מיקוםהתאמה

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

Enums
DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בערך הזה.
EXACT_LOCATION מציין התאמה מדויקת של מיקום ספציפי. לדוגמה, אם שורה מספר 3 צוינה כמיקום, שיטת ההתאמה הזו תתאים רק למטא-נתונים של מפתחים שמשויכים גם לשורה 3. המטא-נתונים שמשויכים למיקומים אחרים לא יובאו בחשבון.
INTERSECTING_LOCATION מציין שהמיקום שצוין צריך להתאים למיקום המדויק הזה, וכן לכל המיקומים שמצטלבים. לדוגמה, אם שורה שלישית מצוינת כמיקום, שיטת ההתאמה הזו תתאים למטא-נתונים של המפתח המשויכים לשורה השלישית, וכן למטא-נתונים המשויכים למיקומים שחוצים את שורה שלישית. אם, למשל, שויכו מטא-נתונים של מפתח לעמודה ב', אסטרטגיית ההתאמה הזו תתאים גם למיקום הזה, כי עמודה ב' חוצה את שורה שלישית.