REST Resource: settings.searchapplications

משאב: SearchApplication

SearchApplication

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
שדות
name

string

השם של אפליקציית החיפוש.

פורמט: searchapplications/{applicationId}.
displayName

string

השם המוצג של אפליקציית החיפוש. האורך המקסימלי הוא 300 תווים.
dataSourceRestrictions[]

object (DataSourceRestriction)

הגבלות שחלות על ההגדרות. המספר המקסימלי של רכיבים הוא 10.
sourceConfig[]

object (SourceConfig)

הגדרה של מקורות שצוינו ב-dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

הגדרה של דירוג תוצאות.
defaultSortOptions

object (SortOptions)

אפשרויות ברירת המחדל למיון תוצאות החיפוש
defaultFacetOptions[]

object (FacetOptions)

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

boolean

לכל תוצאה צריך להחזיר את מזהה ה-URI של התמונה הממוזערת שלה (אם רלוונטי)
operationIds[]

string

פלט בלבד. המזהים של הפעולות הארוכות (LROs) שפועלות כרגע בסכימה הזו. שדה פלט בלבד.
enableAuditLog

boolean

מציין אם רישום ביומן הביקורת מופעל או מושבת לבקשות שנשלחות לאפליקציית החיפוש ב-API של השאילתות.
queryInterpretationConfig

object (QueryInterpretationConfig)

אפשרויות ברירת המחדל לניתוח שאילתות

DataSourceRestriction

הגבלה על מקור הנתונים.

ייצוג ב-JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
שדות
source

object (Source)

מקור ההגבלה.
filterOptions[]

object (FilterOptions)

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

המספר המקסימלי של רכיבים הוא 20.

הערה: בשלב הזה, Suggest API תומך רק במספר מסננים: 'objecttype',‏ 'type' ו-'mimetype'. בשלב הזה אי אפשר להשתמש במסננים ספציפיים לסכימה כדי לסנן הצעות.

מקור

הגדרת מקורות לממשקי ה-API של ההצעות או החיפוש.

ייצוג ב-JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
שדות

שדה האיחוד source.

הערך של source יכול להיות רק אחת מהאפשרויות הבאות:
name

string

שם המקור של תוכן שנוסף לאינדקס על ידי Indexing API.
predefinedSource

enum (Source.PredefinedSource)

מקור תוכן מוגדר מראש ל-Google Apps.

Source.PredefinedSource

מקורות מוגדרים מראש:

טיפוסים בני מנייה (enum)
NONE
QUERY_HISTORY הצעות לשאילתות שהמשתמש הקליד בעבר. תקף רק כשמשתמשים בו עם Suggest API. המערכת מתעלמת מהם כשמשתמשים בהם ב-API של השאילתות.
PERSON הצעות לאנשים בארגון. תקף רק כשמשתמשים בו עם Suggest API. השימוש בהן ב-Query API גורם לשגיאה.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

אפשרויות סינון שיחולו על השאילתה.

ייצוג ב-JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
שדות
objectType

string

אם מגדירים את objectType, רק אובייקטים מהסוג הזה יחזרו. השם הזה צריך להתאים לשם האובייקט שרשום בהגדרה של הסכימה. האורך המקסימלי הוא 256 תווים.
filter

object (Filter)

פילטר כללי כדי להגביל את החיפוש, כמו lang:en, ‏ site:xyz.

סינון

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

1. הגדרת ValueFilter. השם חייב להתאים לשם operatorName שמוגדר בסכימה של מקור הנתונים.

2. הגדרת CompositeFilter. המערכת מבצעת הערכה של המסננים באמצעות האופרטור הלוגי. אופרטורים ברמה העליונה יכולים להיות רק AND או NOT. תנאי AND יכול להופיע רק ברמה העליונה. ביטוי OR יכול להופיע רק מתחת לביטוי AND ברמה העליונה.

ייצוג ב-JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
שדות

שדה האיחוד filter.

הערך של filter יכול להיות רק אחת מהאפשרויות הבאות:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

ייצוג ב-JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
שדות
operatorName

string

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

  1. operatorName, שבה השאילתה מסננת את התוצאות לפי הנכס שתואמת לערך.

  2. greaterThanOperatorName או lessThanOperatorName בסכימה. השאילתה מסננת את התוצאות לפי ערכי המאפיינים שגדולים או קטנים מהערך שצוין בשאילתה.
value

object (Value)

הערך שאליו יש להשוות.

ערך

הגדרה של ערך יחיד עם טיפוס כללי.

ייצוג ב-JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
שדות
שדה האיחוד value. הערך של המאפיין בעל השם. הערך של value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

ייצוג ב-JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
שדות
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

האופרטור הלוגי של מסנן המשנה.
subFilters[]

object (Filter)

מסננים משניים.

Filter.CompositeFilter.LogicOperator

טיפוסים בני מנייה (enum)
AND אופרטורים לוגיים, שאפשר להחיל רק על מסנני משנה.
OR
NOT אפשר להחיל את NOT רק על מסנן משנה אחד.

SourceConfig

הגדרות של מקור במהלך עיבוד בקשה מסוג query.search או query.suggest.

ייצוג ב-JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
שדות
source

object (Source)

המקור שבו ההגדרה הזו תהיה רלוונטית.
scoringConfig

object (SourceScoringConfig)

הגדרת הניקוד של המקור.
crowdingConfig

object (SourceCrowdingConfig)

הגדרת הצפיפות של המקור.

SourceScoringConfig

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

ייצוג ב-JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
שדות
sourceImportance

enum (SourceScoringConfig.SourceImportance)

חשיבות המקור.

SourceScoringConfig.SourceImportance

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

טיפוסים בני מנייה (enum)
DEFAULT
LOW
HIGH

SourceCrowdingConfig

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

ייצוג ב-JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
שדות
numResults

integer

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

integer

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

ScoringConfig

הגדרות ניקוד למקור במהלך עיבוד בקשה מסוג query.search או query.suggest.

ייצוג ב-JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
שדות
disableFreshness

boolean

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

boolean

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

SortOptions

ייצוג ב-JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
שדות
operatorName

string

שם האופרטור שתואם לשדה שבו רוצים למיין. צריך לסמן את המאפיין התואם כ-sortable.
sortOrder

enum (SortOptions.SortOrder)

סדר המיון שמוגדר כברירת מחדל הוא עולה

SortOptions.SortOrder

טיפוסים בני מנייה (enum)
ASCENDING
DESCENDING

FacetOptions

מציין את האופרטורים שעבורם רוצים לקבל תוצאות של מאפיינים. יהיה FacetResult אחד לכל שילוב של sourceName/objectType/operatorName.

ייצוג ב-JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
שדות
sourceName

string

שם המקור ליצירת פנים. פורמט: datasources/{sourceId}. אם השדה ריק, המערכת תשתמש בכל מקורות הנתונים.
objectType

string

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

string

השם של האופרטור שנבחר ליצירת פנים. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

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

object (IntegerFacetingOptions)

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

IntegerFacetingOptions

משמש לציון אפשרויות של פיצ'רים של משנה שלמים.

ייצוג ב-JSON 
{
  "integerBuckets": [
    string
  ]
}
שדות
integerBuckets[]

string (Int64Value format)

הקטגוריות של ערכים שלמים נתונים צריכות להיות בסדר עולה בלבד. לדוגמה, אם הערכים שסופקו הם (1,‏ 5,‏ 10,‏ 100), הקטגוריות הבאות של היבטים ייוצרו: {<1,‏ [1,‏ 5),‏ [5-10),‏ [10-100),‏ >=100}.

QueryInterpretationConfig

אפשרויות ברירת מחדל לניתוח שאילתות של משתמשים.

ייצוג ב-JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
שדות
forceVerbatimMode

boolean

מפעילים את הדגל הזה כדי להשבית את כל האופטימיזציות הפנימיות, כמו פרשנות של שאילתות בשפה טבעית (NL), אחזור של תוצאות משלימות ושימוש במילים נרדפות, כולל מילים נרדפות בהתאמה אישית. אם הדגל הזה מוגדר כ-True, הוא יקבל עדיפות על פני האפשרות שמוגדרת ברמת השאילתה. אם הערך שמוגדר כברירת מחדל הוא False, הדגל ברמת השאילתה יגדיר את הפרשנות הנכונה למצב verbatim.
forceDisableSupplementalResults

boolean

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

Methods

create

 יצירת אפליקציית חיפוש.

delete

 מחיקה של אפליקציית חיפוש.

get

 הפונקציה מקבלת את אפליקציית החיפוש שצוינה.

list

 רשימה של כל אפליקציות החיפוש.

patch

 עדכון של אפליקציית חיפוש.

reset

 איפוס של אפליקציית חיפוש להגדרות ברירת המחדל.

update

 עדכון של אפליקציית חיפוש.