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 עם המזהה הייחודי הזה. אם צוין מפתח מטא-נתונים, המערכת תביא בחשבון את כל המטא-נתונים של המפתח שיש להם את המפתח הזה. אם ציינתם מפתח, הרשאות גישה וסוג מיקום, המערכת מביאה בחשבון את כל המטא-נתונים של המפתח עם המפתח הזה ועם סטטוס החשיפה הזה שמשויכים למיקום מהסוג הזה. באופן כללי, הפעולה הזו בוחרת את כל ה-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 מוגדר כ-EXACT.

metadataLocation

object (DeveloperMetadataLocation)

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

locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

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

metadataId

integer

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

metadataKey

string

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

metadataValue

string

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

visibility

enum (DeveloperMetadataVisibility)

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

DeveloperMetadataLocationMatchingStrategy

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

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