Schema

הגדרת הסכימה עבור מקור נתונים.

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

object (ObjectDefinition)

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

operationIds[]

string

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

הגדרת אובייקט

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

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

string

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

options

object (ObjectOptions)

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

propertyDefinitions[]

object (PropertyDefinition)

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

אפשרויות Object

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

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

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

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

Objectאפשרויות.אפשרויות רענון

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

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

string

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

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

freshnessDuration

string (Duration format)

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

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

אפשרויות ObjectView

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

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

string

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

metalines[]

object (ObjectDisplayOptions.Metaline)

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

ObjectDisplayOption.Metline

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

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

object (ObjectDisplayOptions.DisplayedProperty)

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

ObjectDisplay options.נכס מוצג

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

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

string

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

הגדרת נכס

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

ייצוג 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

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

isRepeatable

boolean

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

isSortable

boolean

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

isFacetable

boolean

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

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

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

ייצוג 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.

מספר שלם של אפשרויות

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

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

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

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

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

string

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

העדפות של נכס כפול

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

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

object (DoublePropertyOptions.DoubleOperatorOptions)

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

DoublePropertyOption.אפשרויות כפילות

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

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

string

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

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

האפשרויות של נכסי חותמת זמן.

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

object (TimestampPropertyOptions.TimestampOperatorOptions)

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

אפשרויות חותמת זמן

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

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

string

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

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

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

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

object (BooleanPropertyOptions.BooleanOperatorOptions)

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

ערך בוליאני

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

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

string

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

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

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

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

object (PropertyDefinition)

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

אפשרויות טיפוס (num)

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

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

object (EnumPropertyOptions.EnumValuePair)

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

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

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

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

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

EnumPropertyOption.EnumValuePair

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

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

string

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

integerValue

integer

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

דירוג EnumProperty options.סידור לפי סדר

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

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

EnumPropertyOption.EnumOperatorOption

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

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

string

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

אפשרויות המאפיין של התאריך

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

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

object (DatePropertyOptions.DateOperatorOptions)

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

DatePropertyOption.DateOperaatorOption

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

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

string

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

אפשרויות של מאפיין טקסט

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

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

object (RetrievalImportance)

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

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

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

ייבוא חשוב

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

enum (RetrievalImportance.Importance)

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

RetrievalImportance.Importance

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

אפשרויות של נכס טקסט.TextOperatorOption

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

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

string

מציין את שם האופרטור הנדרש בשאילתה כדי לבודד את מאפיין הטקסט. לדוגמה, אם המפעילName הוא 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, הטקסט מתועד. לדוגמה, אם הערך הוא "science-fiction", השאילתות "genre:science" ו-"genre:fiction" יתאימו לפריט.

אפשרויות נכס HTML

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

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

object (RetrievalImportance)

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

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

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

HtmlPropertyOption.HtmlOperatorOption

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

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

string

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

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

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

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

string

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