Schema

הגדרת הסכימה של מקור נתונים.

ייצוג JSON 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
שדות
objectDefinitions[]

object (ObjectDefinition)

רשימת האובייקטים ברמה העליונה של מקור הנתונים. אפשר לכלול עד 10 רכיבים.
operationIds[]

string

המזהים של פעולות הריצה הממושכות (LROs) שפועלות כרגע בסכימה הזו. לאחר שינוי הסכימה, צריך להמתין להשלמת הפעולות לפני שמוסיפים תוכן נוסף לאינדקס.

ObjectDefinition

ההגדרה של אובייקט במקור נתונים.

ייצוג JSON 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
שדות
name

string

שם האובייקט, שמגדיר את הסוג שלו. בקשות להוספת פריטים לאינדקס צריכות להגדיר את השדה objectType לערך הזה. לדוגמה, אם name הוא Document, אז בקשות להוספה לאינדקס של פריטים מסוג 'מסמך' צריכות להיות מוגדרת objectType השווה ל-Document. לכל הגדרה של אובייקט צריך להיות שם ייחודי בתוך סכימה. השם חייב להתחיל באות והוא יכול להכיל רק אותיות (A-Z, a-z) או מספרים (0-9). האורך המקסימלי הוא 256 תווים.
options

object (ObjectOptions)

האפשרויות האופציונליות שספציפיות לאובייקט.
propertyDefinitions[]

object (PropertyDefinition)

הגדרות המאפיינים של האובייקט. מספר הרכיבים המקסימלי הוא 1,000.

ObjectOptions

האפשרויות של אובייקט.

ייצוג JSON 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
שדות
freshnessOptions

object (ObjectOptions.FreshnessOptions)

אפשרויות הרענון של אובייקט.
displayOptions

object (ObjectDisplayOptions)

האפשרויות שקובעות איך האובייקט יוצג בדף התוצאות ב-Cloud Search.
suggestionFilteringOperators[]

string

אופרטורים שיכולים לשמש לסינון הצעות. ב-API של query.suggest, רק האופרטורים שצוינו כאן יכובדו בFilterOptions. יש תמיכה רק באופרטורים TEXT ו-ENUM.

הערה: "objecttype", "type" ו-mimetype כבר נתמכים. המאפיין הזה נועד להגדיר אופרטורים ספציפיים לסכימה.

למרות שזהו מערך, ניתן לציין רק אופרטור אחד. זהו מערך להרחבה עתידית.

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

ObjectOptions.FreshnessOptions

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

ייצוג JSON 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
שדות
freshnessProperty

string

המאפיין הזה מציין את רמת העדכניות של האובייקט באינדקס. אם המאפיין מוגדר, המאפיין חייב להיות נכס ברמה העליונה בתוך property definitions והוא חייב להיות timestamp type או date type. אחרת, ה-API של ההוספה לאינדקס משתמש ב-updateTime כאינדיקטור של עדכניות. האורך המקסימלי הוא 256 תווים.

כשנכס משמש לחישוב עדכניות, ערך ברירת המחדל הוא שנתיים מהזמן הנוכחי.
freshnessDuration

string (Duration format)

משך הזמן שאחריו יש להתייחס לאובייקט ללא פעילות. ערך ברירת המחדל הוא 180 ימים (בשניות).

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".

ObjectDisplayOptions

אפשרויות התצוגה של אובייקט.

ייצוג JSON 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
שדות
objectDisplayLabel

string

תווית ידידותית למשתמש שתוצג בתוצאת החיפוש כדי לציין את סוג הפריט. השדה הזה הוא אופציונלי. אם המאפיין לא סופק, תווית האובייקט לא תוצג בשורת ההקשר של תוצאות החיפוש. האורך המקסימלי הוא 64 תווים.
metalines[]

object (ObjectDisplayOptions.Metaline)

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

ObjectDisplayOptions.Metaline

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

ייצוג JSON 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
שדות
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

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

ObjectDisplayOptions.DisplayedProperty

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

ייצוג JSON 
{
  "propertyName": string
}
שדות
propertyName

string

שם המאפיין ברמה העליונה כפי שמוגדר בהגדרת הנכס של האובייקט. אם השם אינו מאפיין מוגדר בסכימה, תתקבל שגיאה כשמנסים לעדכן את הסכימה.

PropertyDefinition

ההגדרה של מאפיין בתוך אובייקט.

ייצוג JSON 
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
שדות
name

string

שם הנכס. בבקשות להוספת פריטים לאינדקס שנשלחות ל-API של הוספה לאינדקס, הערך של property name צריך להיות שווה לערך הזה. לדוגמה, אם השם הוא subject_line, בקשות להוספה לאינדקס של פריטי מסמך עם שדות נושא צריכות להגדיר את הערך name של השדה הזה ל-subject_line. שימוש בשם בתור המזהה של מאפיין האובייקט. לאחר הרישום כמאפיין של אובייקט, לא תוכלו להשתמש שוב בשם הזה עבור נכס אחר בתוך האובייקט הזה. השם חייב להתחיל באות והוא יכול להכיל רק אותיות (A-Z, a-z) או מספרים (0-9). האורך המקסימלי הוא 256 תווים.
isReturnable

boolean

מציין שהנכס מזהה נתונים שצריך להחזיר בתוצאות החיפוש דרך Query API. אם הערך שמוגדר הוא true, המשמעות היא שמשתמשי Query API יכולים להשתמש בשדות מאפיינים תואמים בתוצאות. עם זאת, אחסון שדות דורש הקצאת מקום גדול יותר ושימוש ברוחב פס גדול יותר לשאילתות חיפוש. מצב כזה משפיע על הביצועים במערכי נתונים גדולים. צריך להגדיר כאן את הערך true רק אם השדה נדרש לתוצאות חיפוש. הערך לא יכול להיות True למאפיינים שהסוג שלהם הוא אובייקט.
isRepeatable

boolean

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

boolean

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

boolean

מציין שניתן להשתמש בנכס ליצירת מאפיינים. הערך לא יכול להיות True למאפיינים שהסוג שלהם הוא אובייקט. כדי להגדיר את האפשרות הזו, הערך של IsReturnable צריך להיות True. נתמך רק במאפיינים בוליאניים, enum, מספר שלם וטקסט.
isSuggestable

boolean

מציין שהנכס יכול לשמש ליצירת הצעות לשאילתות.
isWildcardSearchable

boolean

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

object (PropertyDisplayOptions)

האפשרויות שקובעות איך המאפיין יוצג בדף התוצאות של Cloud Search אם הוא מוגדר להצגה ב-display options של האובייקט.
שדה איחוד property_options. האפשרויות הספציפיות לסוג שקובעות את אופן ההוספה של הנכס לאינדקס ואת אופן השימוש בו. במקרה שבו האפשרויות צריכות להיות אפשרויות ברירת המחדל של סוג מסוים, השדה הזה עדיין צריך להיות מוגדר לאחד מהסוגים. אם לא מגדירים את השדה הזה, עדכוני הסכימה נדחים. property_options יכול להיות רק אחת מהאפשרויות הבאות:
integerPropertyOptions

object (IntegerPropertyOptions)
doublePropertyOptions

object (DoublePropertyOptions)
timestampPropertyOptions

object (TimestampPropertyOptions)
booleanPropertyOptions

object (BooleanPropertyOptions)
objectPropertyOptions

object (ObjectPropertyOptions)
enumPropertyOptions

object (EnumPropertyOptions)
datePropertyOptions

object (DatePropertyOptions)
textPropertyOptions

object (TextPropertyOptions)
htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

האפשרויות למאפיינים של מספרים שלמים.

ייצוג JSON 
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
שדות
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

משמשת לציון הדירוג הסדור של המספר השלם. אפשר להשתמש רק אם הערך של isRepeatable הוא False.
minimumValue

string (Int64Value format)

הערך המינימלי של הנכס. ערכי המינימום והמקסימום של הנכס משמשים לדירוג התוצאות בהתאם לordered ranking. בקשות להוספה לאינדקס עם ערכים נמוכים מהמינימום יתקבלו ומדורגות לפי משקל כמו של פריטים שנוספו לאינדקס עם הערך המינימלי.
maximumValue

string (Int64Value format)

הערך המקסימלי של הנכס. ערכי המינימום והמקסימום של הנכס משמשים לדירוג התוצאות בהתאם לordered ranking. בקשות להוספה לאינדקס עם ערכים שגבוהים מהמקסימום יתקבלו ומדורגות לפי אותו משקל של פריטים שנוספו לאינדקס עם הערך המקסימלי.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

אם מוגדר, מתאר איך להשתמש במספר השלם כאופרטור חיפוש.
integerFacetingOptions

object (IntegerFacetingOptions)

אם מוגדר, מתאר אפשרויות פנייה למספרים שלמים למאפיין המספר השלם הנתון. מאפיין המספר השלם המתאים צריך להיות מסומן כ-Facetable.

IntegerPropertyOptions.OrderedRanking

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

טיפוסים בני מנייה (enum)
NO_ORDER אין סדר דירוג לנכס. התוצאות לא מותאמות לפי הערך של הנכס הזה.
ASCENDING הנכס הזה מדורג בסדר עולה. ערכים נמוכים יותר מצביעים על דירוג נמוך יותר.
DESCENDING הנכס הזה מדורג בסדר יורד. ערכים נמוכים יותר מציינים דירוג גבוה יותר.

IntegerPropertyOptions.IntegerOperatorOptions

משמש לשליחת אופרטור חיפוש למאפיינים של מספרים שלמים. לא חובה לעשות זאת. האופרטורים מסוג query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.

ייצוג JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
שדות
operatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין המספר השלם. לדוגמה, אם operatorName הוא Priority ושם המאפיין הוא PriorityityVal, שאילתות כמו עדיפות:<value> יציגו תוצאות רק כאשר הערך של המאפיין בשם PriorityityVal תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו &lt;value&gt; ללא אופרטור מחזיר את כל הפריטים שבהם &lt;value&gt; תואם לערך של מאפייני מחרוזת או טקסט כלשהם בשדה התוכן של הפריט. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
lessThanOperatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין המספר השלם באמצעות האופרטור 'פחות מ-'. לדוגמה, אם lowerThantorName הוא עדיפות below ושם המאפיין הוא PriorityityVal, שאילתות כמו PriorityityBelow:<value> יציגו תוצאות רק שבהן הערך של המאפיין בשם PriorityityVal קטן מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
greaterThanOperatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין המספר השלם באמצעות האופרטור 'גדול מ-'. לדוגמה, אם largerThanActiontorName הוא עדיפות above ושם המאפיין הוא PriorityityVal, שאילתות כמו favoriteity above:<value> יציגו תוצאות רק שבהן הערך של המאפיין שנקרא proxyVal גדול מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

DoublePropertyOptions

האפשרויות למאפיינים כפולים.

ייצוג JSON 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
שדות
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

אם מוגדר, מתאר איך יש להשתמש ב-double כאופרטור חיפוש.

DoublePropertyOptions.DoubleOperatorOptions

משמש למתן אופרטור חיפוש לנכסים כפולים. לא חובה לעשות זאת. האופרטורים מסוג query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.

ייצוג JSON 
{
  "operatorName": string
}
שדות
operatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי להשתמש במאפיין הכפול במיון או כמאפיין. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

TimestampPropertyOptions

אפשרויות למאפיינים של חותמת זמן.

ייצוג JSON 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
שדות
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

אם השדה מוגדר, הוא מתאר איך להשתמש בחותמת הזמן כאופרטור חיפוש.

TimestampPropertyOptions.TimestampOperatorOptions

משמש לציון אופרטור חיפוש של מאפיינים של חותמת זמן. לא חובה לעשות זאת. האופרטורים מסוג query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.

ייצוג JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
שדות
operatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את המאפיין של חותמת הזמן. לדוגמה, אם operatorName הוא Closeon ושם המאפיין הוא CloseDate, שאילתות כמו closedon:<value> יציגו תוצאות רק כאשר ערך הנכס בשם CloseDate תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו &lt;value&gt; ללא אופרטור מחזיר את כל הפריטים שבהם &lt;value&gt; תואם לערך של מאפייני מחרוזת או טקסט כלשהם בשדה התוכן של הפריט. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
lessThanOperatorName

string

זהו שם האופרטור שנדרש בשאילתה כדי לבודד את המאפיין של חותמת הזמן באמצעות האופרטור 'פחות מ-'. לדוגמה, אם lowerThanOperatorName הוא closedbefore ושם המאפיין הוא closedbefore, שאילתות כמו closedbefore מציגות תוצאות רק שבהן ערך המאפיין בשם closedbefore מוקדם מ-closedbefore. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
greaterThanOperatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את המאפיין timestamp באמצעות האופרטור 'גדול מ-'. לדוגמה, אם largerThanOperatorName הוא Closeafter ושם המאפיין הוא CloseDate, שאילתות כמו closedafter:<value> מציגות תוצאות רק כאשר ערך המאפיין בשם CloseDate מאוחר מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

BooleanPropertyOptions

האפשרויות לנכסים בוליאניים.

ייצוג JSON 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
שדות
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

אם מוגדר, מתאר כיצד יש להשתמש בערך הבוליאני כאופרטור חיפוש.

BooleanPropertyOptions.BooleanOperatorOptions

משמש לציון אופרטור חיפוש לנכסים בוליאניים. לא חובה לעשות זאת. האופרטורים מסוג query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.

ייצוג JSON 
{
  "operatorName": string
}
שדות
operatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את המאפיין הבוליאני. לדוגמה, אם operatorName הוא Close ושם הנכס הוא isClosed, שאילתות כמו closed:<value> יציגו תוצאות רק כאשר הערך של הנכס בשם isClosed תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו &lt;value&gt; ללא אופרטור מחזיר את כל הפריטים שבהם &lt;value&gt; תואם לערך של מאפייני מחרוזת או טקסט כלשהם בשדה התוכן של הפריט. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

ObjectPropertyOptions

האפשרויות למאפייני אובייקט.

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

object (PropertyDefinition)

המאפיינים של אובייקט המשנה. המאפיינים האלה מייצגים אובייקט מקונן. לדוגמה, אם המאפיין הזה מייצג כתובת למשלוח דואר, יכול להיות שהשמות של המאפיין subobjectProperties יהיו street, city ו-state. מספר הרכיבים המקסימלי הוא 1,000.

EnumPropertyOptions

האפשרויות למאפייני 'טיפוסים בני מנייה (enum)' מאפשרות להגדיר קבוצה מוגבלת של מחרוזות כדי להתאים לשאילתות של משתמשים, להגדיר דירוגים לערכי המחרוזת האלה ולהגדיר שם אופרטור שיותאם למחרוזות האלה, כדי שהמשתמשים יוכלו לצמצם את התוצאות רק לפריטים עם ערך ספציפי. לדוגמה, לפריטים במערכת למעקב אחר בקשות שיש להם מידע בעדיפות גבוהה, אפשר להגדיר את p0 כערך enum מותר ולקשר את הטיפוס הזה לשם האופרטור עדיפות, כדי שמשתמשי חיפוש יוכלו להוסיף לשאילתה שלהם את Priority:p0, כדי להגביל את קבוצת התוצאות רק לפריטים שנוספו לאינדקס עם הערך p0.

ייצוג JSON 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
שדות
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

רשימת הערכים האפשריים של מאפיין הספירה. כל צמדי EnumValuePairs חייבים לספק ערך מחרוזת. אם תציינו ערך של מספר שלם עבור EnumValuePair אחד, כל צמדי ה-EnumValuePair יוכלו לציין ערך של מספר שלם. גם ערך המחרוזת וגם ערך המספר השלם חייבים להיות ייחודיים בכל הערכים האפשריים. לאחר הגדרת הערכים האפשריים, לא ניתן להסיר או לשנות אותם. אם אתם מציינים דירוג לפי סדר מסוים ולדעתכם אתם יכולים להוסיף ערכי 'טיפוסים בני מנייה (enum)' נוספים בעתיד, השאירו פערים בערכי המספרים השלמים הראשוניים כדי לאפשר הוספת ערך בין ערכים שנרשמו קודם לכן. אפשר לכלול עד 100 רכיבים.
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

משמשת לציון הדירוג הסדור עבור המספור שקובע כיצד ערכי המספרים השלמים שצוינו ב-EnumValuePairs האפשריים ישמשו לדירוג התוצאות. אם צוין, צריך לציין ערכים של מספרים שלמים לכל ערכי EnumValuePair אפשריים בשביל המאפיין הזה. אפשר להשתמש רק אם הערך של isRepeatable הוא False.
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

אם מוגדר, מתאר איך יש להשתמש ב-enum כאופרטור חיפוש.

EnumPropertyOptions.EnumValuePair

צמד ערכי המספור מגדיר שני דברים: ערך מחרוזת נדרש וערך אופציונלי של מספר שלם. ערך המחרוזת מגדיר את מונח השאילתה הדרוש כדי לאחזר את הפריט הזה, לדוגמה p0 עבור פריט בעדיפות גבוהה. ערך המספר השלם קובע את הדירוג של ערך מחרוזת זה ביחס לערכים ממוספרים אחרים עבור אותו נכס. לדוגמה, אפשר לשייך את p0 עם 0 ולהגדיר צמד 'טיפוסים בני מנייה (enum)' נוסף כמו p1 ו-1. עליכם להשתמש בערך המספר השלם בשילוב עם ordered ranking כדי להגדיר את הדירוג של ערך נתון ביחס לערכים ממוספרים אחרים עבור אותו שם מאפיין. במקרה הזה, סדר הדירוג של DESC בשווי הנכסים בעדיפות מעלה את הדירוג של פריטים שנוספו לאינדקס עם הערך p0, בהשוואה לפריטים עם הערך p1 שנוספו לאינדקס. ללא סדר דירוג ספציפי, למספר השלם אין השפעה על דירוג הפריט.

ייצוג JSON 
{
  "stringValue": string,
  "integerValue": integer
}
שדות
stringValue

string

ערך המחרוזת של EnumValuePair. האורך המקסימלי הוא 32 תווים.
integerValue

integer

הערך השלם של EnumValuePair שחייב להיות לא שלילי. זה שינוי אופציונלי.

EnumPropertyOptions.OrderedRanking

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

טיפוסים בני מנייה (enum)
NO_ORDER אין סדר דירוג לנכס. התוצאות לא מותאמות לפי הערך של הנכס הזה.
ASCENDING הנכס הזה מדורג בסדר עולה. ערכים נמוכים יותר מצביעים על דירוג נמוך יותר.
DESCENDING הנכס הזה מדורג בסדר יורד. ערכים נמוכים יותר מציינים דירוג גבוה יותר.

EnumPropertyOptions.EnumOperatorOptions

משמש לחישוב אופרטור חיפוש של מאפייני enum. לא חובה לעשות זאת. האופרטורים מסוג query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש. לדוגמה, אם לא מציינים אופרטור למאפיין enum עדיפות עם ערכים אפשריים p0 ו-p1, שאילתה שמכילה את המונח p0 תחזיר פריטים שהערך שלהם הוא p0 במאפיין עדיפות, וכן פריטים שמכילים את המחרוזת p0 בשדות אחרים. אם מספקים שם של אופרטור ל-enum, למשל Priority, משתמשי חיפוש יכולים להשתמש באופרטור הזה כדי לצמצם את התוצאות רק לפריטים שערך המאפיין הזה הוא p0, עם השאילתה עדיפות:p0.

ייצוג JSON 
{
  "operatorName": string
}
שדות
operatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין ה-enum. לדוגמה, אם operatorName הוא Priority ושם המאפיין הוא PriorityityVal, שאילתות כמו עדיפות:<value> יציגו תוצאות רק כאשר הערך של המאפיין בשם PriorityityVal תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו &lt;value&gt; ללא אופרטור מחזיר את כל הפריטים שבהם &lt;value&gt; תואם לערך של מאפייני מחרוזת או טקסט כלשהם בשדה התוכן של הפריט. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

DatePropertyOptions

האפשרויות לנכסי תאריך.

ייצוג JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
שדות
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

אם השדה מוגדר, הוא מתאר את האופן שבו יש להשתמש בתאריך כאופרטור חיפוש.

DatePropertyOptions.DateOperatorOptions

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

ייצוג JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
שדות
operatorName

string

מציינת את המחרוזת בפועל שנדרשת בשאילתה כדי לבודד את נכס התאריך. לדוגמה, נניח שאובייקט של סכימת מעקב אחר בעיות כולל נכס בשם closeDate שמציין אופרטור עם conversionName של closeDate. בחיפושים על הנתונים האלה, שאילתות כמו closedon:&lt;value&gt; מציגות תוצאות רק שבהן הערך של המאפיין closedon:&lt;value&gt; תואם ל-closedon:&lt;value&gt;. לעומת זאת, חיפוש שמשתמש באותו &lt;value&gt; ללא אופרטור מחזיר את כל הפריטים שבהם &lt;value&gt; תואם לערך של מאפייני מחרוזת או טקסט כלשהם בשדה התוכן של מקור הנתונים שנוסף לאינדקס. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
lessThanOperatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין התאריך באמצעות האופרטור 'פחות מ-'. לדוגמה, אם lowerThanOperatorName הוא closedbefore ושם המאפיין הוא closedbefore, שאילתות כמו closedbefore מציגות תוצאות רק שבהן ערך המאפיין בשם closedbefore מוקדם מ-closedbefore. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
greaterThanOperatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין התאריך באמצעות האופרטור 'גדול מ-'. לדוגמה, אם largerThanOperatorName הוא Closeafter ושם המאפיין הוא CloseDate, שאילתות כמו closedafter:<value> מציגות תוצאות רק כאשר ערך המאפיין בשם CloseDate מאוחר מ-<value>. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

TextPropertyOptions

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

ייצוג JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
שדות
retrievalImportance

object (RetrievalImportance)

מציינת את חשיבות איכות החיפוש של האסימונים בשדה שמשמש לאחזור.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

אם מוגדר, מתאר איך להשתמש בנכס כאופרטור חיפוש.

RetrievalImportance

ייצוג JSON 
{
  "importance": enum (RetrievalImportance.Importance)
}
שדות
importance

enum (RetrievalImportance.Importance)

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

RetrievalImportance.Importance

טיפוסים בני מנייה (enum)
DEFAULT יש להתייחס להתאמה כמו בגוף הטקסט להתאמה.
HIGHEST יש להתייחס להתאמה כאל התאמה לשם הפריט.
HIGH יש להתייחס להתאמה שיש בה חשיבות גבוהה יותר מהטקסט בגוף ההודעה.
LOW התייחסו להתאמה שיש לה חשיבות נמוכה יותר מהטקסט בגוף.
NONE אל תבצעו התאמה לשדה הזה במהלך האחזור. הנכס עדיין יכול לשמש להתאמת אופרטורים, תיוג והצעה לפי הצורך.

TextPropertyOptions.TextOperatorOptions

משמש למתן אופרטור חיפוש למאפייני טקסט. לא חובה לעשות זאת. האופרטורים מסוג query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.

ייצוג JSON 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
שדות
operatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין הטקסט. לדוגמה, אם operatorName הוא subject ושם המאפיין הוא subjectLine, שאילתות כמו subject:<value> יציגו תוצאות רק שבהן הערך של המאפיין שנקרא subjectLine תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו &lt;value&gt; ללא אופרטור מחזיר את כל הפריטים שבהם &lt;value&gt; תואם לערך של מאפייני טקסט או טקסט כלשהם בשדה התוכן של הפריט. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
exactMatchWithOperator

boolean

אם True, ערך הטקסט עובר המרה לאסימונים בתור ערך אטומי אחד בחיפושים של אופרטורים ובהתאמות של מאפיינים. לדוגמה, אם שם האופרטור הוא 'genre' והערך הוא 'מדע בדיוני' הגבלות השאילתה "genre:science" ו-'genre:picture' לא תואם לפריט; 'genre:מדע בדיוני' מהפונקציות. ההתאמה של ערכי הטקסט היא תלוית אותיות רישיות ולא מסירה תווים מיוחדים. אם הערך הוא False, הטקסט יעבור המרה לאסימונים. לדוגמה, אם הערך הוא 'מדע בדיוני' השאילתות "genre:science" ו-'genre:picture' תואם לפריט.

HtmlPropertyOptions

האפשרויות למאפיינים של HTML.

ייצוג JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
שדות
retrievalImportance

object (RetrievalImportance)

מציינת את חשיבות איכות החיפוש של האסימונים בשדה שמשמש לאחזור. אפשר להגדיר רק את הערך DEFAULT או NONE.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

אם מוגדר, מתאר איך להשתמש בנכס כאופרטור חיפוש.

HtmlPropertyOptions.HtmlOperatorOptions

משמש למתן אופרטור חיפוש לנכסי HTML. לא חובה לעשות זאת. האופרטורים מסוג query.search מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים הרלוונטיים לסוג הפריט שבו מתבצע החיפוש.

ייצוג JSON 
{
  "operatorName": string
}
שדות
operatorName

string

מציין את שם האופרטור שנדרש בשאילתה כדי לבודד את מאפיין ה-HTML. לדוגמה, אם operatorName הוא subject ושם המאפיין הוא subjectLine, שאילתות כמו subject:<value> יציגו תוצאות רק שבהן הערך של המאפיין שנקרא subjectLine תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו &lt;value&gt; ללא אופרטור מחזיר את כל הפריטים שבהם &lt;value&gt; תואם לערך של מאפייני HTML או טקסט כלשהם בשדה התוכן של הפריט. שם האופרטור יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

PropertyDisplayOptions

אפשרויות התצוגה של נכס.

ייצוג JSON 
{
  "displayLabel": string
}
שדות
displayLabel

string

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