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

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

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

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

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

ObjectOptions.FreshnessOptions

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

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

string

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

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

boolean

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

boolean

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

boolean

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

boolean

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

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

IntegerPropertyOptions.OrderedRanking

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

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

IntegerPropertyOptions.IntegerOperatorOptions

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

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

string

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

string

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

string

השם של האופרטור הנדרש בשאילתה כדי לבודד את מאפיין המספר השלם באמצעות אופרטור גדול מ-. לדוגמה, אם שם האופרטור greaterThanOperatorName הוא priorityabove ושם הנכס הוא priorityVal, שאילתות כמו priorityabove:<value> מציגות תוצאות רק כאשר הערך של הנכס בשם priorityVal גדול מ-<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 הוא closedon ושם המאפיין הוא closeDate, שאילתות כמו closedon:<value> מציגות תוצאות רק אם הערך של המאפיין שנקרא closeDate תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> בלי אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של כל מאפיין מחרוזת או טקסט בשדה התוכן של הפריט. שם המפעיל יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
lessThanOperatorName

string

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

string

השם של האופרטור הנדרש בשאילתה כדי לבודד את מאפיין חותמת הזמן באמצעות אופרטור גדול מ-. לדוגמה, אם שם האופרטור greaterThanOperatorName הוא closedafter ושם המאפיין הוא 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 הוא closed ושם המאפיין הוא isClosed, שאילתות כמו closed:<value> מציגות תוצאות רק כאשר הערך של המאפיין שנקרא isClosed תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> בלי אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של כל מאפיין מחרוזת או טקסט בשדה התוכן של הפריט. שם המפעיל יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

ObjectPropertyOptions

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

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

object (PropertyDefinition)

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

EnumPropertyOptions

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

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

object (EnumPropertyOptions.EnumValuePair)

רשימת הערכים האפשריים של מאפיין המניין. כל EnumValuePairs חייב לספק ערך מחרוזת. אם מציינים ערך שלם לאחד מ-EnumValuePair, כל הערכים האפשריים של EnumValuePairs חייבים לספק ערך שלם. גם ערך המחרוזת וגם ערך המספר השלם חייבים להיות ייחודיים מבין כל הערכים האפשריים. אחרי שמגדירים את הערכים האפשריים, אי אפשר להסיר או לשנות אותם. אם אתם מספקים דירוג מסודר ואתם חושבים שאולי תוסיפו ערכים נוספים של 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 כדי להגדיר את הדירוג של ערך נתון ביחס לערכים אחרים במניין של אותו שם נכס. במקרה הזה, סדר הדירוג DESCENDING למאפיינים של priority גורם לשיפור הדירוג של פריטים שנוספו לאינדקס עם הערך 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 מאפשרים למשתמשים להגביל את השאילתה לשדות ספציפיים שרלוונטיים לסוג הפריט שרוצים לחפש. לדוגמה, אם לא מציינים אופרטור למאפיין המניין priority עם הערכים האפשריים p0 ו-p1, שאילתה שמכילה את המונח p0 מחזירה פריטים שהערך שלהם במאפיין priority הוא p0, וגם פריטים שמכילים את המחרוזת p0 בשדות אחרים. אם תספקו שם אופרטור למערך הערכים, כמו priority, משתמשי החיפוש יוכלו להשתמש באופרטור הזה כדי לצמצם את התוצאות רק לפריטים שהערך שלהם במאפיין הזה הוא p0, באמצעות השאילתה priority:p0.

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

string

השם של המפעיל הנדרש בשאילתה כדי לבודד את מאפיין המניין המוגדר מראש. לדוגמה, אם operatorName הוא priority ושם המאפיין הוא priorityVal, שאילתות כמו priority:<value> מציגות תוצאות רק אם הערך של המאפיין בשם priorityVal תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> בלי אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של כל מאפיין מחרוזת או טקסט בשדה התוכן של הפריט. שם המפעיל יכול להכיל רק אותיות קטנות (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 שמציין אופרטור עם operatorName של closedon. בחיפושים בנתונים האלה, שאילתות כמו closedon:<value> מציגות תוצאות רק כאשר הערך של המאפיין closeDate תואם ל-<value>. לעומת זאת, חיפוש שמשתמש באותו <value> בלי אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של כל מאפיין מחרוזת או טקסט בשדה התוכן של מקור הנתונים שנוסף לאינדקס. שם המפעיל יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
lessThanOperatorName

string

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

string

השם של האופרטור הנדרש בשאילתה כדי לבודד את מאפיין התאריך באמצעות אופרטור גדול מ-. לדוגמה, אם שם האופרטור greaterThanOperatorName הוא closedafter ושם המאפיין הוא 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>. לעומת זאת, חיפוש שמשתמש באותו <value> בלי אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של מאפייני טקסט כלשהם או לטקסט בשדה התוכן של הפריט. שם המפעיל יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.
exactMatchWithOperator

boolean

אם הערך הוא True, ערך הטקסט יתחלק לאסימונים כערך אטומי אחד בחיפושים של אופרטורים ובהתאמות של פנים. לדוגמה, אם שם המפעיל הוא 'genre' והערך הוא 'science-fiction', הגבלות השאילתה 'genre:science' ו-'genre:fiction' לא תואמות לפריט, אבל 'genre:science-fiction' כן תואמת. ההתאמה של ערכי טקסט תלויה אותיות רישיות ולא מסירה תווים מיוחדים. אם הערך הוא false, הטקסט יתחלק לאסימונים. לדוגמה, אם הערך הוא 'מדע בדיוני', השאילתות 'genre:science' ו-'genre:fiction' תואמות לפריט.

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>. לעומת זאת, חיפוש שמשתמש באותו <value> בלי אופרטור מחזיר את כל הפריטים שבהם <value> תואם לערך של כל מאפיין HTML או טקסט בשדה התוכן של הפריט. שם המפעיל יכול להכיל רק אותיות קטנות (a-z). האורך המקסימלי הוא 32 תווים.

PropertyDisplayOptions

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

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

string

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